@box/box-ai-content-answers

• box-ai-content-answers
  • Running commands
  • Available commands
  • Ownership
  • Translations
  • Development

Notice: Upcoming Deprecation

This package will soon be deprecated as we transition to the new AX (Agentic) interface. A separate version intended for third-party developers will be released in the foresable future. We recommend using this package with caution, as it may no longer receive updates or support.

box-ai-content-answers

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

Ownership

Code of the feature belongs to #ai-experiences. 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

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.

Development

Development Guide: https://cloud.box.com/s/avvtj6l58mp6k4a7bm36iiaz76lxt0wr

Test the app locally: In frontend-mono root directory run:

• yarn nx storybook box-ai-content-answers This will launch a local development environment in storybook

If you want to test your changes against a parent app:

• yarn nx prepare box-ai-content-answers from the root directory
• cd packages/group-shared-features/box-ai-content-answers/dist/
• yarn link
• Go to host application and then run yarn link "@box/box-ai-content-answers"
• If you want to run it in watch mode, then run yarn nx build box-ai-content-answers --watch from the root directory in frontend-mono to be able to see the changes