@component-compass/cli 0.1.26 → 0.1.28
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 +16 -2
- package/dist/cli.js +67431 -66910
- package/examples/github-actions-workflow.yml +1 -1
- package/package.json +24 -10
package/README.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# component-compass
|
|
2
2
|
|
|
3
|
-
Open-source CLI for measuring design-system component usage across multi-framework consumer repos.
|
|
3
|
+
Open-source CLI for measuring design-system component usage across multi-framework consumer repos. It scans React and Vue code, custom elements included, and writes every component reference, call site and prop to one deterministic JSON artifact.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Get started
|
|
6
|
+
|
|
7
|
+
You need Node 24 or later. Yarn users need `nodeLinker: node-modules`, because Plug'n'Play isn't supported.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm i -D @component-compass/cli
|
|
11
|
+
npx @component-compass/cli init
|
|
12
|
+
npx @component-compass/cli scan
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
The scan writes `component-compass.json` next to the config. [Scan your first repo](https://scoutui.dev/docs/tutorials/scan-your-first-repo) walks through it step by step.
|
|
16
|
+
|
|
17
|
+
## Documentation
|
|
18
|
+
|
|
19
|
+
See the [documentation site](https://scoutui.dev/docs/overview) for install, configuration, scanning, the self-hosted dashboard and reference.
|