<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
npm install @box/metadata-editor- metadata-editor
- Running commands
- Available commands
- Ownership
- Translations
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.
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-editor to run commands.
Commands for the project are run using syntax used by Nx:
``
Syntax: yarn nx
All commands used with Nx can be found in project.json file within your package.
- nx storybook metadata-editor - launches development environment for UI component.nx build-storybook metadata-editor
- - build static version of storybook with all stories.nx build metadata-editor
- - build package using shared-feature-builder executor from automation package.nx build-locales metadata-editor
- - generate i18n/.js and i18n/.properties files out of i18n/json/*.json files to be imported by react-intl.nx lint metadata-editor
- - run linter over package files,nx test metadata-editor
- - runs storybook tests (visual/interactions) and jest unit tests, producing coverage report at the end.nx test-storybook metadata-editor
- - runs storybook tests. You need first to start storybook in separate terminal for this to work.nx test-storybook-local-coverage metadata-editor
- - runs storybook tests, and produces coverage report at the end. Requires running instance of storybook.nx test-storybook-ci metadata-editor
- - build storybook and run storybook tests with coverage output. Designed for CI usage.nx test-jest metadata-editor
- - runs jest unit tests, producing code coverage at the end.nx sonar metadata-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-editor
- - uploads storybook build for review to box chromatic , and performs visual comparison of the UI changes against baseline.nx prepare metadata-editor
- - command run during package publication process orchestrated by Nx Release.
Code of the feature belongs to product-adoption. 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.
For translations this package will be leveraging @box/frontend as it has the required scripts to do translations the Box way, for more information on this checkout their i18n docs [here].
The i18n/` dir is bundled with this package to enable the consuming app to use the translations included in this component it need to adjust it's [TranslationsPlugin],
see EUA's [webpack.base.config.js] and [i18n.config.js] for reference.