@kong/icons 0.0.2-pr.1.8609e50.0 → 0.0.2-pr.1.8f7addf.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 +18 -0
- package/dist/kong-icons.es.js +90 -90
- package/dist/kong-icons.es.js.map +1 -1
- package/dist/kong-icons.umd.js +1 -1
- package/dist/kong-icons.umd.js.map +1 -1
- package/dist/types/components/index.d.ts +1 -1
- package/package.json +7 -6
package/README.md
CHANGED
|
@@ -6,6 +6,7 @@ Kong's open-source icon component library.
|
|
|
6
6
|
- [SVG Requirements](#svg-requirements)
|
|
7
7
|
- [Development Sandbox](#development-sandbox)
|
|
8
8
|
- [Lint and fix](#lint-and-fix)
|
|
9
|
+
- [Testing](#testing)
|
|
9
10
|
- [Build for production](#build-for-production)
|
|
10
11
|
- [Committing Changes](#committing-changes)
|
|
11
12
|
- [Package Publishing](#package-publishing)
|
|
@@ -49,6 +50,23 @@ yarn lint
|
|
|
49
50
|
yarn lint:fix
|
|
50
51
|
```
|
|
51
52
|
|
|
53
|
+
### Testing
|
|
54
|
+
|
|
55
|
+
Unit and component tests are run with [Vitest](https://vitest.dev/)
|
|
56
|
+
|
|
57
|
+
```sh
|
|
58
|
+
# Run tests
|
|
59
|
+
yarn test
|
|
60
|
+
|
|
61
|
+
# Run tests in the Vitest UI
|
|
62
|
+
yarn test:open
|
|
63
|
+
|
|
64
|
+
# Update test snapshots
|
|
65
|
+
yarn test -u
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
When svg files are added or removed, this will cause the test that compares the component snapshot exports to fail. If the snapshot change is expected, run `yarn test -u` to update the test snapshots accordingly.
|
|
69
|
+
|
|
52
70
|
### Build for production
|
|
53
71
|
|
|
54
72
|
Utilize the `style-dictionary` CLI to build the token assets for production based on the configuration in `/config.js`.
|