@zeroheight/adoption-cli 2.0.1 → 2.0.2
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/CHANGELOG.md +4 -0
- package/README.md +16 -4
- package/dist/cli.js +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# Release notes
|
|
2
2
|
|
|
3
|
+
## [2.0.2](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.0.2) - 29th October 2024
|
|
4
|
+
|
|
5
|
+
- Update readme
|
|
6
|
+
|
|
3
7
|
## [2.0.1](https://www.npmjs.com/package/@zeroheight/adoption-cli/v/2.0.1) - 21st October 2024
|
|
4
8
|
|
|
5
9
|
- Update help text and link
|
package/README.md
CHANGED
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
CLI for measuring component usage to view in your [zeroheight](https://zeroheight.com/) account.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**For full walk through on how to use this CLI tool, head over to our [help centre article](https://zeroheight.com/help/article/adoption-private-beta-overview/).**
|
|
6
|
+
|
|
7
|
+
[Release notes](https://www.npmjs.com/package/@zeroheight/adoption-cli?activeTab=code)
|
|
6
8
|
|
|
7
9
|
## Install
|
|
8
10
|
|
|
@@ -37,7 +39,9 @@ export ZEROHEIGHT_ACCESS_TOKEN="your-access-token"
|
|
|
37
39
|
|
|
38
40
|
### Component usage analysis
|
|
39
41
|
|
|
40
|
-
|
|
42
|
+
[Help center article](https://zeroheight.com/help/article/component-usage/)
|
|
43
|
+
|
|
44
|
+
In the React repository in which you wish to get usage metrics around how components from your design system packages are being used, run the following command:
|
|
41
45
|
|
|
42
46
|
```bash
|
|
43
47
|
zh-adoption analyze
|
|
@@ -81,7 +85,11 @@ zh-adoption analyze --interactive false -r "My Repo"
|
|
|
81
85
|
|
|
82
86
|
### Monitor repo
|
|
83
87
|
|
|
84
|
-
|
|
88
|
+
[Help center article](https://zeroheight.com/help/article/package-version-monitoring/)
|
|
89
|
+
|
|
90
|
+
This will analyze your code repository to help you understand what packages are being used and at what version.
|
|
91
|
+
|
|
92
|
+
In the repository in which you wish to monitor, run the following command:
|
|
85
93
|
|
|
86
94
|
```bash
|
|
87
95
|
zh-adoption monitor-repo
|
|
@@ -101,7 +109,11 @@ zh-adoption monitor-repo -d ./webApp
|
|
|
101
109
|
|
|
102
110
|
### Track package
|
|
103
111
|
|
|
104
|
-
|
|
112
|
+
[Help center article](https://zeroheight.com/help/article/package-version-monitoring/)
|
|
113
|
+
|
|
114
|
+
This will give zeroheight the name and current version of your design system package so you can compare it to the version being used by your other code repositories.
|
|
115
|
+
|
|
116
|
+
In the repository containing your design system package, run the following command:
|
|
105
117
|
|
|
106
118
|
```bash
|
|
107
119
|
zh-adoption track-package
|
package/dist/cli.js
CHANGED
|
@@ -12,7 +12,7 @@ const { output, cleanup } = render(React.createElement(HelpInfo, null));
|
|
|
12
12
|
program
|
|
13
13
|
.name("zh-adoption")
|
|
14
14
|
.description("CLI for measuring design system usage usage in your products")
|
|
15
|
-
.version("2.0.
|
|
15
|
+
.version("2.0.2")
|
|
16
16
|
.addHelpText("before", output)
|
|
17
17
|
.addCommand(analyzeCommand())
|
|
18
18
|
.addCommand(authCommand())
|