@yabasha/gex 1.4.0 → 1.4.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 +45 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
# GEX — Global/local dependency auditing and documentation for Node.js
|
|
13
13
|
|
|
14
|
-
GEX is a focused CLI that generates structured, reproducible reports of your Node.js package environments:
|
|
14
|
+
GEX is a focused CLI that generates structured, reproducible reports of your Node.js / bun package environments:
|
|
15
15
|
|
|
16
16
|
- Local project dependencies (default)
|
|
17
17
|
- Globally installed packages
|
|
@@ -20,20 +20,38 @@ Reports can be emitted as machine-readable JSON (default) or human-friendly Mark
|
|
|
20
20
|
|
|
21
21
|
## Install
|
|
22
22
|
|
|
23
|
-
- Requirements: Node >=
|
|
24
|
-
- Global install
|
|
23
|
+
- Requirements: Node >= 20, npm
|
|
24
|
+
- **Global install (npm)**:
|
|
25
25
|
|
|
26
|
-
```bash
|
|
27
|
-
npm i -g @yabasha/gex
|
|
28
|
-
```
|
|
26
|
+
```bash
|
|
27
|
+
npm i -g @yabasha/gex
|
|
28
|
+
```
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
- **Global install (Bun)**:
|
|
31
31
|
|
|
32
|
-
```bash
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
32
|
+
```bash
|
|
33
|
+
bun add -g @yabasha/gex
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
- **Local Build / Development**:
|
|
37
|
+
|
|
38
|
+
clone the repository and run:
|
|
39
|
+
|
|
40
|
+
**Using npm**:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm i
|
|
44
|
+
npm run build
|
|
45
|
+
node dist/cli.cjs --help
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**Using Bun**:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
bun install
|
|
52
|
+
bun run build
|
|
53
|
+
bun dist/cli-bun.mjs --help
|
|
54
|
+
```
|
|
37
55
|
|
|
38
56
|
## Usage
|
|
39
57
|
|
|
@@ -198,19 +216,32 @@ Example (truncated):
|
|
|
198
216
|
|
|
199
217
|
CI/CD examples:
|
|
200
218
|
|
|
201
|
-
- Using npx (
|
|
219
|
+
- Using npx (Node.js):
|
|
202
220
|
|
|
203
221
|
```bash
|
|
204
222
|
npx -y @yabasha/gex@latest -f json -o gex-report.json
|
|
205
223
|
```
|
|
206
224
|
|
|
207
|
-
-
|
|
225
|
+
- Using bunx (Bun):
|
|
226
|
+
|
|
227
|
+
```bash
|
|
228
|
+
bunx @yabasha/gex@latest -f json -o gex-report.json
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
- GitHub Actions step snippet (Node):
|
|
208
232
|
|
|
209
233
|
```yaml
|
|
210
234
|
- name: Generate dependency report
|
|
211
235
|
run: npx -y @yabasha/gex@latest -f json -o gex-report.json
|
|
212
236
|
```
|
|
213
237
|
|
|
238
|
+
- GitHub Actions step snippet (Bun):
|
|
239
|
+
|
|
240
|
+
```yaml
|
|
241
|
+
- name: Generate dependency report
|
|
242
|
+
run: bunx @yabasha/gex@latest -f json -o gex-report.json
|
|
243
|
+
```
|
|
244
|
+
|
|
214
245
|
## Development (repo)
|
|
215
246
|
|
|
216
247
|
```bash
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yabasha/gex",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.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",
|