@box/metadata-editor 0.95.3 → 0.95.4

package/README.md

@@ -0,0 +1,56 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+-   [metadata-editor](#metadata-editor)
+    -   [Running commands](#running-commands)
+    -   [Available commands](#available-commands)
+    -   [Ownership](#ownership)
+    -   [Translations](#translations)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# metadata-editor
+
+This library was generated with [@box/automation](../../automation//README.md). General overview on how to perform tasks on the generated library can be found in [run-tasks](https://nx.dev/core-features/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-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-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](https://box.chromatic.com/) , and performs visual comparison of the UI changes against baseline.
+-   `nx prepare metadata-editor` - command run during package publication process orchestrated by Lerna.
+
+## Ownership
+
+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.
+
+## 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](https://git.dev.box.net/Box/frontend/tree/master/i18n).
+
+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](https://git.dev.box.net/Box/frontend/blob/master/webpack/README.md#translationsplugin),
+see EUA's [webpack.base.config.js](https://git.dev.box.net/Box/EndUserApp/blob/master/conf/webpack/webpack.base.js#L270-L273) and [i18n.config.js](https://git.dev.box.net/Box/EndUserApp/blob/master/i18n.config.js) for reference.

package/package.json

@@ -1,58 +1,55 @@
 {
-  "name": "@box/metadata-editor",
-  "version": "0.95.3",
-  "peerDependencies": {
-    "@ariakit/react": "0.4.15",
-    "@box/blueprint-web": "^7.30.3",
-    "@box/blueprint-web-assets": "^4.21.0",
-    "@box/combobox-with-api": "^0.26.0",
-    "formik": "^2.0.3",
-    "lodash": "^4.17.15",
-    "react": "^17.0.0 || ^18.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0",
-    "react-intl": "6.4.2"
-  },
-  "devDependencies": {
-    "@ariakit/react": "0.4.15",
-    "@box/babel-plugin-target-attributes": "1.3.0",
-    "@box/blueprint-web": "^9.18.11",
-    "@box/blueprint-web-assets": "^4.36.0",
-    "@box/storybook-utils": "^0.8.3",
-    "@testing-library/react": "^15.0.6",
-    "react": "^18.3.0",
-    "react-dom": "^18.3.0",
-    "react-intl": "6.4.2"
-  },
-  "scripts": {
-    "prepare": "yarn nx run metadata-editor:prepare"
-  },
-  "publishConfig": {
-    "access": "public",
-    "directory": "dist",
-    "registry": "https://registry.npmjs.org"
-  },
-  "main": "./esm/index.js",
-  "module": "./esm/index.js",
-  "types": "./types/index.d.ts",
-  "exports": {
-    ".": {
-      "require": "./esm/index.js",
-      "import": "./esm/index.js",
-      "types": "./types/index.d.ts"
+    "name": "@box/metadata-editor",
+    "version": "0.95.4",
+    "peerDependencies": {
+        "@ariakit/react": "0.4.15",
+        "@box/blueprint-web": "^7.30.3",
+        "@box/blueprint-web-assets": "^4.21.0",
+        "@box/combobox-with-api": "^0.26.0",
+        "formik": "^2.0.3",
+        "lodash": "^4.17.15",
+        "react": "^17.0.0 || ^18.0.0",
+        "react-dom": "^17.0.0 || ^18.0.0",
+        "react-intl": "6.4.2"
     },
-    "./*": {
-      "require": "./esm/*",
-      "import": "./esm/*",
-      "types": "./types/*"
+    "devDependencies": {
+        "@ariakit/react": "0.4.15",
+        "@box/babel-plugin-target-attributes": "1.3.0",
+        "@box/blueprint-web": "^9.18.12",
+        "@box/blueprint-web-assets": "^4.37.0",
+        "@box/storybook-utils": "^0.8.3",
+        "@testing-library/react": "^15.0.6",
+        "react": "^18.3.0",
+        "react-dom": "^18.3.0",
+        "react-intl": "6.4.2"
     },
-    "./i18n/*": {
-      "require": "./i18n/*",
-      "import": "./i18n/*"
-    }
-  },
-  "sideEffects": [
-    "**/*.css"
-  ],
-  "license": "SEE LICENSE IN LICENSE",
-  "gitHead": "d09c912ffd73b3d2b87882dda5023594900c02ff"
-}
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "dist"
+    ],
+    "main": "./dist/esm/index.js",
+    "module": "./dist/esm/index.js",
+    "types": "./dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "require": "./dist/esm/index.js",
+            "import": "./dist/esm/index.js",
+            "types": "./dist/types/index.d.ts"
+        },
+        "./*": {
+            "require": "./dist/esm/*",
+            "import": "./dist/esm/*",
+            "types": "./dist/types/*"
+        },
+        "./i18n/*": {
+            "require": "./dist/i18n/*",
+            "import": "./dist/i18n/*"
+        }
+    },
+    "sideEffects": [
+        "**/*.css"
+    ],
+    "license": "SEE LICENSE IN LICENSE"
+}