• metadata-template-editor
  • Running commands
  • Available commands
  • Ownership
  • Translations

metadata-template-editor

This library was generated with @box/automation. General overview on how to perform tasks on the generated library can be found in run-tasks Nx documentation.

Running commands

Your terminal should stay in location of root directory of repository, which is frontend-mono. That Allows Nx to run action against your project, or multiple project if that is necessary. Do not navigate to packages/group-shared-features/metadata-template-editor to run commands.

Commands for the project are run using syntax used by Nx:

Syntax: yarn nx <target name> <project name> <option overrides>
                      |              |                |
Example: yarn nx    test         products         --watch

Available commands

All commands used with Nx can be found in project.json file within your package.

• nx storybook metadata-template-editor - launches development environment for UI component.
• nx build-storybook metadata-template-editor - build static version of storybook with all stories.
• nx build metadata-template-editor - build package using shared-feature-builder executor from automation package.
• nx build metadata-template-editor --watch - build package with --watch flag enabled, which rebuilds dist content based on changes in src.
• nx lint metadata-template-editor - runs linter over package files.
• nx test metadata-template-editor - runs storybook tests (visual/interactions) and jest unit tests, producing coverage report at the end.
• nx test-storybook metadata-template-editor - runs storybook tests. You need first to start storybook in separate terminal for this to work.
• nx test-storybook-local-coverage metadata-template-editor - runs storybook tests, and produces coverage report at the end. Requires running instance of storybook.
• nx test-storybook-ci metadata-template-editor - build storybook and run storybook tests with coverage output. Designed for CI usage.
• nx test-jest metadata-template-editor - runs jest unit tests, producing code coverage at the end.
• nx sonar metadata-template-editor - performs static analysis of code using SonarQube tooling, to detect bugs and code smells. Integrated as one of the steps in CI process.
• nx chromatic metadata-template-editor - uploads storybook build for review to box chromatic , and performs visual comparison of the UI changes against baseline.
• nx prepare metadata-template-editor - command run during package publication process orchestrated by Nx Release.

Ownership

Code of the feature belongs to metadata-experience. Responsibilities of owning team include control over code quality, providing guidelines for changes, and alignment with other teams regarding changes. It would be a good practice to consult which team, owning or requesting, will be responsible for implementing changes to code.

Translations

Per-locale i18n/*.js files are generated and committed by the Moji Jenkins pipeline. The shared-feature builder copies them into dist/i18n/ during build. Consuming applications list this package in i18n.config.js under translationDependencies.