@yabasha/gex 0.3.1 → 0.3.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/README.md +30 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -65,11 +65,15 @@ gex local --omit-dev -f json -o deps.json
|
|
|
65
65
|
# Global packages
|
|
66
66
|
gex global -f md -o global.md
|
|
67
67
|
|
|
68
|
-
# Read a previous report (
|
|
69
|
-
#
|
|
68
|
+
# Read a previous report (JSON or Markdown)
|
|
69
|
+
# Default prints names@versions; add -i to install
|
|
70
|
+
# Positional path or -r/--report are accepted
|
|
71
|
+
# JSON
|
|
70
72
|
gex read
|
|
71
|
-
# or specify a file and install
|
|
72
73
|
gex read -r path/to/report.json -i
|
|
74
|
+
# Markdown
|
|
75
|
+
gex read global.md
|
|
76
|
+
gex read global.md -i
|
|
73
77
|
```
|
|
74
78
|
|
|
75
79
|
## JSON schema (summary)
|
|
@@ -141,3 +145,26 @@ npm test
|
|
|
141
145
|
npm run dev # watch + shows CLI help on success
|
|
142
146
|
npm run lint
|
|
143
147
|
```
|
|
148
|
+
|
|
149
|
+
## Contribute
|
|
150
|
+
|
|
151
|
+
We welcome contributions! A quick guide to getting productive:
|
|
152
|
+
|
|
153
|
+
- Setup
|
|
154
|
+
- Fork and clone this repo, then: `npm i`
|
|
155
|
+
- Dev loop: `npm run dev` (rebuilds and prints CLI help on successful build)
|
|
156
|
+
- One-off build: `npm run build`, then run: `node dist/cli.cjs --help`
|
|
157
|
+
- Test, lint, format
|
|
158
|
+
- Run tests: `npm test` (or `npm run test:watch`) — uses Vitest
|
|
159
|
+
- Lint: `npm run lint`; Format: `npm run format`
|
|
160
|
+
- Adding features/fixes
|
|
161
|
+
- Create a branch (e.g., `feat/read-reports`, `fix/option-parsing`)
|
|
162
|
+
- Make changes and add tests when reasonable
|
|
163
|
+
- If the change is user-facing, add a changeset: `npx changeset` (choose bump; write a summary)
|
|
164
|
+
- Open a PR (use `gh` CLI per workspace convention)
|
|
165
|
+
- Example: `gh pr create --fill` (ensure your branch is pushed)
|
|
166
|
+
- CI will run tests and build; the Release workflow will open a "Version Packages" PR for changesets
|
|
167
|
+
- Merge the "Version Packages" PR to publish to npm automatically
|
|
168
|
+
- Quick local verification
|
|
169
|
+
- Generate a report: `gex -f json -o gex-report.json`
|
|
170
|
+
- Read a report: `gex read` (JSON) or `gex read global.md` (Markdown); add `-i` to install
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yabasha/gex",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "A CLI tool for auditing and documenting your Node.js package environment, generating comprehensive reports of global and local dependencies.",
|
|
6
6
|
"type": "module",
|