@box/metadata-filter

• metadata-filter
  • Running commands
  • Available commands
  • Ownership

metadata-filter

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-filter 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-filter - launches development environment for UI component.
• nx build-storybook metadata-filter - build static version of storybook with all stories.
• nx build metadata-filter - build package using shared-feature-builder executor from automation package.
• nx lint metadata-filter - run linter over package files,
• nx test metadata-filter - runs storybook tests (visual/interactions) and jest unit tests, producing coverage report at the end.
• nx test-storybook metadata-filter - runs storybook tests. You need first to start storybook in separate terminal for this to work.
• nx test-storybook-local-coverage metadata-filter - runs storybook tests, and produces coverage report at the end. Requires running instance of storybook.
• nx test-storybook-ci metadata-filter - build storybook and run storybook tests with coverage output. Designed for CI usage.
• nx test-jest metadata-filter - runs jest unit tests, producing code coverage at the end.
• nx sonar metadata-filter - 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-filter - uploads storybook build for review to box chromatic , and performs visual comparison of the UI changes against baseline.
• nx prepare metadata-filter - command run during package publication process orchestrated by Lerna.

Ownership

Code of the feature belongs to @Box/webapp-eng. 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.