@iyowei/sweep-node-modules 0.4.0 → 0.5.0
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/LICENSE +1 -1
- package/README.md +612 -93
- package/README.zh-CN.md +612 -93
- package/dist/classify.d.ts +48 -0
- package/dist/codes.d.ts +41 -0
- package/dist/config.d.ts +115 -0
- package/dist/delete.d.ts +155 -0
- package/dist/display.d.ts +29 -0
- package/dist/errors.d.ts +43 -0
- package/dist/guard.d.ts +230 -0
- package/dist/index.d.ts +20 -0
- package/dist/index.js +1775 -0
- package/dist/manifest.json +4 -3
- package/dist/runtime.d.ts +26 -0
- package/dist/scan-native.d.ts +2 -0
- package/dist/scan-parallel.d.ts +2 -0
- package/dist/scan-prune.d.ts +2 -0
- package/dist/scan.d.ts +6 -0
- package/dist/size-du.d.ts +33 -0
- package/dist/size-js.d.ts +2 -0
- package/dist/size.d.ts +2 -0
- package/dist/skip.d.ts +35 -0
- package/dist/summary.d.ts +38 -0
- package/dist/sweep.d.ts +7 -0
- package/dist/types.d.ts +458 -0
- package/package.json +14 -52
- package/bin/sweep-nm.mjs +0 -190
- package/dist/cli.js +0 -1699
package/package.json
CHANGED
|
@@ -1,37 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iyowei/sweep-node-modules",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
5
|
-
"
|
|
6
|
-
"cli",
|
|
7
|
-
"cli-tool",
|
|
8
|
-
"tool",
|
|
9
|
-
"node-modules",
|
|
10
|
-
"node_modules",
|
|
11
|
-
"modules",
|
|
12
|
-
"delete",
|
|
13
|
-
"remove",
|
|
14
|
-
"remover",
|
|
15
|
-
"del",
|
|
16
|
-
"cleaner",
|
|
17
|
-
"cleanup",
|
|
18
|
-
"clean",
|
|
19
|
-
"prune",
|
|
20
|
-
"sweep",
|
|
21
|
-
"bulk",
|
|
22
|
-
"batch",
|
|
23
|
-
"disk-usage",
|
|
24
|
-
"disk-space",
|
|
25
|
-
"free-up-space",
|
|
26
|
-
"workspace",
|
|
27
|
-
"monorepo",
|
|
28
|
-
"npm",
|
|
29
|
-
"pnpm",
|
|
30
|
-
"yarn",
|
|
31
|
-
"bun",
|
|
32
|
-
"node"
|
|
33
|
-
],
|
|
34
|
-
"author": "iYoWei",
|
|
3
|
+
"version": "0.5.0",
|
|
4
|
+
"description": "Programmable API to sweep node_modules across workspace roots: scan, measure, and safely remove them from your own scripts and tools. 工作区级 node_modules 清理能力的可编程 API。",
|
|
5
|
+
"author": "iTonyYo (https://github.com/iTonyYo)",
|
|
35
6
|
"license": "MIT",
|
|
36
7
|
"repository": {
|
|
37
8
|
"type": "git",
|
|
@@ -42,37 +13,28 @@
|
|
|
42
13
|
"url": "https://github.com/iyowei/sweep-node-modules/issues"
|
|
43
14
|
},
|
|
44
15
|
"type": "module",
|
|
45
|
-
"
|
|
46
|
-
|
|
16
|
+
"sideEffects": false,
|
|
17
|
+
"exports": {
|
|
18
|
+
".": {
|
|
19
|
+
"types": "./dist/index.d.ts",
|
|
20
|
+
"default": "./dist/index.js"
|
|
21
|
+
}
|
|
47
22
|
},
|
|
48
23
|
"files": [
|
|
49
|
-
"bin/sweep-nm.mjs",
|
|
50
24
|
"dist"
|
|
51
25
|
],
|
|
52
26
|
"engines": {
|
|
53
27
|
"node": ">=22.18.0"
|
|
54
28
|
},
|
|
55
29
|
"publishConfig": {
|
|
56
|
-
"access": "public"
|
|
30
|
+
"access": "public",
|
|
31
|
+
"registry": "https://registry.npmjs.org/"
|
|
57
32
|
},
|
|
58
33
|
"scripts": {
|
|
59
|
-
"
|
|
60
|
-
"build": "bun build src/cli.ts --target=node --outfile=dist/cli.js && bun scripts/write-dist-manifest.ts",
|
|
61
|
-
"prepublishOnly": "npm run build && npm run verify:release",
|
|
62
|
-
"verify:release": "bun scripts/verify-release.ts",
|
|
34
|
+
"build": "bun scripts/build.ts",
|
|
63
35
|
"typecheck": "tsc --noEmit",
|
|
64
|
-
"lint": "oxlint",
|
|
65
|
-
"lint:fix": "oxlint --fix",
|
|
66
|
-
"format": "prettier --write .",
|
|
67
36
|
"test": "bun test",
|
|
68
|
-
"
|
|
69
|
-
"
|
|
70
|
-
},
|
|
71
|
-
"devDependencies": {
|
|
72
|
-
"@trivago/prettier-plugin-sort-imports": "6.0.2",
|
|
73
|
-
"@types/bun": "1.4.2",
|
|
74
|
-
"oxlint": "1.85.0",
|
|
75
|
-
"prettier": "3.9.8",
|
|
76
|
-
"typescript": "7.0.2"
|
|
37
|
+
"verify:release": "bun scripts/verify-release.ts",
|
|
38
|
+
"prepublishOnly": "npm run build && npm run verify:release"
|
|
77
39
|
}
|
|
78
40
|
}
|
package/bin/sweep-nm.mjs
DELETED
|
@@ -1,190 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
/**
|
|
3
|
-
* npm 安装场景的启动器: 挑选运行时 (Bun 优先, 其次 Node) 后启动真实入口。
|
|
4
|
-
* 与 bin/sweep-nm (sh) / bin/sweep-nm.cmd (cmd) 职责同逻辑 (挑选运行时: Bun 优先, Node 回退),
|
|
5
|
-
* 差异在宿主与本文件多加的入口选择 (优先跑编译产物 dist/cli.js, 无产物则回退源码 src/cli.ts;
|
|
6
|
-
* 包内只有产物, 开发态通常无产物):
|
|
7
|
-
* 本文件同时承担 Unix 与 Windows 的 npm shim 目标 (shebang 必须是 node, 否则
|
|
8
|
-
* npm 的 cmd-shim 会按 shebang 解释器生成 Windows 上不存在的调用)。
|
|
9
|
-
*
|
|
10
|
-
* 运行时解析防劫持 (安全审计项 runtime-resolution:bare-name-cwd-precedence-windows):
|
|
11
|
-
* Windows 上裸名执行会先搜当前工作目录 (CreateProcessW 的搜索序里「parent 的当前目录」居第 2 位;
|
|
12
|
-
* 本文件走的 Node spawn 亦然 —— libuv 的 search_path 以 NeedCurrentDirectoryForExePathW 门控
|
|
13
|
-
* 先试 cwd 再扫 PATH), 而本工具的调用现场恰是「在被扫目录里执行」, 目录内放一个同名
|
|
14
|
-
* bun.exe / bun.com 即可顶替真实运行时进入执行链。故 win32 下先按 PATH 解析出绝对路径
|
|
15
|
-
* (空条目与相对条目都会把解析引回当前目录, 一并跳过) 再探测与执行, 解析面与执行面都不再
|
|
16
|
-
* 触发任何搜索序; POSIX 侧 Node 走 execvp 只搜 PATH, 维持裸名原样。
|
|
17
|
-
*
|
|
18
|
-
* 产物自证 (审计项「发行面 dist/cli.js 与源码和提交无身份绑定」的运行时防线): 决定跑
|
|
19
|
-
* dist/cli.js 之前必须与随附的 dist/manifest.json 对账 (形状版本受支持, 且清单记的 cliSha256
|
|
20
|
-
* 必须等于实测摘要), 清单缺失 / 损坏 / 版本不支持 / 摘要不符一律拒收产物并给出指引, 不静默回退
|
|
21
|
-
* 源码 (静默回退会把产物漂移藏起来, 包内也没有源码可回退); 拒收指引按宿主分流 (仓库检出态给
|
|
22
|
-
* 源码入口与重构建, 包态给重装本包)。工作树脏净不进本判定 (开发态常脏), 那是发布闸门
|
|
23
|
-
* scripts/verify-release.ts 的职责; 清单字段契约见 scripts/release-artifact.ts (包内无法
|
|
24
|
-
* 跨语言复用该模块, 两边口径由 src/npm-launcher.smoke.test.ts 的集成用例钉住)。
|
|
25
|
-
*
|
|
26
|
-
* 退出码原样透传; 两个运行时都缺席时给出可操作提示并非零退出。
|
|
27
|
-
*/
|
|
28
|
-
import { spawnSync } from 'node:child_process';
|
|
29
|
-
import { createHash } from 'node:crypto';
|
|
30
|
-
import { existsSync, readFileSync, realpathSync, statSync } from 'node:fs';
|
|
31
|
-
import { dirname, join, win32 } from 'node:path';
|
|
32
|
-
import { fileURLToPath } from 'node:url';
|
|
33
|
-
|
|
34
|
-
/** 产物与清单的文件名 (与 scripts/release-artifact.ts 的 CLI_FILE / MANIFEST_FILE 同值) */
|
|
35
|
-
const CLI_FILE = 'cli.js';
|
|
36
|
-
const MANIFEST_FILE = 'manifest.json';
|
|
37
|
-
|
|
38
|
-
/**
|
|
39
|
-
* win32 的候选可执行扩展名, 顺序与 Node 实际走的 libuv 搜索一致 (.com 先于 .exe)。
|
|
40
|
-
* 不展开 PATHEXT: .bat / .cmd 无法被 Node 无 shell 直接执行, 展开只会把不可执行的命中当成功;
|
|
41
|
-
* 保持该面与 libuv 等价也意味着本次收紧不改动 win32 上「哪些安装形态能命中」的既有行为。
|
|
42
|
-
*/
|
|
43
|
-
const WIN32_EXEC_EXTS = ['.com', '.exe'];
|
|
44
|
-
|
|
45
|
-
/** 探测命令是否可执行 (以 --version 的实际退出码为准, 不依赖 shell 内建) */
|
|
46
|
-
const available = (command) =>
|
|
47
|
-
spawnSync(command, ['--version'], { stdio: 'ignore' }).status === 0;
|
|
48
|
-
|
|
49
|
-
/** 路径处是否为普通文件 (探针读不到即 false, 不抛; 目录名撞上候选名时不得当选) */
|
|
50
|
-
const isFileAt = (path) => {
|
|
51
|
-
try {
|
|
52
|
-
return statSync(path).isFile();
|
|
53
|
-
} catch {
|
|
54
|
-
return false;
|
|
55
|
-
}
|
|
56
|
-
};
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* 在 PATH 中解析命令的绝对路径 (win32 语义), 找不到返回 null。
|
|
60
|
-
* 只供 win32 分支调用: CreateProcessW 与 libuv 的裸名搜索序都会先搜当前目录, 本函数把
|
|
61
|
-
* 「当前目录」从解析面整个摘掉 —— 空条目 (Windows 上表示当前目录) 与相对条目 (同样按当前
|
|
62
|
-
* 目录解析) 一律跳过, 只认绝对目录; 条目两侧的引号按 libuv 同款剥掉 (Windows PATH 允许
|
|
63
|
-
* 引号包裹含空格的目录)。注入 pathEnv / fileProbe 供测试在非 win32 宿主上覆盖本函数。
|
|
64
|
-
*/
|
|
65
|
-
export const resolveWin32Executable = (name, pathEnv, fileProbe) => {
|
|
66
|
-
for (const raw of pathEnv.split(';')) {
|
|
67
|
-
const dir =
|
|
68
|
-
raw.length > 1 && raw.startsWith('"') && raw.endsWith('"')
|
|
69
|
-
? raw.slice(1, -1)
|
|
70
|
-
: raw;
|
|
71
|
-
if (dir === '' || !win32.isAbsolute(dir)) continue;
|
|
72
|
-
for (const ext of WIN32_EXEC_EXTS) {
|
|
73
|
-
const candidate = win32.join(dir, name + ext);
|
|
74
|
-
if (fileProbe(candidate)) return candidate;
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
return null;
|
|
78
|
-
};
|
|
79
|
-
|
|
80
|
-
/**
|
|
81
|
-
* 挑选运行时: Bun 优先, 其次 Node; 皆无则 null (由调用处报错退出)。
|
|
82
|
-
* win32 下先按 PATH 解析绝对路径再探测 (理由见文件头「运行时解析防劫持」), POSIX 下维持
|
|
83
|
-
* 裸名 (execvp 只搜 PATH); 各参数显式传入供测试注入, 生产调用不传。
|
|
84
|
-
*/
|
|
85
|
-
export const pickRuntime = ({
|
|
86
|
-
platform = process.platform,
|
|
87
|
-
pathEnv = process.env.PATH ?? '',
|
|
88
|
-
fileProbe = isFileAt,
|
|
89
|
-
probe = available,
|
|
90
|
-
} = {}) => {
|
|
91
|
-
for (const name of ['bun', 'node']) {
|
|
92
|
-
const resolved =
|
|
93
|
-
platform === 'win32'
|
|
94
|
-
? resolveWin32Executable(name, pathEnv, fileProbe)
|
|
95
|
-
: name;
|
|
96
|
-
if (resolved !== null && probe(resolved)) return resolved;
|
|
97
|
-
}
|
|
98
|
-
return null;
|
|
99
|
-
};
|
|
100
|
-
|
|
101
|
-
/**
|
|
102
|
-
* 产物自证: 核对 dist/cli.js 与 dist/manifest.json 的摘要是否同源。
|
|
103
|
-
* 通过返回 null, 否则返回人话原因; 原因串全是本文件固定措辞, 不回显清单内容 (清单是外部
|
|
104
|
-
* 文件, 其文本不受控, 不落进输出面)。
|
|
105
|
-
*/
|
|
106
|
-
const artifactProblem = (distDir) => {
|
|
107
|
-
const manifestPath = join(distDir, MANIFEST_FILE);
|
|
108
|
-
if (!existsSync(manifestPath)) return `缺少产物清单 (dist/${MANIFEST_FILE})`;
|
|
109
|
-
let manifest;
|
|
110
|
-
try {
|
|
111
|
-
manifest = JSON.parse(readFileSync(manifestPath, 'utf8'));
|
|
112
|
-
} catch {
|
|
113
|
-
return `产物清单 (dist/${MANIFEST_FILE}) 损坏, 不是合法 JSON`;
|
|
114
|
-
}
|
|
115
|
-
// 形状版本先对: 异版本的字段语义无保证, 宁可拒收 (字面量 1 与 scripts/release-artifact.ts 的
|
|
116
|
-
// MANIFEST_SCHEMA_VERSION 同值, 改动须两处同步; 启动器随包分发, 包内无法 import 该模块)
|
|
117
|
-
if (manifest?.schemaVersion !== 1) {
|
|
118
|
-
return `产物清单 (dist/${MANIFEST_FILE}) 的 schemaVersion 不是受支持的版本 (期望 1)`;
|
|
119
|
-
}
|
|
120
|
-
const recorded = manifest?.cliSha256;
|
|
121
|
-
if (typeof recorded !== 'string') {
|
|
122
|
-
return `产物清单 (dist/${MANIFEST_FILE}) 缺少 cliSha256 字段`;
|
|
123
|
-
}
|
|
124
|
-
let actual;
|
|
125
|
-
try {
|
|
126
|
-
actual = createHash('sha256')
|
|
127
|
-
.update(readFileSync(join(distDir, CLI_FILE)))
|
|
128
|
-
.digest('hex');
|
|
129
|
-
} catch {
|
|
130
|
-
return `产物 (dist/${CLI_FILE}) 读不出来, 摘要算不出`;
|
|
131
|
-
}
|
|
132
|
-
if (recorded !== actual)
|
|
133
|
-
return `产物 (dist/${CLI_FILE}) 的摘要与清单记录不符`;
|
|
134
|
-
return null;
|
|
135
|
-
};
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* 本文件是否作为入口被直接执行。
|
|
139
|
-
* 经 realpath 比对而非字面路径: npm 在 Unix 上以符号链接 (或经 shim) 落 bin, 此时 argv[1] 是
|
|
140
|
-
* 链接路径而 import.meta.url 是解析后的真实路径。main 守卫只为让测试 import 本模块取函数时
|
|
141
|
-
* 不触发主流程, 判定失配的后果是入口静默不跑, 故除字面相等外只在 realpath 成功时采信。
|
|
142
|
-
*/
|
|
143
|
-
const isEntry = () => {
|
|
144
|
-
const entry = process.argv[1];
|
|
145
|
-
if (typeof entry !== 'string' || entry === '') return false;
|
|
146
|
-
const self = fileURLToPath(import.meta.url);
|
|
147
|
-
if (entry === self) return true;
|
|
148
|
-
try {
|
|
149
|
-
return realpathSync(entry) === self;
|
|
150
|
-
} catch {
|
|
151
|
-
return false;
|
|
152
|
-
}
|
|
153
|
-
};
|
|
154
|
-
|
|
155
|
-
const main = () => {
|
|
156
|
-
const root = dirname(dirname(fileURLToPath(import.meta.url)));
|
|
157
|
-
const distDir = join(root, 'dist');
|
|
158
|
-
const built = join(distDir, CLI_FILE);
|
|
159
|
-
const hasBuilt = existsSync(built);
|
|
160
|
-
// 有产物就得先自证 (与随附清单对账); 不通过即拒收, 退出码与「无运行时」同一档: 1
|
|
161
|
-
const problem = hasBuilt ? artifactProblem(distDir) : null;
|
|
162
|
-
if (problem !== null) {
|
|
163
|
-
// 处置指引按宿主分流: 仓库检出态 (有源码) 可走源码入口或重构建; 包态 (无源码) 只能重装本包
|
|
164
|
-
const advice = existsSync(join(root, 'src', 'cli.ts'))
|
|
165
|
-
? '用源码入口跑 (bun src/cli.ts 或 node src/cli.ts), 或重新构建 (bun run build)'
|
|
166
|
-
: '重装本包换一份完好分发 (npm install -g @iyowei/sweep-node-modules); 重装无效则说明该版本包有缺陷, 需发布者重新构建后再发';
|
|
167
|
-
process.stderr.write(
|
|
168
|
-
`sweep-nm: ${problem}, 已拒绝执行该产物 (无法证明它与构建清单同源)。\n` +
|
|
169
|
-
` 处置: ${advice}。\n`,
|
|
170
|
-
);
|
|
171
|
-
process.exit(1);
|
|
172
|
-
}
|
|
173
|
-
// npm 包内是编译产物 (node 拒绝对 node_modules 内的 TS 做类型剥离, 见 package.json 的 build 脚本);
|
|
174
|
-
// 仓库开发态无 dist, 回退直跑源码 (bun / node 皆可)
|
|
175
|
-
const entry = hasBuilt ? built : join(root, 'src', 'cli.ts');
|
|
176
|
-
const runtime = pickRuntime();
|
|
177
|
-
|
|
178
|
-
if (runtime === null) {
|
|
179
|
-
process.stderr.write('sweep-nm: 未找到 bun 或 node, 请至少安装其一\n');
|
|
180
|
-
process.exit(1);
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
const { status } = spawnSync(runtime, [entry, ...process.argv.slice(2)], {
|
|
184
|
-
stdio: 'inherit',
|
|
185
|
-
});
|
|
186
|
-
|
|
187
|
-
process.exit(status ?? 1);
|
|
188
|
-
};
|
|
189
|
-
|
|
190
|
-
if (isEntry()) main();
|