@deplens/cli 0.1.2 → 0.1.4
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 +68 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# @deplens/cli
|
|
2
|
+
|
|
3
|
+
Command-line interface for DepLens.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i -g @deplens/cli
|
|
9
|
+
# or
|
|
10
|
+
npx deplens --help
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
deplens <package-or-import-path> [filter]
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Examples
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Inspect exports and types
|
|
23
|
+
deplens ai --types --filter generate
|
|
24
|
+
|
|
25
|
+
# Use a monorepo root for resolution
|
|
26
|
+
deplens next/server --types --resolve-from /path/to/repo
|
|
27
|
+
|
|
28
|
+
# Show only classes
|
|
29
|
+
deplens livekit-server-sdk --kind class --types
|
|
30
|
+
|
|
31
|
+
# JSDoc summary + params + returns
|
|
32
|
+
deplens ai --types \
|
|
33
|
+
--jsdoc compact \
|
|
34
|
+
--jsdoc-output section \
|
|
35
|
+
--jsdoc-symbol generateText \
|
|
36
|
+
--jsdoc-sections summary,params,returns \
|
|
37
|
+
--jsdoc-tags param,returns \
|
|
38
|
+
--jsdoc-truncate sentence \
|
|
39
|
+
--jsdoc-max-len 220
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Flags
|
|
43
|
+
|
|
44
|
+
- `--types` — include type signatures from `.d.ts`
|
|
45
|
+
- `--filter <text>` — substring filter for exports
|
|
46
|
+
- `--kind <k1,k2>` — `function`, `class`, `object`, `constant`
|
|
47
|
+
- `--depth <0-5>` — object inspection depth
|
|
48
|
+
- `--resolve-from <dir>` — base directory for module resolution
|
|
49
|
+
|
|
50
|
+
JSDoc:
|
|
51
|
+
|
|
52
|
+
- `--jsdoc off|compact|full`
|
|
53
|
+
- `--jsdoc-output off|section|inline|only`
|
|
54
|
+
- `--jsdoc-symbol <name|glob|/re/>`
|
|
55
|
+
- `--jsdoc-sections summary,params,returns,tags`
|
|
56
|
+
- `--jsdoc-tags t1,t2`
|
|
57
|
+
- `--jsdoc-tags-exclude t1,t2`
|
|
58
|
+
- `--jsdoc-truncate none|sentence|word`
|
|
59
|
+
- `--jsdoc-max-len <N>`
|
|
60
|
+
|
|
61
|
+
## Requirements
|
|
62
|
+
|
|
63
|
+
- Node.js >= 18
|
|
64
|
+
- Bun is optional and used automatically if available
|
|
65
|
+
|
|
66
|
+
## License
|
|
67
|
+
|
|
68
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deplens/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "Inspect exports and types of installed npm packages",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"bin"
|
|
12
12
|
],
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@deplens/core": "0.1.
|
|
14
|
+
"@deplens/core": "0.1.4"
|
|
15
15
|
},
|
|
16
16
|
"publishConfig": {
|
|
17
17
|
"access": "public"
|