dsh-git-push 2.20.18 → 3.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 +3 -2
- package/cli-tool.mjs +2 -4
- package/cli.mjs +36 -2
- package/lib/app/apply.js +9 -9
- package/lib/app/command-registry.js +44 -20
- package/lib/app/handlers/meta.js +7 -142
- package/lib/app/handlers/npm.js +18 -1
- package/lib/app/handlers/preprocess.js +107 -0
- package/lib/app/handlers/repo-actions.js +2 -2
- package/lib/app/http-handlers.js +25 -12
- package/lib/app/index.js +2 -1
- package/lib/app/inject-text.js +3 -2
- package/lib/app/preprocess-client.js +136 -0
- package/lib/app/repo-ownership.js +1 -1
- package/lib/app/schema.js +3 -3
- package/lib/app/severity.js +14 -0
- package/lib/app/slash-commands.js +5 -164
- package/lib/app/tool-call.js +75 -140
- package/lib/app/tools.js +13 -6
- package/lib/cli/commands-preprocess.mjs +74 -0
- package/lib/cli/commands-tool.mjs +3 -2
- package/lib/cli/commands-vcs.mjs +4 -4
- package/lib/cli/shared.mjs +42 -13
- package/lib/client-parts/git/controller.js +2 -2
- package/lib/client.js +2 -2
- package/lib/commit-push/pre-commit-engine.js +57 -10
- package/lib/commit-push.js +125 -36
- package/lib/{exempt/index.js → git/exempt-markers.js} +8 -1
- package/lib/git/ignore.js +1 -1
- package/lib/git/repos.js +2 -2
- package/lib/git/sensitive.js +1 -1
- package/lib/npm/publish.js +20 -5
- package/lib/plugin/auto-push.js +2 -2
- package/lib/preprocess/providers.js +191 -0
- package/lib/self/index.js +1 -1
- package/lib/skip-dirs.js +14 -55
- package/package.json +29 -37
- package/scripts/build-client.mjs +2 -0
- package/scripts/check.mjs +4 -2
- package/scripts/local-registry.mjs +2 -1
- package/skills/dev/dsh-git-push.md +5 -0
- package/cli-audit.mjs +0 -141
- package/lib/app/audit-api.js +0 -173
- package/lib/app/host-doc-checks.js +0 -25
- package/lib/app/scope-check.js +0 -69
- package/lib/ast/brace.js +0 -120
- package/lib/ast/callgraph.js +0 -135
- package/lib/ast/code-lines.js +0 -175
- package/lib/ast/consts.js +0 -12
- package/lib/ast/control-flow.js +0 -470
- package/lib/ast/credential.js +0 -315
- package/lib/ast/dataflow.js +0 -391
- package/lib/ast/dup-code.js +0 -165
- package/lib/ast/fs-hotspots.js +0 -154
- package/lib/ast/index.js +0 -38
- package/lib/ast/io-risk-const.js +0 -95
- package/lib/ast/io-risk-fn.js +0 -208
- package/lib/ast/io-risk-loop.js +0 -308
- package/lib/ast/io-risk.js +0 -314
- package/lib/ast/lang.js +0 -156
- package/lib/ast/line-count.js +0 -52
- package/lib/ast/magic-number.js +0 -272
- package/lib/ast/naming.js +0 -292
- package/lib/ast/perf.js +0 -488
- package/lib/ast/scope-collisions.js +0 -228
- package/lib/ast/scope.js +0 -241
- package/lib/ast/shell.js +0 -131
- package/lib/ast/size.js +0 -448
- package/lib/ast/symbol-index.js +0 -399
- package/lib/ast/tokenizer.js +0 -421
- package/lib/ast/treesitter.js +0 -413
- package/lib/audit/analysis-coverage.js +0 -98
- package/lib/audit/audit-file.js +0 -205
- package/lib/audit/auditignore-rules.js +0 -148
- package/lib/audit/checks.js +0 -17
- package/lib/audit/client-entry.js +0 -93
- package/lib/audit/collector.js +0 -610
- package/lib/audit/ext-runner.js +0 -80
- package/lib/audit/file-context.js +0 -391
- package/lib/audit/finding.js +0 -101
- package/lib/audit/gitignore-match.js +0 -113
- package/lib/audit/glob.js +0 -63
- package/lib/audit/history-report.js +0 -100
- package/lib/audit/history.js +0 -126
- package/lib/audit/ignore-blind.js +0 -102
- package/lib/audit/index.js +0 -33
- package/lib/audit/orchestrate.js +0 -672
- package/lib/audit/public.js +0 -24
- package/lib/audit/repo-level.js +0 -30
- package/lib/audit/report-yaml.js +0 -90
- package/lib/audit/scope-policy.js +0 -110
- package/lib/audit/slot.js +0 -66
- package/lib/audit-rules/audit-rules-comment.yml +0 -199
- package/lib/audit-rules/audit-rules-cpp.yml +0 -114
- package/lib/audit-rules/audit-rules-csharp.yml +0 -82
- package/lib/audit-rules/audit-rules-docs.yml +0 -32
- package/lib/audit-rules/audit-rules-dsh.yml +0 -177
- package/lib/audit-rules/audit-rules-filehealth.yml +0 -42
- package/lib/audit-rules/audit-rules-folder.yml +0 -99
- package/lib/audit-rules/audit-rules-frontend.yml +0 -335
- package/lib/audit-rules/audit-rules-go.yml +0 -103
- package/lib/audit-rules/audit-rules-i18n.yml +0 -45
- package/lib/audit-rules/audit-rules-java.yml +0 -105
- package/lib/audit-rules/audit-rules-nodejs.yml +0 -662
- package/lib/audit-rules/audit-rules-npm.yml +0 -187
- package/lib/audit-rules/audit-rules-paths.yml +0 -98
- package/lib/audit-rules/audit-rules-performance.yml +0 -245
- package/lib/audit-rules/audit-rules-php.yml +0 -101
- package/lib/audit-rules/audit-rules-private.yml +0 -24
- package/lib/audit-rules/audit-rules-python.yml +0 -106
- package/lib/audit-rules/audit-rules-robustness.yml +0 -31
- package/lib/audit-rules/audit-rules-rust.yml +0 -109
- package/lib/audit-rules/audit-rules-structure.yml +0 -158
- package/lib/audit-rules/audit-rules-swift.yml +0 -99
- package/lib/audit-rules/audit-rules-template.yml +0 -108
- package/lib/audit-ui-sdk/contract.js +0 -117
- package/lib/audit-ui-sdk/index.js +0 -17
- package/lib/checks/button-bind.js +0 -347
- package/lib/checks/common.js +0 -170
- package/lib/checks/credential-file.js +0 -43
- package/lib/checks/dataflow.js +0 -40
- package/lib/checks/dispatch.js +0 -117
- package/lib/checks/dup-code.js +0 -69
- package/lib/checks/dup-const.js +0 -232
- package/lib/checks/file-health.js +0 -150
- package/lib/checks/filter.js +0 -137
- package/lib/checks/folder.js +0 -173
- package/lib/checks/fs-scanner.js +0 -57
- package/lib/checks/hardcoded-path.js +0 -98
- package/lib/checks/index.js +0 -49
- package/lib/checks/io.js +0 -66
- package/lib/checks/magic-number.js +0 -42
- package/lib/checks/npm-json.js +0 -273
- package/lib/checks/private.js +0 -64
- package/lib/checks/regex.js +0 -298
- package/lib/checks/scope-collision.js +0 -68
- package/lib/checks/semantic.js +0 -134
- package/lib/checks/structural.js +0 -281
- package/lib/cli/commands-audit.mjs +0 -142
- package/lib/cli/commands-doc.mjs +0 -127
- package/lib/client-parts/audit/audit.js +0 -301
- package/lib/exempt/tool.js +0 -198
- package/lib/git/module-splitter.js +0 -47
- package/lib/link-check/index.js +0 -187
- package/lib/lint-adapter/detect.js +0 -161
- package/lib/lint-adapter/index.js +0 -50
- package/lib/lint-adapter/runner.js +0 -133
- package/lib/rule/compilers/credential.js +0 -62
- package/lib/rule/compilers/dataflow.js +0 -38
- package/lib/rule/compilers/file-health.js +0 -75
- package/lib/rule/compilers/frontend.js +0 -86
- package/lib/rule/compilers/func.js +0 -35
- package/lib/rule/compilers/helpers.js +0 -71
- package/lib/rule/compilers/index.js +0 -29
- package/lib/rule/compilers/link-semantic.js +0 -45
- package/lib/rule/compilers/list-kinds.js +0 -12
- package/lib/rule/compilers/numeric-kinds.js +0 -73
- package/lib/rule/compilers/regex.js +0 -78
- package/lib/rule/compilers/structure.js +0 -107
- package/lib/rule/compilers.js +0 -17
- package/lib/rule/homoglyph.js +0 -45
- package/lib/rule/loader.js +0 -274
- package/lib/rule/registry.js +0 -122
- package/lib/rule/scope.js +0 -67
- package/lib/score/docs-score.js +0 -166
- package/lib/score/index.js +0 -234
- package/scripts/__pycache__/module-splitter.cpython-38.pyc +0 -0
- package/scripts/audit-ext/_example-readme-present.mjs +0 -34
- package/scripts/audit-ext/dsh-inject-declarations.mjs +0 -209
- package/scripts/audit-ext/variable-min-length.mjs +0 -102
- package/scripts/audit-gate.mjs +0 -235
- package/scripts/audit-runner.mjs +0 -35
- package/scripts/audit-runtime-check.mjs +0 -129
- package/scripts/browser-page-probe.mjs +0 -271
- package/scripts/check-js-scope.mjs +0 -87
- package/scripts/clean-date-comments.py +0 -102
- package/scripts/cpu-sample.mjs +0 -188
- package/scripts/doc-drift.mjs +0 -200
- package/scripts/hot-path-probe-cjs.cjs +0 -71
- package/scripts/hot-path-probe-fs-shim.mjs +0 -28
- package/scripts/hot-path-probe-fsp-shim.mjs +0 -31
- package/scripts/hot-path-probe.mjs +0 -153
- package/scripts/module-splitter.py +0 -800
- package/scripts/picker-repro.mjs +0 -115
- package/scripts/platform-scan.mjs +0 -168
- package/scripts/probe-recheck.mjs +0 -47
- package/scripts/rename-locator.mjs +0 -97
- package/scripts/rule-switch.mjs +0 -97
- package/scripts/rules-solo-audit.mjs +0 -173
- package/scripts/scan-file-io.mjs +0 -717
- package/scripts/scan-fs-hotspots.mjs +0 -107
- package/scripts/symbol-index.mjs +0 -85
- package/scripts/verify-prestep.mjs +0 -100
- package/skills/dev/audit-rule-authoring.md +0 -58
- package/skills/guide/guide-audit.md +0 -270
- /package/lib/{audit → app}/ownership.js +0 -0
- /package/lib/app/{schema-audit.js → schema-preprocess.js} +0 -0
- /package/lib/{audit-defaults.js → git/defaults.js} +0 -0
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
// 进程契约**:跑一条命令、看退出码、解析一行 JSON。这样 Python / Go / Rust 写的引擎
|
|
6
6
|
// 只要满足契约就能顶替,git 侧一行不用改。
|
|
7
7
|
//
|
|
8
|
-
//
|
|
8
|
+
// 契约(完整定义见预处理实现 CLI 头部与 docs/ 下的「提交前预处理与审计引擎解耦方案」):
|
|
9
9
|
// stdout : 一行 JSON { ok, scope, summary, quality, findings, files }
|
|
10
10
|
// 退出码 : 0 = 无 blocker / 1 = 有 blocker / 2 = 执行失败
|
|
11
11
|
// 超时 : 达到 timeoutMs 一律按「执行失败」处理
|
|
@@ -29,7 +29,21 @@ import { PRE_COMMIT_TIMEOUT_MS_DEFAULT } from '../app/constants.js';
|
|
|
29
29
|
export { PRE_COMMIT_TIMEOUT_MS_DEFAULT };
|
|
30
30
|
|
|
31
31
|
/** 内置轻量入口(相对插件根)。配置留空时用它。 */
|
|
32
|
-
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* 审计实现所属包名(拆包后审计实现在 `audit-sluice`)。
|
|
36
|
+
* 为什么单独一个常量:入口解析、错误提示、将来 npm 依赖安装后的路径都引用它,避免多处手写字符串。
|
|
37
|
+
*/
|
|
38
|
+
|
|
39
|
+
/** 预处理实现的 CLI 入口(相对包根)。 */
|
|
40
|
+
export const PREPROCESS_CLI_REL = 'cli.mjs';
|
|
41
|
+
|
|
42
|
+
// 注意:这里不再写死具体实现的包名——包名属于 provider 定义(lib/preprocess/providers.js),
|
|
43
|
+
// 通用层只通过 provider 抽象拿它。将来换/加 provider 不需要改本文件。
|
|
44
|
+
import { resolveGateProvider, getProviderDefinition, DEFAULT_PROVIDER_ID } from '../preprocess/providers.js';
|
|
45
|
+
|
|
46
|
+
export { resolveGateProvider };
|
|
33
47
|
|
|
34
48
|
/** 错误信息里保留的 stderr 尾部字符数:够定位(栈尾通常在最后),又不至于把上下文刷爆。 */
|
|
35
49
|
export const STDERR_TAIL_CHARS = 2000;
|
|
@@ -37,7 +51,7 @@ export const STDERR_TAIL_CHARS = 2000;
|
|
|
37
51
|
/** stdout 收集上限(64MB):findings 全量在大仓可达数 MB,超这个量级说明契约跑偏,宁可报错。 */
|
|
38
52
|
export const STDOUT_MAX_BYTES = 64 * 1024 * 1024;
|
|
39
53
|
|
|
40
|
-
/**
|
|
54
|
+
/** 契约退出码(与预处理实现 CLI 的 EXIT_* 常量对应)。 */
|
|
41
55
|
export const ENGINE_EXIT_OK = 0;
|
|
42
56
|
export const ENGINE_EXIT_BLOCKED = 1;
|
|
43
57
|
export const ENGINE_EXIT_FAILED = 2;
|
|
@@ -75,13 +89,22 @@ export function resolvePreCommitConfig(cfg = {}) {
|
|
|
75
89
|
? raw.args.map((rawArg) => String(rawArg)).filter((rawArg) => rawArg !== '')
|
|
76
90
|
: [];
|
|
77
91
|
// 内置默认只在「command 与 args 都没配」时生效:
|
|
78
|
-
// · command 空 + args 空 → node +
|
|
92
|
+
// · command 空 + args 空 → node + 预处理实现 CLI
|
|
79
93
|
// · command 空 + args 有值 → node + 配置里给的引擎脚本(args 里相对路径按插件根解析)
|
|
80
94
|
// · command 有值 + args 空 → 那是一个独立可执行文件(Go/Rust 单二进制就是这种形态,
|
|
81
95
|
// 此时**不能**塞我们自己的脚本路径进去)
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
96
|
+
// 缺省引擎 = 预处理实现 CLI(拆包后审计实现归 audit-sluice);
|
|
97
|
+
// 显式配置 command/args 时仍以配置为准(回滚与自定义引擎都走这条)。
|
|
98
|
+
let args = configuredArgs;
|
|
99
|
+
if (!command && configuredArgs.length === 0) {
|
|
100
|
+
const entry = resolveGateProvider();
|
|
101
|
+
// 解析失败也把"期望的路径"放进 args:真正的失败在 spawn 前由 runPreCommitEngine 报出,
|
|
102
|
+
// 错误信息里带上具体查过哪些路径(否则用户只看到"命令不存在",不知道该怎么办)。
|
|
103
|
+
args = entry.ok ? [entry.path] : [join(pluginRootDir(), '..', getProviderDefinition(DEFAULT_PROVIDER_ID).packageName, PREPROCESS_CLI_REL)];
|
|
104
|
+
}
|
|
105
|
+
// 是否仍是「内置旧引擎」(显式指回 plugins 自带 预处理实现 CLI 的回滚路径):
|
|
106
|
+
// 旧引擎不认 --visibility/--exempt-paths,也不会返回 blocked —— 传了会直接 exit 2。
|
|
107
|
+
// 两条路径都保留可用,才能做到「切调用但可回滚」。
|
|
85
108
|
const rawTimeout = Number(raw?.timeoutMs);
|
|
86
109
|
// 超时必须是正有限数:0 / 负数 / NaN 一律退回默认(0 表示「立刻超时」会让门禁永远失败)
|
|
87
110
|
const timeoutMs = Number.isFinite(rawTimeout) && rawTimeout > 0 ? Math.floor(rawTimeout) : PRE_COMMIT_TIMEOUT_MS_DEFAULT;
|
|
@@ -212,7 +235,8 @@ function toSlotCsv(slots) {
|
|
|
212
235
|
* @returns {string[]}
|
|
213
236
|
*/
|
|
214
237
|
export function buildEngineArgs({
|
|
215
|
-
args = [], repoPath = '', scope = 'diff', rulesetDir = '', weights = {}, maxScanFiles, slots = [], disabledSlots = [],
|
|
238
|
+
args = [], repoPath = '', scope = 'diff', rulesetDir = '', weights = {}, maxScanFiles, slots = [], disabledSlots = [],
|
|
239
|
+
blockersOnly = false, visibility = '', exemptPaths = [], exemptReason = '',
|
|
216
240
|
} = {}) {
|
|
217
241
|
const argv = [...resolveEngineArgs(args)];
|
|
218
242
|
argv.push('--repo', String(repoPath || '.'));
|
|
@@ -226,6 +250,15 @@ export function buildEngineArgs({
|
|
|
226
250
|
if (whiteListCsv) argv.push('--slots', whiteListCsv);
|
|
227
251
|
const blackListCsv = toSlotCsv(disabledSlots);
|
|
228
252
|
if (blackListCsv) argv.push('--disabled-slots', blackListCsv);
|
|
253
|
+
// 新参数只传给「新引擎」(预处理实现):内置旧引擎不认这些 flag,传了会直接 exit 2。
|
|
254
|
+
// 可见性:只有明确知道时才传(unknown 是引擎缺省,传了也一样);
|
|
255
|
+
// 私有库豁免由预处理实现自己判(它是权威),gitpush 只负责探测后把结论传过去。
|
|
256
|
+
if (visibility === 'private' || visibility === 'public') argv.push('--visibility', visibility);
|
|
257
|
+
// 临时豁免:**参数名映射** —— 工具参数叫 auditExemptPaths/auditExemptReason,
|
|
258
|
+
// 预处理实现 CLI 叫 --exempt-paths/--exempt-reason(独立包不需要 audit- 前缀)。
|
|
259
|
+
const exemptCsv = toSlotCsv(exemptPaths);
|
|
260
|
+
if (exemptCsv) argv.push('--exempt-paths', exemptCsv);
|
|
261
|
+
if (exemptReason) argv.push('--exempt-reason', String(exemptReason));
|
|
229
262
|
if (blockersOnly) argv.push('--blockers-only');
|
|
230
263
|
argv.push('--json');
|
|
231
264
|
return argv;
|
|
@@ -352,13 +385,27 @@ function runEngineProcess({ command, args, timeoutMs }) {
|
|
|
352
385
|
*/
|
|
353
386
|
export async function runPreCommitEngine({
|
|
354
387
|
repoPath = '.', scope = 'diff', rulesetDir = '', weights = {}, maxScanFiles, slots = [], disabledSlots = [],
|
|
355
|
-
blockersOnly = false, cfg = {}, timeoutMs,
|
|
388
|
+
blockersOnly = false, cfg = {}, timeoutMs, visibility = '', exemptPaths = [], exemptReason = '',
|
|
356
389
|
} = {}) {
|
|
357
390
|
const spec = resolvePreCommitConfig(cfg);
|
|
391
|
+
// 预处理实现是**可热插拔的扩展能力**:不在位时不该拦住提交,而应当「跳过审计并明确标注」。
|
|
392
|
+
// 这正是解耦的目标——拔掉扩展,主流程照常;插上扩展,能力自动回来。
|
|
393
|
+
// 注意:这里返回的是「跳过」而不是「静默通过」,调用方能拿到 preprocessSkipped 与原因。
|
|
394
|
+
if (!spec.command && spec.args.length === 1 && !existsSync(spec.args[0])) {
|
|
395
|
+
const entry = resolveGateProvider();
|
|
396
|
+
return {
|
|
397
|
+
ok: true,
|
|
398
|
+
audit: null,
|
|
399
|
+
preprocessSkipped: 'package-not-found',
|
|
400
|
+
skipReason: entry.ok ? '预处理实现不可用' : entry.error,
|
|
401
|
+
engine: { command: '', args: [], exitCode: null, timedOut: false },
|
|
402
|
+
};
|
|
403
|
+
}
|
|
358
404
|
const resolved = resolveEngineCommand(spec.command);
|
|
405
|
+
// 显式配置的引擎命令不可用 ⇒ 这是配置错误(不是「扩展不在位」),仍然 fail-closed
|
|
359
406
|
if (!resolved.ok) return failClosed(`提交前预处理失败:${resolved.error}(未执行任何 git 操作;修复 preCommit.command 后重试)`);
|
|
360
407
|
const command = resolved.command;
|
|
361
|
-
const args = buildEngineArgs({ args: spec.args, repoPath, scope, rulesetDir, weights, maxScanFiles, slots, disabledSlots, blockersOnly });
|
|
408
|
+
const args = buildEngineArgs({ args: spec.args, repoPath, scope, rulesetDir, weights, maxScanFiles, slots, disabledSlots, blockersOnly, visibility, exemptPaths, exemptReason });
|
|
362
409
|
const commandLine = formatCommandLine(command, args);
|
|
363
410
|
const effectiveTimeout = Number.isFinite(Number(timeoutMs)) && Number(timeoutMs) > 0
|
|
364
411
|
? Math.floor(Number(timeoutMs))
|
package/lib/commit-push.js
CHANGED
|
@@ -8,20 +8,49 @@
|
|
|
8
8
|
* 自动推送带审计门禁(blocker 拦截 + 敏感扫描 + .gitignore),不再裸 commit+push
|
|
9
9
|
* 返回结构含 audit 摘要,调用方(工具/外部插件)可据此判断「被阻断」。
|
|
10
10
|
*/
|
|
11
|
-
|
|
11
|
+
// 审计的结果文案改由「预处理能力」渲染(lib/preprocess/):git 侧只留兜底逻辑与中性默认文案。
|
|
12
|
+
// 为什么 git 侧不再自己生成这份指引:那是**审计措辞**(查询用哪个 API、明细去哪看),
|
|
13
|
+
// 属于审计预处理自己的语义,搬进 lib/preprocess/audit.js 的 renderResult 里。
|
|
14
|
+
import * as auditClient from './app/preprocess-client.js';
|
|
12
15
|
|
|
13
16
|
// 审计内核(auditWithScope / scoreQuality)不再在本文件直接 import —— 提交门禁改为
|
|
14
17
|
// 调「可配置的审计引擎子进程」(lib/commit-push/pre-commit-engine.js),这是解耦点:
|
|
15
18
|
// 换引擎(含换语言重写)只改配置,git 侧零改动。
|
|
16
|
-
// ⚠️
|
|
19
|
+
// ⚠️ 文档漂移检查器的接线也随之搬进引擎入口(审计包 CLI 里 import 一次);
|
|
17
20
|
// 宿主自己的工具/HTTP 侧仍由 lib/app/tool-call.js 接线,不依赖本文件。
|
|
18
21
|
import { runPreCommitEngine } from './commit-push/pre-commit-engine.js';
|
|
19
22
|
import { commitAndPush } from './git/index.js';
|
|
20
23
|
import { defaultConfig } from './client/index.js';
|
|
21
|
-
import { MAX_MSG_PREVIEW } from './app/constants.js';
|
|
22
|
-
import { isSampleExemptDir } from './exempt/index.js';
|
|
23
24
|
import { resolveRepoVisibility } from './git/index.js';
|
|
24
25
|
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* 预处理渲染的**兜底文案**(刻意留在 git 侧)。
|
|
29
|
+
*
|
|
30
|
+
* 为什么在 git 侧而不是预处理里:预处理可能不可用、没实现 `renderResult`、甚至渲染时抛错,
|
|
31
|
+
* 这时代码仍在 git 侧往下走 —— 兜底是 git 侧的安全网,不能依赖被兜底对象自己提供。
|
|
32
|
+
* 为什么措辞中性(写「提交前检查」而不是「审计」):具体措辞属预处理的语义,
|
|
33
|
+
* 已搬进 lib/preprocess/audit.js;这里只保证「有 blocker 时能说清是哪几处」。
|
|
34
|
+
* @param {object} ctx 与 renderPreprocessResult 同一个 ctx
|
|
35
|
+
* @returns {{error?: string, apiGuide: string, notes: {exempt: string, privateExempt: string}}}
|
|
36
|
+
*/
|
|
37
|
+
export function defaultPreprocessRender(ctx = {}) {
|
|
38
|
+
const blocked = Array.isArray(ctx.blocked) ? ctx.blocked : [];
|
|
39
|
+
const list = blocked.map((finding) => {
|
|
40
|
+
const where = finding.file ? ` ${finding.file}` + (finding.line ? `:${finding.line}` : '') : '';
|
|
41
|
+
const why = finding.rule || finding.message || '';
|
|
42
|
+
return where + (why ? `(${why})` : '');
|
|
43
|
+
});
|
|
44
|
+
return {
|
|
45
|
+
error: blocked.length ? `提交前检查拦截:${blocked.length} 项 → ${list.join(';')}` : undefined,
|
|
46
|
+
apiGuide: '',
|
|
47
|
+
notes: {
|
|
48
|
+
exempt: '本次提交的临时豁免(不落盘、不影响后续提交)',
|
|
49
|
+
privateExempt: '私有库:检查结果只报告不拦截',
|
|
50
|
+
},
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
|
|
25
54
|
/**
|
|
26
55
|
* 同步执行审计门禁(不跑 git)。供 git_commit_push 后台化方案复用:审计同步即时
|
|
27
56
|
* 拦截,通过后再把 commit+push 丢后台。返回 { ok, blocked?, error?, audit }。
|
|
@@ -31,7 +60,15 @@ import { resolveRepoVisibility } from './git/index.js';
|
|
|
31
60
|
* (README「④ 私有库豁免」);缺省按 origin 探测,探测失败按 unknown(保守拦截)。
|
|
32
61
|
* 显式传入可免网络探测(测试/已知场景)。
|
|
33
62
|
*/
|
|
34
|
-
export async function runAudit({
|
|
63
|
+
export async function runAudit({
|
|
64
|
+
repoPath = '', audit, rulesetDir, slots, cfg: extCfg, visibility: extVisibility,
|
|
65
|
+
auditExemptPaths = [], auditExemptReason = '',
|
|
66
|
+
...unknownKeys // 未知参数一律报错:
|
|
67
|
+
}) { // 参数名与工具参数(auditExemptPaths 等)曾不一致,
|
|
68
|
+
const unknown = Object.keys(unknownKeys); // 传错名过去是**静默无效且不报错**(实测踩到),
|
|
69
|
+
if (unknown.length) { // 这个校验把它变成立刻可见的错误。
|
|
70
|
+
throw new Error(`runAudit 收到未知参数:${unknown.join(', ')}(可用:repoPath/audit/rulesetDir/slots/cfg/visibility/auditExemptPaths/auditExemptReason)`);
|
|
71
|
+
}
|
|
35
72
|
const cfg = extCfg || defaultConfig();
|
|
36
73
|
const doAudit = audit ?? cfg.auditEnabled;
|
|
37
74
|
if (!doAudit) return { ok: true, audit: null };
|
|
@@ -61,11 +98,28 @@ export async function runAudit({ repoPath = '', audit, rulesetDir, slots, cfg: e
|
|
|
61
98
|
maxScanFiles: cfg.maxScanFiles,
|
|
62
99
|
slots: slotOrder,
|
|
63
100
|
disabledSlots: Array.isArray(cfg.auditDisabledSlots) ? cfg.auditDisabledSlots : [],
|
|
101
|
+
// 可见性:显式传入时直接给引擎;未传则留空(引擎按 unknown 保守处理,gitpush 稍后按需探测)
|
|
102
|
+
visibility: extVisibility,
|
|
103
|
+
// 临时豁免:**参数名映射**(工具参数 auditExemptPaths → 审计包 --exempt-paths)
|
|
104
|
+
exemptPaths: Array.isArray(auditExemptPaths) ? auditExemptPaths : [],
|
|
105
|
+
exemptReason: auditExemptReason || '',
|
|
64
106
|
cfg,
|
|
65
107
|
});
|
|
66
108
|
// 引擎不可用(崩/超时/退出码 2/输出不合契约)一律 fail-closed:拒绝提交并给出可诊断原因。
|
|
67
109
|
// 绝不在这里「当作没有 blocker 放行」——那等于把红线交给「恰好没跑起来」。
|
|
110
|
+
// 例外:预处理实现不在位(preprocessSkipped)——那是「扩展没插」,不是「引擎坏了」。
|
|
111
|
+
// 按热插拔语义放行主流程,但必须把「本次未做预处理」透出给调用方(不静默)。
|
|
112
|
+
// 字段名刻意用 preprocess* 而不是 audit*:预处理是通用机制,审计只是它的一个实现。
|
|
68
113
|
if (!engineRes.ok) return { ok: false, blocked: false, error: engineRes.error, audit: null };
|
|
114
|
+
if (engineRes.preprocessSkipped) {
|
|
115
|
+
return {
|
|
116
|
+
ok: true,
|
|
117
|
+
blocked: false,
|
|
118
|
+
audit: null,
|
|
119
|
+
preprocessSkipped: engineRes.preprocessSkipped,
|
|
120
|
+
skipReason: engineRes.skipReason || '',
|
|
121
|
+
};
|
|
122
|
+
}
|
|
69
123
|
const engineAudit = engineRes.audit || {};
|
|
70
124
|
const findings = Array.isArray(engineAudit.findings) ? engineAudit.findings : [];
|
|
71
125
|
const auditOut = {
|
|
@@ -79,31 +133,69 @@ export async function runAudit({ repoPath = '', audit, rulesetDir, slots, cfg: e
|
|
|
79
133
|
blocked: engineRes.engine?.exitCode === 1,
|
|
80
134
|
},
|
|
81
135
|
};
|
|
82
|
-
//
|
|
83
|
-
//
|
|
84
|
-
|
|
85
|
-
//
|
|
86
|
-
//
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
136
|
+
// ── 拦截结论:**直接用审计包的**(拆包后它才是权威)──
|
|
137
|
+
// 豁免四类(代码标记 / 测试夹具 / 示例目录 / 临时豁免)加私有库降级都在包内完成,
|
|
138
|
+
// gitpush 这层不再重复实现一遍 —— 两份实现并存时最危险的是「某一天两边算得不一样」,
|
|
139
|
+
// 而那时门禁到底拦不拦取决于走了哪条分支,几乎无法排查。
|
|
140
|
+
// 拦截结论**只认审计包的**:宿主不再有第二套豁免/拦截实现(回滚路径已随旧引擎删除)
|
|
141
|
+
auditOut.blocked = Array.isArray(engineAudit.blocked) ? engineAudit.blocked : [];
|
|
142
|
+
// 示例目录豁免条数(summary.blocker 与 blocked 的差值来源之一),原样透传供排查
|
|
143
|
+
if (Number.isFinite(Number(engineAudit.sampleExemptCount))) auditOut.sampleExemptCount = Number(engineAudit.sampleExemptCount);
|
|
144
|
+
// exempt 回显:新引擎(审计包)自己给;回滚路径(内置旧引擎)这里保底构造,
|
|
145
|
+
// 语义与切包前一致(记录而非判断:豁免了哪些文件、命中哪些规则、共几条 finding)。
|
|
146
|
+
if (engineAudit.exempt) {
|
|
147
|
+
auditOut.exempt = engineAudit.exempt;
|
|
148
|
+
} else {
|
|
149
|
+
const exemptSet = new Set((Array.isArray(auditExemptPaths) ? auditExemptPaths : [])
|
|
150
|
+
.map((value) => String(value || '').replace(/\\/g, '/').replace(/^\.\//, '').trim())
|
|
151
|
+
.filter(Boolean));
|
|
152
|
+
if (exemptSet.size) {
|
|
153
|
+
const isExemptFile = (finding) => exemptSet.has(String(finding.file || '').replace(/\\/g, '/').replace(/^\.\//, ''));
|
|
154
|
+
const exemptFindings = findings.filter(isExemptFile);
|
|
155
|
+
auditOut.exempt = {
|
|
156
|
+
files: [...exemptSet],
|
|
157
|
+
count: exemptFindings.length,
|
|
158
|
+
rules: [...new Set(exemptFindings.map((finding) => finding.rule).filter(Boolean))],
|
|
159
|
+
...(auditExemptReason ? { reason: String(auditExemptReason) } : {}),
|
|
160
|
+
};
|
|
161
|
+
}
|
|
105
162
|
}
|
|
106
|
-
if (
|
|
163
|
+
if (engineAudit.privateExempt) {
|
|
164
|
+
auditOut.privateExempt = engineAudit.privateExempt;
|
|
165
|
+
// 私有库时审计包把结论归零(blocked: [],理由见批 B 契约);但**对外形态保持旧样**:
|
|
166
|
+
// `audit.blocked` 历来是「报告用的原始清单」(audit-api / code_audit / 报告都读它),
|
|
167
|
+
// 归零会让这些消费方以为「这个私有库一条问题都没有」,丢掉「本来有几条会拦」的可观测性。
|
|
168
|
+
// 拦截结论由 `ok` / `blocked` 布尔表达(私有库恒 false/true),清单只作报告。
|
|
169
|
+
if (!Array.isArray(engineAudit.blocked) || engineAudit.blocked.length === 0) {
|
|
170
|
+
// 私有库时包把 blocked 归零,但报告形态仍给原始清单(租户侧读取 audit.blocked 展示)
|
|
171
|
+
auditOut.blocked = findings.filter((f) => f.severity === 'blocker' || f.severity === 'error')
|
|
172
|
+
.map((f) => ({ file: f.file, line: f.line, rule: f.rule, message: String(f.message || '').slice(0, 80) }));
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
const blocked = auditOut.blocked;
|
|
176
|
+
|
|
177
|
+
// ── 结果文案:交给「可用预处理」渲染,git 侧只保留兜底 ──
|
|
178
|
+
// 数据契约(ctx):repoPath + audit{summary,quality,findings,scope,files} + blocked + exempt
|
|
179
|
+
// 兜底:预处理不可用 / 没实现 renderResult / 渲染抛错 时用中性默认(defaultRenderResult),
|
|
180
|
+
// 保证「预处理不给也不崩」——但默认文案刻意不含审计措辞(那属预处理语义)。
|
|
181
|
+
const renderCtx = {
|
|
182
|
+
repoPath,
|
|
183
|
+
audit: {
|
|
184
|
+
summary: engineAudit.summary,
|
|
185
|
+
quality: auditOut.quality,
|
|
186
|
+
findings,
|
|
187
|
+
scope: engineAudit.scope,
|
|
188
|
+
files: engineAudit.files,
|
|
189
|
+
},
|
|
190
|
+
blocked: auditOut.blocked,
|
|
191
|
+
...(auditOut.exempt ? { exempt: auditOut.exempt } : {}),
|
|
192
|
+
};
|
|
193
|
+
const fallbackRender = defaultPreprocessRender(renderCtx);
|
|
194
|
+
const rendered = await (async () => { try { const api = await auditClient.hostApi(); return api.renderAuditResult(renderCtx, cfg); } catch { return undefined; } })();
|
|
195
|
+
auditOut.apiGuide = rendered?.apiGuide ?? fallbackRender.apiGuide;
|
|
196
|
+
if (auditOut.exempt) auditOut.exempt.note = rendered?.notes?.exempt ?? fallbackRender.notes.exempt;
|
|
197
|
+
|
|
198
|
+
if (blocked.length > 0 && !auditOut.privateExempt) {
|
|
107
199
|
// 【修复】私有库豁免(README「④ 私有库豁免」):远端可见性 = private → 审计只报告不拦截。
|
|
108
200
|
// 修复背景:私有库被拦的回归——
|
|
109
201
|
// 此前拦截判定只看「示例目录」、没有可见性分级,
|
|
@@ -124,19 +216,16 @@ export async function runAudit({ repoPath = '', audit, rulesetDir, slots, cfg: e
|
|
|
124
216
|
auditOut.privateExempt = {
|
|
125
217
|
visibility,
|
|
126
218
|
blockedCount: blocked.length,
|
|
127
|
-
note:
|
|
219
|
+
note: rendered?.notes?.privateExempt ?? fallbackRender.notes.privateExempt,
|
|
128
220
|
};
|
|
129
221
|
return { ok: true, audit: auditOut };
|
|
130
222
|
}
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
const why = f.rule || f.message || '';
|
|
134
|
-
return where + (why ? `(${why})` : '');
|
|
135
|
-
});
|
|
223
|
+
// 拦截文案由预处理渲染(含「几个 blocker + 逐条位置原因」);
|
|
224
|
+
// `blocked: true` 这个**布尔**留在 git 侧——它决定 job 状态分叉(被拦截 ≠ 执行失败)。
|
|
136
225
|
return {
|
|
137
226
|
ok: false,
|
|
138
227
|
blocked: true,
|
|
139
|
-
error:
|
|
228
|
+
error: rendered?.error ?? fallbackRender.error ?? `提交前检查拦截:${blocked.length} 项`,
|
|
140
229
|
audit: auditOut,
|
|
141
230
|
};
|
|
142
231
|
}
|
|
@@ -1,4 +1,11 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* 豁免标记与目录判定的**宿主侧快照**(权威定义在审计包 lib/exempt/index.js)。
|
|
3
|
+
*
|
|
4
|
+
* 为什么需要快照:git 侧的 .gitignore 与敏感文件扫描在**同步**路径上要判「某标记能否豁免该 finding」
|
|
5
|
+
* 以及「该目录是否示例/测试夹具」,而审计包只能异步加载。整文件复制而非零散搬运——
|
|
6
|
+
* 零散搬运漏一个私有辅助函数就会在运行时炸(本文件第一版就因为漏了缓存辅助而报错)。
|
|
7
|
+
* 由 test/git/test-exempt-markers-parity.mjs 对拍:包与快照行为分叉即红。
|
|
8
|
+
*/
|
|
2
9
|
import { join, resolve, dirname, sep } from 'node:path';
|
|
3
10
|
import { statSync } from 'node:fs';
|
|
4
11
|
/**
|
package/lib/git/ignore.js
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
import { existsSync, readFileSync, writeFileSync } from 'node:fs';
|
|
8
8
|
import { join } from 'node:path';
|
|
9
|
-
import { isSampleExemptDir } from '
|
|
9
|
+
import { isSampleExemptDir } from './exempt-markers.js';
|
|
10
10
|
import { scanSensitiveFiles } from './sensitive.js';
|
|
11
11
|
|
|
12
12
|
/**
|
package/lib/git/repos.js
CHANGED
|
@@ -11,8 +11,8 @@ import { runGit, runGitAsync } from './exec.js';
|
|
|
11
11
|
|
|
12
12
|
/* ───────── 仓库扫描常量 ───────── */
|
|
13
13
|
const LS_IGNORED_TIMEOUT_MS = 15_000; // git ls-files --ignored 超时
|
|
14
|
-
// 扫描下钻深度默认值:与 lib/plugin/auto-push.js 共用同一来源(lib/
|
|
15
|
-
import { DEFAULT_SCAN_DEPTH } from '
|
|
14
|
+
// 扫描下钻深度默认值:与 lib/plugin/auto-push.js 共用同一来源(lib/git/defaults.js)
|
|
15
|
+
import { DEFAULT_SCAN_DEPTH } from './defaults.js';
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* 扫描目录下的 git 仓库(1.0.0 接线:git_scan 工具用)。
|
package/lib/git/sensitive.js
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
import { readFile, readdir, stat } from 'node:fs/promises';
|
|
10
10
|
import { join } from 'node:path';
|
|
11
|
-
import { isTestExemptDir } from '
|
|
11
|
+
import { isTestExemptDir } from './exempt-markers.js';
|
|
12
12
|
import { getSkipSet } from '../skip-dirs.js';
|
|
13
13
|
|
|
14
14
|
/* ───────────────────────── 敏感文件自动 .gitignore ───────────────────────── */
|
package/lib/npm/publish.js
CHANGED
|
@@ -7,12 +7,13 @@
|
|
|
7
7
|
* ③ 真发前先体检:`private:true` 拦截、同名版本占用检测、`npm pack --dry-run` 文件清单。
|
|
8
8
|
* 凭据:一律 `--userconfig` 指向插件物化的 0600 npmrc(不碰用户全局 ~/.npmrc、token 不进仓库)。
|
|
9
9
|
*/
|
|
10
|
-
import { appendFileSync, existsSync, readFileSync, statSync } from 'node:fs';
|
|
10
|
+
import { appendFileSync, existsSync, mkdtempSync, readFileSync, statSync, writeFileSync } from 'node:fs';
|
|
11
|
+
import { tmpdir } from 'node:os';
|
|
11
12
|
import { join } from 'node:path';
|
|
12
13
|
|
|
13
14
|
import { credentialsDir, readNpmToken } from '../core/credentials.js';
|
|
14
15
|
import { DEFAULT_REGISTRY, NPM_TIMEOUT_MS, normalizeRegistry, runNpm } from './registry.js';
|
|
15
|
-
import { npmArgs, writeNpmrc } from './npmrc.js';
|
|
16
|
+
import { npmArgs, npmrcText, writeNpmrc } from './npmrc.js';
|
|
16
17
|
import { smokeTestPackage, entrySpecsOf, isBrowserEntry, classifyPackageForm } from './smoke.js';
|
|
17
18
|
import { runLocalPreview } from './local-registry.js';
|
|
18
19
|
|
|
@@ -109,7 +110,14 @@ export function parsePackOutput(text = '', { maxCandidates = 200 } = {}) {
|
|
|
109
110
|
export function packDryRun({ dir, registry = DEFAULT_REGISTRY, workspaceRoot = '', token = '', timeoutMs = PUBLISH_TIMEOUT_MS } = {}) {
|
|
110
111
|
try {
|
|
111
112
|
const merged = { ...process.env };
|
|
112
|
-
|
|
113
|
+
// **不能写真实凭据目录的 npmrc**:writeNpmrc 写的是 credentialsDir 下的**持久**文件,
|
|
114
|
+
// 而本函数只是「预演」——用预演覆盖真实 npmrc 会把用户的真 token 冲掉。
|
|
115
|
+
// 实测事故:本地彩排跑完后 npmrc 变成临时 token(11 字符)⇒ 之后所有 npm 命令 401。
|
|
116
|
+
// 预演只需要一份**临时** npmrc,写到临时目录、用完即弃。
|
|
117
|
+
const tempDir = mkdtempSync(join(tmpdir(), 'dshgp-pack-'));
|
|
118
|
+
const tempRc = join(tempDir, '.npmrc');
|
|
119
|
+
writeFileSync(tempRc, npmrcText({ registry, token }), { mode: 0o600 });
|
|
120
|
+
const rc = { ok: true, file: tempRc };
|
|
113
121
|
if (!rc.ok) return { ok: false, error: rc.error || 'npmrc 写入失败' };
|
|
114
122
|
// cwd 必须显式给:npm pack 以「工作目录」为目标包,继承宿主 cwd 会去错目录
|
|
115
123
|
// (实测:宿主 cwd 无 package.json ⇒ ENOENT;有 ⇒ 打包整棵树 ⇒ ENOBUFS)
|
|
@@ -184,8 +192,15 @@ export async function publishPackage({
|
|
|
184
192
|
// 体检①:private:true 会被 npm 拒绝(提前给结论,省一次网络)
|
|
185
193
|
if (info.private) return { ok: false, blocked: 'private-true', name: info.name, version: info.version, error: 'package.json 标了 private:true ⇒ npm publish 会被拒绝(去掉该字段或改用私有 registry)' };
|
|
186
194
|
// 体检②:同名版本是否已存在
|
|
187
|
-
|
|
188
|
-
|
|
195
|
+
// **网络边界**:这一步是 GET 真实上游 registry(只读,不写入)。
|
|
196
|
+
// localPreview=true 时**跳过**——本地 registry 是空的,「版本占用」无从判断也无意义;
|
|
197
|
+
// 跳过之后整条链路(publish → install → 加载)全程不碰公网。
|
|
198
|
+
let versionTaken = false;
|
|
199
|
+
let pub = { ok: false, versions: [] };
|
|
200
|
+
if (!localPreview) {
|
|
201
|
+
pub = await fetchPublishedVersions({ name: info.name, registry: reg, timeoutMs: NPM_TIMEOUT_MS });
|
|
202
|
+
versionTaken = pub.ok && pub.versions.includes(info.version);
|
|
203
|
+
}
|
|
189
204
|
if (versionTaken) {
|
|
190
205
|
return { ok: false, blocked: 'version-taken', name: info.name, version: info.version, versions: pub.versions, error: `${info.name}@${info.version} 已存在于 registry ⇒ 先升版本号再发` };
|
|
191
206
|
}
|
package/lib/plugin/auto-push.js
CHANGED
|
@@ -25,8 +25,8 @@ import { runGit } from '../git/exec.js';
|
|
|
25
25
|
|
|
26
26
|
/* ───────── 自动推送常量 ───────── */
|
|
27
27
|
const AUTO_PUSH_SETTLE_MS = 800; // 回合结束后等收尾落盘的防抖时长
|
|
28
|
-
// 扫描仓库下钻深度默认值:与 lib/git/repos.js 共用同一来源(lib/
|
|
29
|
-
import { DEFAULT_SCAN_DEPTH } from '../
|
|
28
|
+
// 扫描仓库下钻深度默认值:与 lib/git/repos.js 共用同一来源(lib/git/defaults.js)
|
|
29
|
+
import { DEFAULT_SCAN_DEPTH } from '../git/defaults.js';
|
|
30
30
|
|
|
31
31
|
/** 触发面开关(默认全关——保守:自动推送与审计都不默认开,需用户经 UI 显式开启)。 */
|
|
32
32
|
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 预处理 provider 注册表(宿主侧)。
|
|
3
|
+
*
|
|
4
|
+
* 为什么要有这一层:**预处理是通用机制,审计只是它的第一个实现**。
|
|
5
|
+
* 将来还会有 lint / 许可证 / 签名校验等 provider。通用层(引擎调用、拦截判定、
|
|
6
|
+
* HTTP 路由、工具入口)一律面向 `provider` 抽象,不得把某个具体实现的包名写死。
|
|
7
|
+
*
|
|
8
|
+
* provider 契约(外部实现按此对齐,见 audit-sluice 的 manifest):
|
|
9
|
+
* - 可执行入口:`<pkg>/<cliRel>`,stdout 单行 JSON + exit 0|1|2
|
|
10
|
+
* - 可选 manifest:`<pkg>/lib/manifest.js` 导出 preprocessManifest { id, label, endpoints, actions }
|
|
11
|
+
*
|
|
12
|
+
* 解析顺序(与既有行为一致):环境变量 → 插件 node_modules → 平级 sibling。
|
|
13
|
+
* 环境变量名同样按 provider 生成(`DSH_PREPROCESS_<ID>_CLI`),不再有 audit 专属变量。
|
|
14
|
+
*/
|
|
15
|
+
import { existsSync } from 'node:fs';
|
|
16
|
+
import { dirname, join, resolve } from 'node:path';
|
|
17
|
+
import { fileURLToPath, pathToFileURL } from 'node:url';
|
|
18
|
+
|
|
19
|
+
const PLUGIN_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..', '..');
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* 内置 provider 列表。
|
|
23
|
+
*
|
|
24
|
+
* 字段说明:
|
|
25
|
+
* id 稳定标识(配置键前缀、日志、API 都用它)
|
|
26
|
+
* label 面向人的名字(只用于展示)
|
|
27
|
+
* packageName npm 包名(找包用)
|
|
28
|
+
* cliRel 包内可执行入口相对路径
|
|
29
|
+
* legacyEnv 历史环境变量名(向后兼容;新代码请用生成的 DSH_PREPROCESS_<ID>_CLI)
|
|
30
|
+
*/
|
|
31
|
+
export const PROVIDERS = Object.freeze([
|
|
32
|
+
Object.freeze({
|
|
33
|
+
id: 'audit',
|
|
34
|
+
label: '审计',
|
|
35
|
+
packageName: 'audit-sluice',
|
|
36
|
+
cliRel: 'cli.mjs',
|
|
37
|
+
legacyEnv: 'DSH_AUDIT_SLUICE_CLI',
|
|
38
|
+
}),
|
|
39
|
+
// 将来的 provider 在此追加一条即可;通用层(引擎/拦截/路由/工具)无需改动。
|
|
40
|
+
]);
|
|
41
|
+
|
|
42
|
+
/** 缺省 provider:提交门禁当前只跑审计这一个预处理。 */
|
|
43
|
+
export const DEFAULT_PROVIDER_ID = 'audit';
|
|
44
|
+
|
|
45
|
+
/** 按 id 找 provider 定义(未知 id 返回 null,由调用方决定怎么报错)。 */
|
|
46
|
+
export function getProviderDefinition(providerId = DEFAULT_PROVIDER_ID) {
|
|
47
|
+
return PROVIDERS.find((provider) => provider.id === providerId) || null;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/** provider 专属的环境变量名(新口径)。 */
|
|
51
|
+
export function providerEnvName(providerId) {
|
|
52
|
+
return `DSH_PREPROCESS_${String(providerId).toUpperCase()}_CLI`;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* 解析某个 provider 的可执行入口。
|
|
57
|
+
* @param {string} providerId
|
|
58
|
+
* @returns {{ok: true, path: string, source: string, provider: object} | {ok: false, error: string}}
|
|
59
|
+
*/
|
|
60
|
+
export function resolveProvider(providerId = DEFAULT_PROVIDER_ID) {
|
|
61
|
+
const definition = getProviderDefinition(providerId);
|
|
62
|
+
if (!definition) {
|
|
63
|
+
return { ok: false, error: `未知的预处理 provider「${providerId}」(已注册:${PROVIDERS.map((p) => p.id).join(' / ')})` };
|
|
64
|
+
}
|
|
65
|
+
const candidates = [];
|
|
66
|
+
// 1) 显式指定(新变量优先,旧变量兜底)
|
|
67
|
+
const fromEnv = String(process.env[providerEnvName(definition.id)] || process.env[definition.legacyEnv] || '').trim();
|
|
68
|
+
if (fromEnv) candidates.push({ path: fromEnv, source: `env:${providerEnvName(definition.id)}` });
|
|
69
|
+
// 2) 插件自己的 node_modules(npm 安装形态)
|
|
70
|
+
candidates.push({
|
|
71
|
+
path: join(PLUGIN_ROOT, 'node_modules', definition.packageName, definition.cliRel),
|
|
72
|
+
source: 'node_modules',
|
|
73
|
+
});
|
|
74
|
+
// 3) 与本插件平级(开发/并列部署形态)
|
|
75
|
+
candidates.push({
|
|
76
|
+
path: join(PLUGIN_ROOT, '..', definition.packageName, definition.cliRel),
|
|
77
|
+
source: 'sibling',
|
|
78
|
+
});
|
|
79
|
+
for (const candidate of candidates) {
|
|
80
|
+
if (existsSync(candidate.path)) {
|
|
81
|
+
return { ok: true, path: resolve(candidate.path), source: candidate.source, provider: definition };
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return {
|
|
85
|
+
ok: false,
|
|
86
|
+
error: `找不到预处理实现「${definition.label}」(包 ${definition.packageName}/${definition.cliRel})`
|
|
87
|
+
+ `(已查:${candidates.map((c) => c.path).join(' / ')})。`
|
|
88
|
+
+ `修复:把它装到插件 node_modules、与本插件平级放置,或用 ${providerEnvName(definition.id)} 指定入口。`,
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* 解析「提交门禁要用的 provider」。
|
|
94
|
+
* 现在只有一个(审计);将来若支持多预处理串行,这里返回有序列表。
|
|
95
|
+
* @returns {{ok: true, provider: object, path: string, source: string} | {ok: false, error: string}}
|
|
96
|
+
*/
|
|
97
|
+
export function resolveGateProvider() {
|
|
98
|
+
return resolveProvider(DEFAULT_PROVIDER_ID);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export { PLUGIN_ROOT as preprocessPluginRoot };
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* 读取「所有在位 provider 的声明」。
|
|
105
|
+
*
|
|
106
|
+
* 声明来自各包的 `<pkgRoot>/lib/manifest.js`(导出 preprocessManifest)。
|
|
107
|
+
* **这是唯一的能力真相**:CLI 转发、HTTP 路由、工具入口都靠它找「谁提供了什么」,
|
|
108
|
+
* 宿主不写死任何具体实现的能力清单。
|
|
109
|
+
* 不在位(没装/装坏)的 provider 会被跳过并记一条 reason,不抛错——
|
|
110
|
+
* 热插拔语义要求「少一个扩展不影响其他扩展与主流程」。
|
|
111
|
+
*
|
|
112
|
+
* @returns {Promise<{manifests: Array<{provider: object, root: string, manifest: object}>,
|
|
113
|
+
* missing: Array<{provider: object, reason: string}>}>}
|
|
114
|
+
*/
|
|
115
|
+
export async function listProviderManifests() {
|
|
116
|
+
const manifests = [];
|
|
117
|
+
const missing = [];
|
|
118
|
+
for (const definition of PROVIDERS) {
|
|
119
|
+
const resolved = resolveProvider(definition.id);
|
|
120
|
+
if (!resolved.ok) { missing.push({ provider: definition, reason: resolved.error }); continue; }
|
|
121
|
+
const root = dirname(resolved.path);
|
|
122
|
+
const manifestFile = join(root, 'lib', 'manifest.js');
|
|
123
|
+
if (!existsSync(manifestFile)) {
|
|
124
|
+
missing.push({ provider: definition, reason: `缺少声明文件 ${manifestFile}` });
|
|
125
|
+
continue;
|
|
126
|
+
}
|
|
127
|
+
try {
|
|
128
|
+
const loaded = await import(pathToFileURL(manifestFile).href);
|
|
129
|
+
const manifest = loaded.preprocessManifest || loaded.default;
|
|
130
|
+
if (!manifest || typeof manifest !== 'object') {
|
|
131
|
+
missing.push({ provider: definition, reason: `${manifestFile} 未导出 preprocessManifest` });
|
|
132
|
+
continue;
|
|
133
|
+
}
|
|
134
|
+
manifests.push({ provider: definition, root, manifest });
|
|
135
|
+
} catch (error) {
|
|
136
|
+
missing.push({ provider: definition, reason: `加载 ${manifestFile} 失败:${error?.message || error}` });
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
return { manifests, missing };
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* 从所有在位 provider 的声明里,找到「声明了这个 action 的那个」。
|
|
144
|
+
* CLI 的 `preprocess <action>` 与 HTTP 的 `/api/preprocess/<action>` 都走这里,
|
|
145
|
+
* 两边口径自然一致(同一份声明、同一套查找)。
|
|
146
|
+
* @param {string} action
|
|
147
|
+
* @returns {Promise<{provider: object, root: string, manifest: object, action: object} | null>}
|
|
148
|
+
*/
|
|
149
|
+
export async function findActionProvider(action) {
|
|
150
|
+
const name = String(action || '').trim();
|
|
151
|
+
if (!name) return null;
|
|
152
|
+
const { manifests } = await listProviderManifests();
|
|
153
|
+
for (const entry of manifests) {
|
|
154
|
+
const declared = Array.isArray(entry.manifest.actions) ? entry.manifest.actions : [];
|
|
155
|
+
const hit = declared.find((item) => item && item.action === name);
|
|
156
|
+
if (hit) return { ...entry, action: hit };
|
|
157
|
+
}
|
|
158
|
+
return null;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* 从所有在位 provider 的声明里,找到「声明了这个 HTTP 子端点的那个」。
|
|
163
|
+
* 与 findActionProvider 同源(同一份 manifest),只是查 endpoints 而不是 actions。
|
|
164
|
+
* @param {string} subPath 子端点路径,如 'rule-slots'
|
|
165
|
+
* @param {string} [method] HTTP 方法(给了就一并匹配)
|
|
166
|
+
*/
|
|
167
|
+
export async function findEndpointProvider(subPath, method) {
|
|
168
|
+
const target = String(subPath || '').replace(/^\/+/, '');
|
|
169
|
+
const { manifests } = await listProviderManifests();
|
|
170
|
+
for (const entry of manifests) {
|
|
171
|
+
const declared = Array.isArray(entry.manifest.endpoints) ? entry.manifest.endpoints : [];
|
|
172
|
+
const hit = declared.find((item) => item && item.path === target
|
|
173
|
+
&& (!method || String(item.method || 'GET').toUpperCase() === String(method).toUpperCase()));
|
|
174
|
+
if (hit) return { ...entry, endpoint: hit };
|
|
175
|
+
}
|
|
176
|
+
return null;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
/** 所有已声明能力的汇总(供 help / 路由清单展示)。 */
|
|
180
|
+
export async function listDeclaredCapabilities() {
|
|
181
|
+
const { manifests, missing } = await listProviderManifests();
|
|
182
|
+
return {
|
|
183
|
+
actions: manifests.flatMap((entry) => (entry.manifest.actions || []).map((action) => ({
|
|
184
|
+
provider: entry.provider.id, root: entry.root, ...action,
|
|
185
|
+
}))),
|
|
186
|
+
endpoints: manifests.flatMap((entry) => (entry.manifest.endpoints || []).map((endpoint) => ({
|
|
187
|
+
provider: entry.provider.id, root: entry.root, ...endpoint,
|
|
188
|
+
}))),
|
|
189
|
+
missing,
|
|
190
|
+
};
|
|
191
|
+
}
|