@iyowei/sweep-node-modules 0.5.1 → 1.0.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/README.md +22 -19
- package/README.zh-CN.md +164 -161
- package/dist/codes.d.ts +3 -1
- package/dist/delete.d.ts +3 -11
- package/dist/display.d.ts +1 -1
- package/dist/errors.d.ts +39 -24
- package/dist/guard.d.ts +9 -7
- package/dist/index.d.ts +3 -3
- package/dist/index.js +747 -329
- package/dist/manifest.json +3 -3
- package/dist/scan.d.ts +2 -6
- package/dist/skip.d.ts +1 -1
- package/dist/summary.d.ts +4 -1
- package/dist/types.d.ts +15 -9
- package/package.json +8 -5
- package/dist/runtime.d.ts +0 -26
- package/dist/scan-native.d.ts +0 -2
- package/dist/scan-parallel.d.ts +0 -2
- package/dist/scan-prune.d.ts +0 -2
- package/dist/size-du.d.ts +0 -33
- package/dist/size-js.d.ts +0 -2
package/dist/manifest.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": 1,
|
|
3
3
|
"entry": "index.js",
|
|
4
|
-
"entrySha256": "
|
|
5
|
-
"commit": "
|
|
4
|
+
"entrySha256": "2b37853eab9e134ae3d9d2247d5f82a600dba498af72d7e0c7fe34644fb9d68b",
|
|
5
|
+
"commit": "be1d026b7987f5464aacd28c9415f03ba1392012",
|
|
6
6
|
"dirty": false,
|
|
7
|
-
"builtAt": "2026-
|
|
7
|
+
"builtAt": "2026-11-20T04:00:38.227Z"
|
|
8
8
|
}
|
package/dist/scan.d.ts
CHANGED
|
@@ -1,6 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
* 裁定 (基准 r2): 候选 C parallel 胜出 (契约 / 鲁棒双绿, 真实工作区 3.4s → 0.7s, 4.8~5.0×);
|
|
4
|
-
* 并发上限 32 与扫描算法的完整裁定见 docs/designs/scan-and-size.md「实现裁定」。
|
|
5
|
-
*/
|
|
6
|
-
export { createParallelScanner as createScanner } from './scan-parallel.js';
|
|
1
|
+
import type { Scanner } from './types.js';
|
|
2
|
+
export declare function createScanner(): Scanner;
|
package/dist/skip.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* 两类判定本体不在本模块: 疑似安装树见 classify.ts (纯路径形态, 零 IO), 跨设备目标见 guard.ts
|
|
4
4
|
* (设备比对); 本模块只管「挡下之后怎么说、怎么放行」——放行通道两样, 互不通兑:
|
|
5
5
|
* 疑似安装树是 `--force` (语义面: 删后能否由项目级重装恢复), 跨设备是声明独立根或先卸载
|
|
6
|
-
* (授权面: 目标落在另一文件系统上, 旗标放行不了, 见 docs/designs/deletion-guard.md「设备边界」)。
|
|
6
|
+
* (授权面: 目标落在另一文件系统上, 旗标放行不了, 见 docs/sweep/designs/deletion-guard.md「设备边界」)。
|
|
7
7
|
* 入参为 SkipCandidate (非渲染类型): 判定被绑在渲染类型上会让写侧依赖读侧的展示形态。
|
|
8
8
|
*/
|
|
9
9
|
import { type ClassifyOptions } from './classify.js';
|
package/dist/summary.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* 结果缝合层 (纯函数, 零 IO): 成功侧判据与计数摘要。
|
|
3
|
-
* 契约基准: docs/designs/api-surface.md §2.7 与 §7.8。
|
|
3
|
+
* 契约基准: packages/sweep-node-modules/docs/designs/api-surface.md §2.7 与 §7.8。
|
|
4
4
|
*
|
|
5
5
|
* 存在价值是「随版本新增 EntryOutcome.kind 时不会静默漏判」: 手写的
|
|
6
6
|
* `every(kind !== 'x' && kind !== 'y')` 在库里新增一种成功侧 kind 后会把新 kind
|
|
@@ -15,6 +15,9 @@ export declare function isSuccessOutcome(outcome: EntryOutcome): boolean;
|
|
|
15
15
|
* 结果计数摘要: 成功侧 / 未处理 / 真失败 / 整批中止四档, 口径与 §2.7 的严格档配方
|
|
16
16
|
* 同源 (CLI 包即按该档落退出码)。计数表以显式字面量初始化: 新增 kind 时 TS
|
|
17
17
|
* 会在本处报缺键, 强制显式归类。
|
|
18
|
+
* 注: not-attempted 覆盖两类未执行删除的批次内条目 —— 删除阶段复核整批中止后未派发条目
|
|
19
|
+
* (AbortCode), 以及安全闸整批拒绝时同批通过闸门但连带未删的健康条目 ('BATCH_REJECTED');
|
|
20
|
+
* 二者同归 unprocessed, 而 aborted 布尔仍由 removal.aborted 存在与否唯一判定。
|
|
18
21
|
*
|
|
19
22
|
* ### 数据追踪示例
|
|
20
23
|
* ```text
|
package/dist/types.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* 候选差异只允许存在于接口内部, 调用方无感。
|
|
4
4
|
*/
|
|
5
5
|
import type { TargetKind } from './classify.js';
|
|
6
|
-
import type {
|
|
6
|
+
import type { NotAttemptedCode, SizeBasis, SkipReason, SweepPhase, SweepWarningCode, UnmeasuredCode } from './codes.js';
|
|
7
7
|
import type { AbortedBatch, RemovalResult, TargetFailure } from './delete.js';
|
|
8
8
|
import type { CrossDeviceKind, PathStyle, RejectedTarget, ValidationResult } from './guard.js';
|
|
9
9
|
export interface ScanOptions {
|
|
@@ -214,13 +214,13 @@ export interface SweepOptions {
|
|
|
214
214
|
}
|
|
215
215
|
/** 本次实际生效的选项 (合并缺省后的只读快照, 供审计与日志) */
|
|
216
216
|
export interface ResolvedSweepOptions {
|
|
217
|
-
roots: string[];
|
|
217
|
+
readonly roots: readonly string[];
|
|
218
218
|
/** 已过 mergeNames 收口的生效名单 (去重 + 静默剔除永不生效名, BC-34) */
|
|
219
|
-
exclude: string[];
|
|
220
|
-
include: string[];
|
|
221
|
-
home: string | null;
|
|
222
|
-
style: PathStyle;
|
|
223
|
-
policy: SweepPolicy
|
|
219
|
+
readonly exclude: readonly string[];
|
|
220
|
+
readonly include: readonly string[];
|
|
221
|
+
readonly home: string | null;
|
|
222
|
+
readonly style: PathStyle;
|
|
223
|
+
readonly policy: Readonly<SweepPolicy>;
|
|
224
224
|
}
|
|
225
225
|
/** 只读面调用选项 (plan) */
|
|
226
226
|
export interface SweepPlanOptions {
|
|
@@ -301,6 +301,8 @@ export interface SweepPlan {
|
|
|
301
301
|
batch: string[];
|
|
302
302
|
/** 批次外目标与原因 (含未测到体积的条目) */
|
|
303
303
|
skipped: SkippedTarget[];
|
|
304
|
+
/** 清单末行说明 (与 SkipBook.trailer 同源: 按类与形态各一行, 只在出现时出; 无跳过说明时为空数组) */
|
|
305
|
+
trailer?: string[];
|
|
304
306
|
/** 扫描与体积的非致命告警 (两段合并, 保各自次序) */
|
|
305
307
|
warnings: SweepWarning[];
|
|
306
308
|
/** 两份名单的命中统计 (供 CLI 出名单回执与未命中告警, BC-09 / BC-33) */
|
|
@@ -341,10 +343,14 @@ export type EntryOutcome =
|
|
|
341
343
|
kind: 'rejected';
|
|
342
344
|
rejection: RejectedTarget;
|
|
343
345
|
}
|
|
344
|
-
/**
|
|
346
|
+
/**
|
|
347
|
+
* 批次内但未尝试:
|
|
348
|
+
* - 删除阶段复核整批中止时未被派发的条目 (AbortCode; 并发窗口内已派发条目会完成并如实报告, 之后不再派发新条目);
|
|
349
|
+
* - 安全闸整批拒绝时同批通过闸门、因整批零删除而连带未删的健康条目 ('BATCH_REJECTED')。
|
|
350
|
+
*/
|
|
345
351
|
| {
|
|
346
352
|
kind: 'not-attempted';
|
|
347
|
-
code:
|
|
353
|
+
code: NotAttemptedCode;
|
|
348
354
|
}
|
|
349
355
|
/**
|
|
350
356
|
* 在期望批次之外 (提供了 expectedBatch, 且本目标不在其中)。
|
package/package.json
CHANGED
|
@@ -1,19 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iyowei/sweep-node-modules",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
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
5
|
"author": "iTonyYo (https://github.com/iTonyYo)",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "git+https://github.com/iyowei/
|
|
9
|
+
"url": "git+https://github.com/iyowei/clis.git"
|
|
10
10
|
},
|
|
11
|
-
"homepage": "https://github.com/iyowei/
|
|
11
|
+
"homepage": "https://github.com/iyowei/clis#readme",
|
|
12
12
|
"bugs": {
|
|
13
|
-
"url": "https://github.com/iyowei/
|
|
13
|
+
"url": "https://github.com/iyowei/clis/issues"
|
|
14
14
|
},
|
|
15
15
|
"type": "module",
|
|
16
16
|
"sideEffects": false,
|
|
17
|
+
"main": "./dist/index.js",
|
|
18
|
+
"types": "./dist/index.d.ts",
|
|
17
19
|
"exports": {
|
|
18
20
|
".": {
|
|
19
21
|
"types": "./dist/index.d.ts",
|
|
@@ -32,8 +34,9 @@
|
|
|
32
34
|
},
|
|
33
35
|
"scripts": {
|
|
34
36
|
"build": "bun scripts/build.ts",
|
|
35
|
-
"typecheck": "
|
|
37
|
+
"typecheck": "bun check",
|
|
36
38
|
"test": "bun test",
|
|
39
|
+
"bench": "bun bench/run.ts",
|
|
37
40
|
"verify:release": "bun scripts/verify-release.ts",
|
|
38
41
|
"prepublishOnly": "npm run build && npm run verify:release"
|
|
39
42
|
}
|
package/dist/runtime.d.ts
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
/** 运行时探测: 功能检测, 有 Bun 走 Bun 实现, 无则回退 Node 实现 */
|
|
2
|
-
export declare const isBun: boolean;
|
|
3
|
-
/**
|
|
4
|
-
* 运行时自述 (如 `bun 1.4.2`): 供输出如实展示本次的执行环境。
|
|
5
|
-
* 取运行时自报字段而非外部探测 —— 直接跑 `node dist/cli.js` 或经启动器跑, 报的都是真身。
|
|
6
|
-
*/
|
|
7
|
-
export declare const runtimeLabel: string;
|
|
8
|
-
export interface SpawnResult {
|
|
9
|
-
/** 标准输出全文 (UTF-8) */
|
|
10
|
-
stdout: string;
|
|
11
|
-
/** 退出码; 非零不视为错误, 由调用方判定 */
|
|
12
|
-
exitCode: number;
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* 执行命令并捕获 stdout。
|
|
16
|
-
* 命令不存在 (ENOENT) 时抛出含命令名的错误; 退出码非零原样返回, 不抛错。
|
|
17
|
-
* stderr 直通 (inherit) 而非捕获: 既避免管道缓冲填满导致子进程阻塞, 又让错误原样可见。
|
|
18
|
-
* 裸名与解析面: win32 上传入裸名会先搜当前工作目录 (CreateProcessW 与 libuv 的搜索序皆然,
|
|
19
|
-
* 见 CLI 包 `bin/sweep-nm.mjs` 文件头与行为契约 EC-08), 调用方须先自行解析为绝对路径再传入;
|
|
20
|
-
* POSIX 侧 execvp 只搜 PATH, 裸名照常安全。
|
|
21
|
-
*/
|
|
22
|
-
export declare function spawnCapture(cmd: string, args: string[]): Promise<SpawnResult>;
|
|
23
|
-
/** 读取文本文件 (UTF-8); 文件不存在时 reject (两运行时行为一致) */
|
|
24
|
-
export declare function readTextFile(path: string): Promise<string>;
|
|
25
|
-
/** 写入文本文件 (UTF-8); 目标目录不存在时 reject */
|
|
26
|
-
export declare function writeTextFile(path: string, text: string): Promise<void>;
|
package/dist/scan-native.d.ts
DELETED
package/dist/scan-parallel.d.ts
DELETED
package/dist/scan-prune.d.ts
DELETED
package/dist/size-du.d.ts
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
import type { Sizer } from './types.js';
|
|
2
|
-
/**
|
|
3
|
-
* 探测可用的 du 可执行文件; 均缺失返回 null。
|
|
4
|
-
* win32 一律返回 null (du 快路径仅 unix, 行为契约 EC-03; 设计侧同款表述见
|
|
5
|
-
* scan-and-size.md「体积统计」): 探针是 POSIX 绝对路径, 在 win32 上会被解析为「当前盘根」
|
|
6
|
-
* 下的 usr\bin\du, 该盘存在同名外来程序时即被 spawn —— 与被扫目录同盘时构成执行链劫持面;
|
|
7
|
-
* 无 du 平台走纯 JS 候选本就是设计语义, 此处的平台守卫把该语义落到实现。
|
|
8
|
-
* platform 显式传入供测试注入 (win32 宿主不可得)。
|
|
9
|
-
*/
|
|
10
|
-
export declare function findDu(platform?: NodeJS.Platform): string | null;
|
|
11
|
-
/** stdout 与输入集合的一致性判定结果 (解析与判定合一, 供单测注入样本验证) */
|
|
12
|
-
export interface DuOutputAssessment {
|
|
13
|
-
/** 解析出的 路径 → 字节; 仅当 intact 为真时可信 */
|
|
14
|
-
sizes: Map<string, number>;
|
|
15
|
-
/** stdout 与本次输入相符 (无重复、无输入之外的路径): 每条可按下标归因 */
|
|
16
|
-
intact: boolean;
|
|
17
|
-
/** 同一路径出现多行 (行结构可疑) */
|
|
18
|
-
duplicated: boolean;
|
|
19
|
-
/** 出现输入集合之外的路径 (形态被改写或注入) */
|
|
20
|
-
unexpected: boolean;
|
|
21
|
-
}
|
|
22
|
-
/**
|
|
23
|
-
* 解析 du 的 stdout 并判定与输入集合的一致性。
|
|
24
|
-
* 判据是「解析出的路径须全部来自本次输入且无重复」: 任一不符即整批不可信 (fail-safe, 不逐条采信),
|
|
25
|
-
* 因为不符只可能来自输出行结构被破坏 (注入 / 形态改写), 逐条采信会给伪行留下覆盖真实体积的入口。
|
|
26
|
-
*/
|
|
27
|
-
export declare function assessDuOutput(stdout: string, safeTargets: readonly string[]): DuOutputAssessment;
|
|
28
|
-
/**
|
|
29
|
-
* 构造 du 候选。
|
|
30
|
-
* bin 缺省走 findDu() 探针; 显式传入供测试注入 (如用包管理器装的 GNU du 复现 Linux 侧形态),
|
|
31
|
-
* 生产调用不传。
|
|
32
|
-
*/
|
|
33
|
-
export declare function createDuSizer(bin?: string | null): Sizer;
|
package/dist/size-js.d.ts
DELETED