@box/copy-input 0.28.3 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -18
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,13 +1,25 @@
|
|
|
1
|
+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
2
|
+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
3
|
+
|
|
4
|
+
- [copy-input](#copy-input)
|
|
5
|
+
- [Running commands](#running-commands)
|
|
6
|
+
- [Available commands](#available-commands)
|
|
7
|
+
- [Ownership](#ownership)
|
|
8
|
+
- [Translations](#translations)
|
|
9
|
+
|
|
10
|
+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
11
|
+
|
|
1
12
|
# copy-input
|
|
2
13
|
|
|
3
14
|
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.
|
|
4
15
|
|
|
5
16
|
## Running commands
|
|
6
17
|
|
|
7
|
-
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.
|
|
18
|
+
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.
|
|
8
19
|
Do not navigate to `packages/group-shared-features/copy-input` to run commands.
|
|
9
20
|
|
|
10
21
|
Commands for the project are run using syntax used by Nx:
|
|
22
|
+
|
|
11
23
|
```
|
|
12
24
|
Syntax: yarn nx <target name> <project name> <option overrides>
|
|
13
25
|
| | |
|
|
@@ -18,20 +30,20 @@ Example: yarn nx test products --watch
|
|
|
18
30
|
|
|
19
31
|
All commands used with Nx can be found in `project.json` file within your package.
|
|
20
32
|
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
33
|
+
- `nx storybook copy-input` - launches development environment for UI component.
|
|
34
|
+
- `nx build-storybook copy-input` - build static version of storybook with all stories.
|
|
35
|
+
- `nx build copy-input` - build package using `shared-feature-builder` executor from `automation` package.
|
|
36
|
+
- `nx build copy-input --watch` - build package with --watch flag enabled, which rebuilds `dist` content based on changes in `src`
|
|
37
|
+
- `nx build-locales copy-input` - generate `i18n/*.js` and `i18n/*.properties` files out of `i18n/json/*.json` files to be imported by `react-intl`.
|
|
38
|
+
- `nx lint copy-input` - run linter over package files,
|
|
39
|
+
- `nx test copy-input` - runs storybook tests (visual/interactions) and jest unit tests, producing coverage report at the end.
|
|
40
|
+
- `nx test-storybook copy-input` - runs storybook tests. You need first to start storybook in separate terminal for this to work.
|
|
41
|
+
- `nx test-storybook-local-coverage copy-input` - runs storybook tests, and produces coverage report at the end. Requires running instance of storybook.
|
|
42
|
+
- `nx test-storybook-ci copy-input` - build storybook and run storybook tests with coverage output. Designed for CI usage.
|
|
43
|
+
- `nx test-jest copy-input` - runs jest unit tests, producing code coverage at the end.
|
|
44
|
+
- `nx sonar copy-input` - performs static analysis of code using SonarQube tooling, to detect bugs and code smells. Integrated as one of the steps in CI process.
|
|
45
|
+
- `nx chromatic copy-input` - uploads storybook build for review to [box chromatic](https://box.chromatic.com/) , and performs visual comparison of the UI changes against baseline.
|
|
46
|
+
- `nx prepare copy-input` - command run during package publication process orchestrated by Lerna.
|
|
35
47
|
|
|
36
48
|
## Ownership
|
|
37
49
|
|
|
@@ -39,7 +51,7 @@ Code of the feature belongs to design-system. Responsibilities of owning team in
|
|
|
39
51
|
|
|
40
52
|
## Translations
|
|
41
53
|
|
|
42
|
-
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]
|
|
54
|
+
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]
|
|
43
55
|
|
|
44
|
-
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]
|
|
45
|
-
see EUA's [webpack.base.config.js]
|
|
56
|
+
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],
|
|
57
|
+
see EUA's [webpack.base.config.js] and [i18n.config.js] for reference.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@box/copy-input",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"license": "SEE LICENSE IN LICENSE",
|
|
5
5
|
"peerDependencies": {
|
|
6
6
|
"@box/blueprint-web": "^9.19.0",
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"react-intl": "^6.4.2"
|
|
11
11
|
},
|
|
12
12
|
"devDependencies": {
|
|
13
|
-
"@box/blueprint-web": "^12.
|
|
13
|
+
"@box/blueprint-web": "^12.81.1",
|
|
14
14
|
"@box/blueprint-web-assets": "^4.71.0",
|
|
15
15
|
"@box/storybook-utils": "0.14.7",
|
|
16
16
|
"@box/eslint-plugin-blueprint": "1.0.5",
|