dsh-git-push 0.0.0-stage → 2.8.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/.auditignore +30 -0
- package/.gitignore +39 -0
- package/LICENSE +21 -0
- package/README.md +1482 -2
- package/cli.mjs +360 -0
- package/cordis.patch.yml +14 -0
- package/lib/ARCHITECTURE.md +34 -0
- package/lib/BUGFIX-NOTES-2026-09-14.md +278 -0
- package/lib/app/apply.js +275 -0
- package/lib/app/audit-api.js +158 -0
- package/lib/app/command-registry.js +262 -0
- package/lib/app/constants.js +16 -0
- package/lib/app/handlers/account.js +166 -0
- package/lib/app/handlers/clone.js +168 -0
- package/lib/app/handlers/http-constants.js +9 -0
- package/lib/app/handlers/identity-rewrite.js +94 -0
- package/lib/app/handlers/meta.js +175 -0
- package/lib/app/handlers/npm.js +169 -0
- package/lib/app/handlers/repo-actions.js +143 -0
- package/lib/app/handlers/repos.js +231 -0
- package/lib/app/handlers/settings.js +62 -0
- package/lib/app/host-doc-checks.js +25 -0
- package/lib/app/http-handlers.js +131 -0
- package/lib/app/index.js +30 -0
- package/lib/app/inject-text.js +191 -0
- package/lib/app/scan-root.js +23 -0
- package/lib/app/schema.js +150 -0
- package/lib/app/settings-bridge.js +167 -0
- package/lib/app/slash-commands.js +395 -0
- package/lib/app/slot-stats.js +35 -0
- package/lib/app/tool-call.js +662 -0
- package/lib/app/tools.js +40 -0
- package/lib/ast/brace.js +105 -0
- package/lib/ast/callgraph.js +135 -0
- package/lib/ast/code-lines.js +114 -0
- package/lib/ast/consts.js +12 -0
- package/lib/ast/control-flow.js +461 -0
- package/lib/ast/credential.js +199 -0
- package/lib/ast/dataflow.js +274 -0
- package/lib/ast/dup-code.js +165 -0
- package/lib/ast/index.js +36 -0
- package/lib/ast/io-risk-const.js +95 -0
- package/lib/ast/io-risk-fn.js +208 -0
- package/lib/ast/io-risk-loop.js +308 -0
- package/lib/ast/io-risk.js +314 -0
- package/lib/ast/lang.js +156 -0
- package/lib/ast/line-count.js +52 -0
- package/lib/ast/magic-number.js +272 -0
- package/lib/ast/naming.js +284 -0
- package/lib/ast/perf.js +472 -0
- package/lib/ast/scope.js +241 -0
- package/lib/ast/shell.js +131 -0
- package/lib/ast/size.js +378 -0
- package/lib/ast/symbol-index.js +399 -0
- package/lib/ast/tokenizer.js +341 -0
- package/lib/audit/analysis-coverage.js +98 -0
- package/lib/audit/audit-file.js +182 -0
- package/lib/audit/checks.js +17 -0
- package/lib/audit/client-entry.js +93 -0
- package/lib/audit/collector.js +477 -0
- package/lib/audit/ext-runner.js +80 -0
- package/lib/audit/file-context.js +138 -0
- package/lib/audit/finding.js +50 -0
- package/lib/audit/gitignore-match.js +113 -0
- package/lib/audit/glob.js +63 -0
- package/lib/audit/history-report.js +100 -0
- package/lib/audit/history.js +126 -0
- package/lib/audit/ignore-blind.js +101 -0
- package/lib/audit/index.js +33 -0
- package/lib/audit/orchestrate.js +476 -0
- package/lib/audit/public.js +24 -0
- package/lib/audit/repo-level.js +30 -0
- package/lib/audit/report-yaml.js +86 -0
- package/lib/audit/slot.js +65 -0
- package/lib/audit-defaults.js +18 -0
- package/lib/audit-rules/audit-rules-comment.yml +247 -0
- package/lib/audit-rules/audit-rules-cpp.yml +22 -0
- package/lib/audit-rules/audit-rules-docs.yml +32 -0
- package/lib/audit-rules/audit-rules-dsh.yml +162 -0
- package/lib/audit-rules/audit-rules-filehealth.yml +42 -0
- package/lib/audit-rules/audit-rules-folder.yml +99 -0
- package/lib/audit-rules/audit-rules-frontend.yml +335 -0
- package/lib/audit-rules/audit-rules-go.yml +22 -0
- package/lib/audit-rules/audit-rules-i18n.yml +45 -0
- package/lib/audit-rules/audit-rules-java.yml +105 -0
- package/lib/audit-rules/audit-rules-nodejs.yml +647 -0
- package/lib/audit-rules/audit-rules-npm.yml +187 -0
- package/lib/audit-rules/audit-rules-paths.yml +92 -0
- package/lib/audit-rules/audit-rules-performance.yml +207 -0
- package/lib/audit-rules/audit-rules-php.yml +22 -0
- package/lib/audit-rules/audit-rules-private.yml +24 -0
- package/lib/audit-rules/audit-rules-python.yml +106 -0
- package/lib/audit-rules/audit-rules-robustness.yml +27 -0
- package/lib/audit-rules/audit-rules-rust.yml +22 -0
- package/lib/audit-rules/audit-rules-structure.yml +159 -0
- package/lib/audit-rules/audit-rules-swift.yml +22 -0
- package/lib/audit-rules/audit-rules-template.yml +108 -0
- package/lib/checks/button-bind.js +276 -0
- package/lib/checks/common.js +170 -0
- package/lib/checks/credential-file.js +43 -0
- package/lib/checks/dataflow.js +40 -0
- package/lib/checks/dispatch.js +112 -0
- package/lib/checks/dup-code.js +69 -0
- package/lib/checks/dup-const.js +232 -0
- package/lib/checks/file-health.js +150 -0
- package/lib/checks/filter.js +131 -0
- package/lib/checks/folder.js +173 -0
- package/lib/checks/hardcoded-path.js +98 -0
- package/lib/checks/index.js +46 -0
- package/lib/checks/io.js +66 -0
- package/lib/checks/magic-number.js +42 -0
- package/lib/checks/npm-json.js +273 -0
- package/lib/checks/private.js +63 -0
- package/lib/checks/regex.js +256 -0
- package/lib/checks/semantic.js +134 -0
- package/lib/checks/structural.js +274 -0
- package/lib/cli/commands-account.mjs +107 -0
- package/lib/cli/commands-audit.mjs +144 -0
- package/lib/cli/commands-doc.mjs +127 -0
- package/lib/cli/commands-vcs.mjs +175 -0
- package/lib/client/index.js +162 -0
- package/lib/client-parts/00-loader.js +33 -0
- package/lib/client-parts/01-const.js +207 -0
- package/lib/client-parts/02-utils.js +62 -0
- package/lib/client-parts/03-icons.js +12 -0
- package/lib/client-parts/10-account.js +83 -0
- package/lib/client-parts/11-browser.js +95 -0
- package/lib/client-parts/20-repo.js +374 -0
- package/lib/client-parts/21-audit.js +301 -0
- package/lib/client-parts/22-settings.js +146 -0
- package/lib/client-parts/23-npm.js +383 -0
- package/lib/client-parts/30-page.js +56 -0
- package/lib/client-parts/40-controller.js +1092 -0
- package/lib/client-parts/41-actions.js +279 -0
- package/lib/client-parts/99-apply.js +72 -0
- package/lib/client.js +3195 -0
- package/lib/commit-push.js +144 -0
- package/lib/context/index.js +363 -0
- package/lib/core/atomic-json.js +98 -0
- package/lib/core/config.js +40 -0
- package/lib/core/credentials.js +274 -0
- package/lib/core/endpoints.js +109 -0
- package/lib/core/exec.js +162 -0
- package/lib/exempt/index.js +292 -0
- package/lib/fs/edit-after-read.js +103 -0
- package/lib/fsx.js +87 -0
- package/lib/git/account-status.js +140 -0
- package/lib/git/account.js +233 -0
- package/lib/git/api.js +136 -0
- package/lib/git/atomic-json.js +6 -0
- package/lib/git/browse.js +38 -0
- package/lib/git/clone-download.js +397 -0
- package/lib/git/clone-history-mode.js +143 -0
- package/lib/git/clone-history.js +175 -0
- package/lib/git/clone-jobs.js +250 -0
- package/lib/git/clone-replay-io.js +172 -0
- package/lib/git/clone-replay.js +275 -0
- package/lib/git/clone.js +445 -0
- package/lib/git/cloud.js +46 -0
- package/lib/git/commit-message.js +141 -0
- package/lib/git/config.js +6 -0
- package/lib/git/cred-env.js +88 -0
- package/lib/git/credentials.js +6 -0
- package/lib/git/endpoints.js +6 -0
- package/lib/git/exec.js +6 -0
- package/lib/git/identity-rewrite.js +297 -0
- package/lib/git/identity.js +150 -0
- package/lib/git/ignore.js +69 -0
- package/lib/git/index.js +41 -0
- package/lib/git/module-splitter.js +47 -0
- package/lib/git/post-push.js +101 -0
- package/lib/git/push-diagnose.js +142 -0
- package/lib/git/push.js +470 -0
- package/lib/git/remote-resolve.js +146 -0
- package/lib/git/remote.js +128 -0
- package/lib/git/repo-index.js +512 -0
- package/lib/git/repos.js +235 -0
- package/lib/git/scan-runner.js +159 -0
- package/lib/git/sensitive.js +134 -0
- package/lib/git/transport.js +430 -0
- package/lib/git/visibility.js +35 -0
- package/lib/git/wrapped-git.js +68 -0
- package/lib/http/index.js +170 -0
- package/lib/index.js +24 -0
- package/lib/link-check/index.js +187 -0
- package/lib/npm/account.js +64 -0
- package/lib/npm/install.js +211 -0
- package/lib/npm/npmrc.js +56 -0
- package/lib/npm/publish.js +167 -0
- package/lib/npm/registry.js +147 -0
- package/lib/plugin/auto-detect.js +92 -0
- package/lib/plugin/auto-push.js +154 -0
- package/lib/plugin/index.js +250 -0
- package/lib/readme-templates/readme.yml +38 -0
- package/lib/rule/compilers/credential.js +62 -0
- package/lib/rule/compilers/dataflow.js +38 -0
- package/lib/rule/compilers/file-health.js +75 -0
- package/lib/rule/compilers/frontend.js +86 -0
- package/lib/rule/compilers/func.js +35 -0
- package/lib/rule/compilers/helpers.js +71 -0
- package/lib/rule/compilers/index.js +29 -0
- package/lib/rule/compilers/link-semantic.js +45 -0
- package/lib/rule/compilers/list-kinds.js +12 -0
- package/lib/rule/compilers/numeric-kinds.js +66 -0
- package/lib/rule/compilers/regex.js +78 -0
- package/lib/rule/compilers/structure.js +80 -0
- package/lib/rule/compilers.js +17 -0
- package/lib/rule/homoglyph.js +45 -0
- package/lib/rule/loader.js +270 -0
- package/lib/rule/registry.js +115 -0
- package/lib/rule/scope.js +67 -0
- package/lib/score/docs-score.js +166 -0
- package/lib/score/index.js +140 -0
- package/lib/self/index.js +193 -0
- package/lib/skip-dirs.js +64 -0
- package/lib/tool-probes.json +50 -0
- package/lib/user-requirements.json +14 -0
- package/lib/vendor/js-yaml/LICENSE +21 -0
- package/lib/vendor/js-yaml/js-yaml.mjs +3073 -0
- package/package.json +95 -4
- package/scripts/__pycache__/module-splitter.cpython-38.pyc +0 -0
- package/scripts/audit-ext/_example-readme-present.mjs +34 -0
- package/scripts/audit-ext/variable-min-length.mjs +102 -0
- package/scripts/audit-runner.mjs +35 -0
- package/scripts/audit-runtime-check.mjs +129 -0
- package/scripts/browser-page-probe.mjs +271 -0
- package/scripts/build-client.mjs +119 -0
- package/scripts/check.mjs +88 -0
- package/scripts/clean-date-comments.py +102 -0
- package/scripts/doc-drift.mjs +200 -0
- package/scripts/doc-func.mjs +212 -0
- package/scripts/doc-tree.mjs +456 -0
- package/scripts/doc-version.mjs +220 -0
- package/scripts/frontend-preview-check.mjs +124 -0
- package/scripts/hot-path-probe-cjs.cjs +71 -0
- package/scripts/hot-path-probe-fs-shim.mjs +28 -0
- package/scripts/hot-path-probe-fsp-shim.mjs +31 -0
- package/scripts/hot-path-probe.mjs +153 -0
- package/scripts/module-splitter.py +800 -0
- package/scripts/platform-scan.mjs +168 -0
- package/scripts/preview-gen.mjs +489 -0
- package/scripts/preview-local-runner.mjs +55 -0
- package/scripts/preview-server-direct.mjs +116 -0
- package/scripts/preview-server.mjs +305 -0
- package/scripts/preview-slot-data.mjs +123 -0
- package/scripts/probe-recheck.mjs +47 -0
- package/scripts/readme-gen.mjs +268 -0
- package/scripts/rename-locator.mjs +97 -0
- package/scripts/rule-switch.mjs +97 -0
- package/scripts/rules-solo-audit.mjs +173 -0
- package/scripts/scan-file-io.mjs +713 -0
- package/scripts/scan-hardcoded-paths.mjs +125 -0
- package/scripts/scan-repos.mjs +167 -0
- package/scripts/scan-version.mjs +122 -0
- package/scripts/scrub-user-wording.mjs +420 -0
- package/scripts/symbol-index.mjs +85 -0
- package/scripts/sync-plugin-install.mjs +223 -0
- package/scripts/sync-plugin.mjs +279 -0
- package/scripts/verify-prestep.mjs +100 -0
- package/skills/dev/audit-rule-authoring.md +58 -0
- package/skills/dev/dsh-git-push.md +323 -0
- package/skills/dev/git-push-live-fix.md +45 -0
- package/skills/dsh-repo-index.md +35 -0
- package/skills/guide/guide-audit.md +167 -0
- package/skills/guide/guide-cli-scripts.md +104 -0
- package/skills/guide/guide-clone-repos.md +173 -0
- package/skills/guide/guide-commit-push.md +156 -0
- package/skills/guide/guide-inject-ui.md +166 -0
- package/skills/guide/guide-slash-completion.md +118 -0
- package/skills/workflow/README.md +21 -0
- package/skills/workflow/git-commit-discipline.md +68 -0
- package/skills/workflow/git-project-startup.md +85 -0
- package/skills/workflow/git-rebuild-process.md +57 -0
- package/skills/workflow/github-operations.md +91 -0
- package/skills/workflow/readme-sync-git-md.md +28 -0
- package/skills/workflow/task-completion-report.md +73 -0
- package/skills/workflow/tool-json-add-ask.md +35 -0
- package/skills/workflow/versioning-rule.md +211 -0
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 审计「静默失明」检测。
|
|
3
|
+
*
|
|
4
|
+
* 为什么需要:审计的文件收集走 `git check-ignore`,而该判定会采信
|
|
5
|
+
* `.git/info/exclude`——这是 git 的**本地私有排除**层,不随仓库分发,却
|
|
6
|
+
* 优先级等同于 .gitignore。实测一个被写成单行 `*` 的 `.git/info/exclude`
|
|
7
|
+
* 能让整仓文件被判定为「已忽略」:审计只收集到 5 个文件(其余 21 个全跳过),
|
|
8
|
+
* 而**不报错、不告警、退出码正常**——调用方看到的是「这个仓库很干净」。
|
|
9
|
+
*
|
|
10
|
+
* 这比误报危险得多:误报会被人发现并纠正,静默失明不会。且该文件属于本机
|
|
11
|
+
* 配置,CI/他人机器上不存在——同一份代码在不同机器上审计结论不同。
|
|
12
|
+
*
|
|
13
|
+
* 判据(两者取或,均可独立触发):
|
|
14
|
+
* ① 静态:`.git/info/exclude` 含「全仓通配」条目(`*` / `/*` / `**` / `**/*`)
|
|
15
|
+
* ② 行为:git 跟踪的文件里,被判定为忽略的比例 ≥ 90% 且数量 ≥ 20
|
|
16
|
+
* (正常仓库的 info/exclude 只排除少量本地产物;接近全量说明配置异常)
|
|
17
|
+
*
|
|
18
|
+
* 只报 warning 不阻断:仓库可能真的有意排除本机文件,交由人确认。
|
|
19
|
+
*/
|
|
20
|
+
import { existsSync, readFileSync } from 'node:fs';
|
|
21
|
+
import { join, isAbsolute } from 'node:path';
|
|
22
|
+
import { spawnSync } from 'node:child_process';
|
|
23
|
+
|
|
24
|
+
/* ───────── 静默失明检测常量 ───────── */
|
|
25
|
+
const GIT_PROBE_TIMEOUT_MS = 5000; // git rev-parse 探测超时
|
|
26
|
+
const GIT_LS_TIMEOUT_MS = 20_000; // git ls-files / check-ignore 超时
|
|
27
|
+
const TRACKED_MIN = 20; // 行为判据:跟踪文件数下限
|
|
28
|
+
const IGNORE_RATIO_THRESHOLD = 0.9; // 行为判据:被忽略比例阈值
|
|
29
|
+
|
|
30
|
+
/** 判定为「全仓通配」的模式(这些会让整仓不可见)。 */
|
|
31
|
+
const BROAD_PATTERNS = new Set(['*', '/*', '**', '**/*', '.']);
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* 取仓库的 `.git/info/exclude` 绝对路径(兼容 .git 为文件的工作树/submodule)。
|
|
35
|
+
* @param {string} root 仓库根
|
|
36
|
+
* @returns {string} 路径(可能不存在)
|
|
37
|
+
*/
|
|
38
|
+
function excludePathOf(root) {
|
|
39
|
+
const r = spawnSync('git', ['-C', root, 'rev-parse', '--git-dir'], {
|
|
40
|
+
encoding: 'utf8', stdio: ['ignore', 'pipe', 'pipe'], timeout: GIT_PROBE_TIMEOUT_MS,
|
|
41
|
+
});
|
|
42
|
+
if (r.status !== 0) return '';
|
|
43
|
+
let gitDir = String(r.stdout || '').trim();
|
|
44
|
+
if (!gitDir) return '';
|
|
45
|
+
if (!isAbsolute(gitDir)) gitDir = join(root, gitDir);
|
|
46
|
+
return join(gitDir, 'info', 'exclude');
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* 检测审计是否可能因本地 git 排除配置而静默失明。
|
|
51
|
+
* @param {string} root 仓库根目录
|
|
52
|
+
* @returns {{broad: string[], ignoreRatio: number, tracked: number}|null} null = 非 git 或无异常
|
|
53
|
+
*/
|
|
54
|
+
export function detectIgnoreBlindSpot(root) {
|
|
55
|
+
const probe = spawnSync('git', ['-C', root, 'rev-parse', '--is-inside-work-tree'], {
|
|
56
|
+
encoding: 'utf8', stdio: ['ignore', 'pipe', 'pipe'], timeout: GIT_PROBE_TIMEOUT_MS,
|
|
57
|
+
});
|
|
58
|
+
if (probe.status !== 0 || String(probe.stdout || '').trim() !== 'true') return null;
|
|
59
|
+
|
|
60
|
+
// ① 静态判据:info/exclude 里的全仓通配
|
|
61
|
+
const broad = [];
|
|
62
|
+
try {
|
|
63
|
+
const p = excludePathOf(root);
|
|
64
|
+
if (p && existsSync(p)) {
|
|
65
|
+
for (const raw of readFileSync(p, 'utf8').split('\n')) {
|
|
66
|
+
const line = raw.trim();
|
|
67
|
+
if (!line || line.startsWith('#')) continue;
|
|
68
|
+
if (BROAD_PATTERNS.has(line)) broad.push(line);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
} catch { /* 读不到则跳过静态判据,行为判据仍生效 */ }
|
|
72
|
+
|
|
73
|
+
// ② 行为判据:被忽略的跟踪文件占比
|
|
74
|
+
let tracked = 0;
|
|
75
|
+
let ignored = 0;
|
|
76
|
+
try {
|
|
77
|
+
const ls = spawnSync('git', ['-C', root, 'ls-files'], {
|
|
78
|
+
encoding: 'utf8', stdio: ['ignore', 'pipe', 'pipe'], timeout: GIT_LS_TIMEOUT_MS,
|
|
79
|
+
});
|
|
80
|
+
if (ls.status === 0) {
|
|
81
|
+
const files = String(ls.stdout || '').split('\n').filter(Boolean);
|
|
82
|
+
tracked = files.length;
|
|
83
|
+
if (tracked) {
|
|
84
|
+
// 必须带 --no-index:对**已跟踪**文件,check-ignore 默认不报(它们按定义不被忽略),
|
|
85
|
+
// 而我们要问的正是「这些文件在审计收集时会不会被跳过」。实测不带该参数时
|
|
86
|
+
// 被 `*` 污染的仓库仍返回 0 条,行为判据形同失效。
|
|
87
|
+
const ci = spawnSync('git', ['-C', root, 'check-ignore', '--stdin', '--no-index'], {
|
|
88
|
+
input: files.join('\n'), encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'], timeout: GIT_LS_TIMEOUT_MS,
|
|
89
|
+
});
|
|
90
|
+
if (ci.status === 0 || ci.status === 1) {
|
|
91
|
+
ignored = String(ci.stdout || '').split('\n').filter(Boolean).length;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
} catch { /* 判据不可用则按未命中处理 */ }
|
|
96
|
+
|
|
97
|
+
const ignoreRatio = tracked ? ignored / tracked : 0;
|
|
98
|
+
const ratioHit = tracked >= TRACKED_MIN && ignoreRatio >= IGNORE_RATIO_THRESHOLD;
|
|
99
|
+
if (!broad.length && !ratioHit) return null;
|
|
100
|
+
return { broad, ignoreRatio, tracked };
|
|
101
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 审计层 · 统一出口
|
|
3
|
+
*
|
|
4
|
+
* 本目录是「审计编排层」:采集文件(collector/glob)→ 逐文件跑检查(audit-file)
|
|
5
|
+
* → 豁免过滤(lib/exempt/)→ 汇总(finding/slot)→ 按范围编排(orchestrate)。
|
|
6
|
+
*
|
|
7
|
+
* 分层位置(四层审计架构最上层):
|
|
8
|
+
* lib/audit-rules/*.yml 规则内容(阈值/严重度/豁免清单)
|
|
9
|
+
* lib/rule/* 规则加载与编译
|
|
10
|
+
* lib/ast/* · lib/checks/* token 级实现与检查包装
|
|
11
|
+
* lib/audit/* 采集与编排(本目录)
|
|
12
|
+
*
|
|
13
|
+
* 模块划分:
|
|
14
|
+
* finding.js finding 构造、豁免提示装饰、汇总统计、代码扩展名表
|
|
15
|
+
* slot.js 规则槽位统计(槽位命中数、槽位映射、按槽位计数)
|
|
16
|
+
* repo-level.js 仓库级语义规则的锚点文件选择(全仓只报一次的那类规则)
|
|
17
|
+
* file-context.js 文件上下文判定辅助(同函数内 mkdir、外部调用超时、js/yaml import、版本号在路径中)
|
|
18
|
+
* audit-file.js 单文件审计(读文件 → 跑检查 → 豁免过滤)
|
|
19
|
+
* orchestrate.js 编排入口:全量审计 / 变动审计 / 作用域审计 / 扫描上限截断
|
|
20
|
+
*
|
|
21
|
+
* 注意本文件底部的副作用 import:lib/rule/compilers.js 靠 import 触发规则编译器注册,
|
|
22
|
+
* 删掉它会让审计拿到空编译器表(不报错,但检查项全不出)。
|
|
23
|
+
*/
|
|
24
|
+
|
|
25
|
+
import '../rule/compilers.js'; // 副作用:注册 13 种编译函数
|
|
26
|
+
|
|
27
|
+
export { makeFinding, decorateTestExemptHint, summarize, CODE_EXTS } from './finding.js';
|
|
28
|
+
export { slotStatsFromFindings, buildRuleSlotMap, countRulesBySlot } from './slot.js';
|
|
29
|
+
export { repoLevelSemanticRuleIds, pickRepoLevelAnchorFile } from './repo-level.js';
|
|
30
|
+
export { hasMkdirInSameFunction, hasExternalCallTimeout, detectRepoJsYamlImport, isVersionInPathContext } from './file-context.js';
|
|
31
|
+
export { auditFile } from './audit-file.js';
|
|
32
|
+
export { capScanFiles, auditFull, auditChanged, auditWithScope } from './orchestrate.js';
|
|
33
|
+
export { findingsToYaml } from './report-yaml.js';
|
|
@@ -0,0 +1,476 @@
|
|
|
1
|
+
import { readFileSync, existsSync } from 'node:fs';
|
|
2
|
+
import { execFileSync } from 'node:child_process';
|
|
3
|
+
import { join, relative } from 'node:path';
|
|
4
|
+
import { collectTextFiles, readText, isGitRepo, collectChangedFiles, isTextFile } from './collector.js';
|
|
5
|
+
import { computeAnalysisCoverage } from './analysis-coverage.js';
|
|
6
|
+
import { groupByKind, HINT_QUALITY, checkFolderRules, checkPrivateFiles, checkDuplicateCode, checkDuplicateConst } from './checks.js';
|
|
7
|
+
import { loadRuleFiles } from '../rule/loader.js';
|
|
8
|
+
import { compileAllRules } from '../rule/registry.js';
|
|
9
|
+
import { auditFile } from './audit-file.js';
|
|
10
|
+
import { detectRepoJsYamlImport } from './file-context.js';
|
|
11
|
+
import { decorateTestExemptHint, makeFinding, summarize } from './finding.js';
|
|
12
|
+
import { pickRepoLevelAnchorFile, repoLevelSemanticRuleIds } from './repo-level.js';
|
|
13
|
+
import { checkDocsScore } from '../score/docs-score.js';
|
|
14
|
+
import { runAuditExt } from './ext-runner.js';
|
|
15
|
+
import { buildRuleSlotMap, countRulesBySlot, slotStatsFromFindings } from './slot.js';
|
|
16
|
+
import { findingsToYaml } from './report-yaml.js';
|
|
17
|
+
/**
|
|
18
|
+
* 宿主文档漂移检查器的**注入点**(审计包边界,2026-10-13)。
|
|
19
|
+
*
|
|
20
|
+
* 为什么是注入而不是 import:审计部分要能按独立包使用(详见 开发者文档/dsh-git-push/审计独立包设计-20261013.md),
|
|
21
|
+
* 因此审计侧不得反向 import 仓库脚本(`scripts/**`)。宿主(插件/CLI)在加载时用 setHostDocChecks 接线;
|
|
22
|
+
* 未接线时三个包装函数返回空实现 ⇒ 调用点行为 = 「跳过漂移检查」,不报错、不影响其它检查。
|
|
23
|
+
* 调用点零改动:下面三个同名包装函数遮蔽了原来的 import,`findMarkedHostMd` 返回空串会让后续 existsSync 自然早退。
|
|
24
|
+
*/
|
|
25
|
+
let injected = null;
|
|
26
|
+
|
|
27
|
+
/** 由宿主注入文档漂移检查器(幂等;传 null 可卸载)。 */
|
|
28
|
+
export function setHostDocChecks(checks) {
|
|
29
|
+
injected = checks || null;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
const EMPTY_DOC_CHECKS = { findMarkedHostMd: () => '', checkDrift: () => ({ issues: [] }), checkFuncDrift: () => ({ issues: [] }) };
|
|
33
|
+
|
|
34
|
+
const findMarkedHostMd = (...args) => (injected || EMPTY_DOC_CHECKS).findMarkedHostMd(...args);
|
|
35
|
+
const checkDrift = (...args) => (injected || EMPTY_DOC_CHECKS).checkDrift(...args);
|
|
36
|
+
const checkFuncDrift = (...args) => (injected || EMPTY_DOC_CHECKS).checkFuncDrift(...args);
|
|
37
|
+
import { detectIgnoreBlindSpot } from './ignore-blind.js';
|
|
38
|
+
|
|
39
|
+
/* ───────── 编排常量 ───────── */
|
|
40
|
+
const CHECK_IGNORE_TIMEOUT_MS = 5000; // git check-ignore 单文件判定超时
|
|
41
|
+
const README_FILE_NAME = 'README.md'; // 项目说明文件(分体文档宿主探测的默认回退)
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* 大仓库扫描上限(性能降级,)。
|
|
45
|
+
*
|
|
46
|
+
* 动机:弱 CPU 机器上「全量扫几万文件」会把提交推送卡死——实测 3 万文件 × ~42ms/文件
|
|
47
|
+
* 约 21 分钟,用户侧表现为「提交推送一直不动」。超上限时截断扫描,并**优先保留本次
|
|
48
|
+
* 变动文件**(git status):正要提交的东西必须被审到,不能因为截断而漏审。
|
|
49
|
+
*
|
|
50
|
+
* 语义:cap <= 0(或未配置)时完全不限制,行为与旧版一致(向后兼容)。
|
|
51
|
+
*
|
|
52
|
+
* @param {Array<{path:string, full:string}>} files 全量收集结果
|
|
53
|
+
* @param {string} root 仓库根
|
|
54
|
+
* @param {number|string} maxFiles 上限(0/空 = 不限)
|
|
55
|
+
* @returns {{files: Array, truncated: null|{total:number, scanned:number, cap:number}}}
|
|
56
|
+
*/
|
|
57
|
+
export function capScanFiles(files, root, maxFiles) {
|
|
58
|
+
const cap = Number(maxFiles) || 0;
|
|
59
|
+
if (cap <= 0 || files.length <= cap) return { files, truncated: null };
|
|
60
|
+
const changed = collectChangedFiles(root);
|
|
61
|
+
const changedSet = new Set((changed || []).map((c) => String(c.rel || '').replace(/\\/g, '/')));
|
|
62
|
+
const priority = [];
|
|
63
|
+
const rest = [];
|
|
64
|
+
for (const f of files) (changedSet.has(f.path) ? priority : rest).push(f);
|
|
65
|
+
const out = priority.concat(rest).slice(0, cap);
|
|
66
|
+
return { files: out, truncated: { total: files.length, scanned: out.length, cap } };
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* 审计静默失明告警:本地 git 排除配置(.git/info/exclude)把整仓判成忽略时提醒。
|
|
71
|
+
*
|
|
72
|
+
* 为什么必须报:这种情形下审计**不报错、退出正常**,只是几乎扫不到文件——调用方
|
|
73
|
+
* 看到的是「仓库很干净」。实测一个写有 `*` 的 info/exclude 让 26 个跟踪文件里
|
|
74
|
+
* 21 个被静默跳过(只扫到 5 个),而当时的审计结论是「0 拦截 / 98.6 分 A」。
|
|
75
|
+
* 该文件是**本机私有配置**,不随仓库分发,因此同一份代码在不同机器上结论不同。
|
|
76
|
+
* @param {Array} findings
|
|
77
|
+
* @param {string} repoPath
|
|
78
|
+
* @param {number} scanned 实际收集到的文件数
|
|
79
|
+
*/
|
|
80
|
+
function appendIgnoreBlindSpot(findings, repoPath, scanned) {
|
|
81
|
+
try {
|
|
82
|
+
const hit = detectIgnoreBlindSpot(repoPath);
|
|
83
|
+
if (!hit) return;
|
|
84
|
+
const detail = hit.broad.length
|
|
85
|
+
? `.git/info/exclude 含全仓通配 ${JSON.stringify(hit.broad)}`
|
|
86
|
+
: `跟踪文件中 ${(hit.ignoreRatio * 100).toFixed(0)}% 被判定为忽略(${hit.tracked} 个)`;
|
|
87
|
+
findings.push(makeFinding({
|
|
88
|
+
file: '.git/info/exclude', line: 1, rule: 'robustness/audit-blind-spot', kind: 'max-depth',
|
|
89
|
+
severity: 'warning',
|
|
90
|
+
message: `审计可能「静默失明」:${detail}——本次仅收集到 ${scanned} 个文件。`
|
|
91
|
+
+ '该文件属本机私有排除配置(不随仓库分发),会使审计扫不到大部分文件却不报错。'
|
|
92
|
+
+ '请清空 .git/info/exclude 后重跑,或确认确实有意排除本机文件。',
|
|
93
|
+
dimensions: ['健壮性'], scoreImpact: 1,
|
|
94
|
+
}));
|
|
95
|
+
} catch { /* 检测失败不影响审计主流程 */ }
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
/** 全量审计:目录递归扫描,非 git 项目可查,默认排除 git 忽略文件。 */
|
|
99
|
+
/**
|
|
100
|
+
* 公共审计核心(重构):full/changed 只差「扫描文件范围」。
|
|
101
|
+
* 文件收集(collectTextFiles 全仓 / collectChangedFiles 变动)由调用方完成,
|
|
102
|
+
* 其余环节(规则编译、repoLevel、逐文件审计、locale/folder、private、收尾、
|
|
103
|
+
* slotStats、docsScore、yaml)统一走本函数,消除两套重复实现。
|
|
104
|
+
* @param {string} repoPath 仓库根
|
|
105
|
+
* @param {Array<{path?:string, rel?:string, full:string, status?:string}>} files 待审计文件(path 优先,rel 兜底)
|
|
106
|
+
* @param {object} opts { scope, compiled, slots, rulesetDir, disabledSlots, auditLevel, privateFiles, visibility, truncated }
|
|
107
|
+
*/
|
|
108
|
+
async function auditFiles(repoPath, files, opts = {}) {
|
|
109
|
+
// 归一化:full 收集项用 path,changed 用 rel → 统一取 path
|
|
110
|
+
const normFiles = files.map((f) => ({ path: f.path ?? f.rel, full: f.full, status: f.status }));
|
|
111
|
+
// 编译规则:调用方可传 compiled;未传时默认加载 nodejs 槽位(含 npm/html 等槽位建好后自动扩展)
|
|
112
|
+
let compiled = opts.compiled;
|
|
113
|
+
// 无条件 load 一次:external 规则 id 集合以 **原始 yml 字段** 为准(external: true 具体字段——
|
|
114
|
+
// 可靠来源;不依赖编译后透传/编译是否成功,也不经过 groupByKind 过滤)
|
|
115
|
+
const loaded = loadRuleFiles(opts.slots, { dir: opts.rulesetDir, disabledSlots: opts.disabledSlots });
|
|
116
|
+
// external 字段 = 具体标识(非布尔):字段存在即视为 external(内置停跑——由 audit-ext 脚本经统一动态入口执行)
|
|
117
|
+
const externalIds = new Set(loaded.merged.rules.filter((r) => r.external !== undefined && r.external !== false).map((r) => r.id));
|
|
118
|
+
if (!compiled) {
|
|
119
|
+
compiled = compileAllRules(loaded.merged.rules, { errors: [] });
|
|
120
|
+
}
|
|
121
|
+
const grouped = groupByKind(compiled);
|
|
122
|
+
// 内置停跑 external 规则(yml 具体字段 external: true → audit-ext 独立脚本经统一动态入口执行)
|
|
123
|
+
for (const kind of Object.keys(grouped)) {
|
|
124
|
+
grouped[kind] = grouped[kind].filter((r) => !externalIds.has(r.id));
|
|
125
|
+
}
|
|
126
|
+
// 项目类型适配(非 dsh 插件误报消除):
|
|
127
|
+
// dsh 槽位规则(client-node-builtin-require 等 7 条)是 dsh 插件生态专属契约
|
|
128
|
+
// (cordis/schemastery/ModuleLoader/schema)——非 dsh 插件项目(Node 后端/独立工具)
|
|
129
|
+
// require('fs'/'node:sqlite') 是正常用法,dsh 槽位误报(Pawchive 实测 7 条含 6 blocker)。
|
|
130
|
+
// 修订:version 0.x 三条(major-zero/embedded-major-zero/readme-zero-title)
|
|
131
|
+
// 已按 SemVer §4「0.x 合法开发期」从规则文件删除,此处只过滤 dsh 槽位。
|
|
132
|
+
// 判定沿用 appendSplitDocsCheck 先例:package.json name 以 dsh- 开头 = dsh 插件。
|
|
133
|
+
const isDshPlugin = (() => {
|
|
134
|
+
try {
|
|
135
|
+
const pkgPath = join(repoPath, 'package.json');
|
|
136
|
+
if (!existsSync(pkgPath)) return false;
|
|
137
|
+
return String(JSON.parse(readFileSync(pkgPath, 'utf8'))?.name || '').startsWith('dsh-');
|
|
138
|
+
} catch { return false; }
|
|
139
|
+
})();
|
|
140
|
+
if (!isDshPlugin) {
|
|
141
|
+
for (const kind of Object.keys(grouped)) {
|
|
142
|
+
if (!Array.isArray(grouped[kind])) continue;
|
|
143
|
+
grouped[kind] = grouped[kind].filter((r) => !String(r?.id || '').startsWith('dsh/'));
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
// 全仓 js-yaml import 证据——范围由传入 files 决定(full=全仓、changed=本次变动)
|
|
147
|
+
const repoHasJsYamlImport = detectRepoJsYamlImport(normFiles);
|
|
148
|
+
// 仓库语言适配:nodejs 槽位的仓库级语义占位规则(npm audit 依赖、
|
|
149
|
+
// 路径穿越人工核查/测试文件存在)只对 JS/Node 生态有判定意义——纯 Java/Kotlin/
|
|
150
|
+
// Python 等无 npm 依赖的仓库报「npm audit 有漏洞」是规则不适配噪音(pix-ezviewer
|
|
151
|
+
// 实测:CommentAdapter.java 报 dependency/known-vulnerability,而其唯一 .js 是
|
|
152
|
+
// docs 静态站构建产物)。判定:仓库根有 package.json(npm 项目管理)→ 保留全部
|
|
153
|
+
// 语义规则;无 package.json → 剔除 dependency/*(npm audit 依赖)与 testing/*
|
|
154
|
+
// (测试文件——JS 测试形态)语义规则;path-traversal 属通用安全人工核查提示,
|
|
155
|
+
// 保留(Java 的 File/Paths 亦有路径操作,属于需人工确认的安全面)。
|
|
156
|
+
const hasPackageJson = existsSync(join(repoPath, 'package.json'));
|
|
157
|
+
if (!hasPackageJson) {
|
|
158
|
+
for (const kind of Object.keys(grouped)) {
|
|
159
|
+
if (!Array.isArray(grouped[kind])) continue;
|
|
160
|
+
grouped[kind] = grouped[kind].filter((r) => !/^dependency\//.test(String(r?.id || '') || '')
|
|
161
|
+
&& !/^testing\//i.test(String(r?.id || '') || ''));
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
const findings = [];
|
|
165
|
+
if (opts.truncated) {
|
|
166
|
+
findings.push(makeFinding({
|
|
167
|
+
file: `${repoPath}/`, line: 1, rule: 'audit/scan-truncated', kind: 'semantic',
|
|
168
|
+
severity: 'notice',
|
|
169
|
+
message: `仓库文件过多(${opts.truncated.total} 个),本次只审计了 ${opts.truncated.scanned} 个(已优先纳入变动文件);如需全量可调大 maxScanFiles,或改用 scope:'diff'`,
|
|
170
|
+
dimensions: ['性能'],
|
|
171
|
+
exemptHint: HINT_QUALITY,
|
|
172
|
+
scoreImpact: 0,
|
|
173
|
+
}));
|
|
174
|
+
}
|
|
175
|
+
// 仓库级 semantic 占位规则(npm audit / 路径穿越人工核查 / a11y)只在
|
|
176
|
+
// 一个代表文件上报一次——它们是「整个仓库」的属性,逐文件报会在 N 个文件上产出
|
|
177
|
+
// N 条同义提示,淹没真实问题。代表文件 = 路径字典序最小者。
|
|
178
|
+
const repoLevelRules = repoLevelSemanticRuleIds(grouped);
|
|
179
|
+
const repoLevelAnchor = pickRepoLevelAnchorFile(normFiles);
|
|
180
|
+
const fileTexts = []; // 跨文件重复检测用(全部代码文件文本)
|
|
181
|
+
for (const f of normFiles) {
|
|
182
|
+
const text = readText(f.full);
|
|
183
|
+
fileTexts.push({ path: f.path, text });
|
|
184
|
+
const skipRepoLevel = repoLevelRules.size > 0 && f.path !== repoLevelAnchor;
|
|
185
|
+
findings.push(...auditFile({ file: f.path, relPath: f.path, text, grouped }, {
|
|
186
|
+
level: opts.auditLevel, repoHasJsYamlImport, repoPath,
|
|
187
|
+
repoLevelRules: skipRepoLevel ? repoLevelRules : null,
|
|
188
|
+
}));
|
|
189
|
+
}
|
|
190
|
+
// 跨文件重复代码检测(maintainability/no-duplicate-code,该抽公共函数)。
|
|
191
|
+
// 放在逐文件循环后:需要全部文件文本才能跨文件聚合「同一结构 ≥3 处」。severity 恒 warning。
|
|
192
|
+
if (grouped['duplicate-code']) {
|
|
193
|
+
findings.push(...checkDuplicateCode(fileTexts, grouped['duplicate-code']));
|
|
194
|
+
}
|
|
195
|
+
// 跨文件同名常量重复定义检测(maintainability/duplicate-constant-def)——DRY 信号:
|
|
196
|
+
// 同一阈值/长度/窗口常量散落多个模块(MAX_MSG_PREVIEW=80 三处实测),改一处漏多处——
|
|
197
|
+
// 应统一到公共常量模块单处定义(lib/app/constants.js 是现有先例)。
|
|
198
|
+
// 同一阈值/长度/窗口常量散落多个模块(MAX_MSG_PREVIEW=80 三处实测)→ 提示统一单一来源。
|
|
199
|
+
if (grouped['duplicate-const']) {
|
|
200
|
+
findings.push(...checkDuplicateConst(fileTexts, grouped['duplicate-const']));
|
|
201
|
+
}
|
|
202
|
+
// 目录级审计(folder 槽位):仓库结构规则在文件行级之外统一跑一次
|
|
203
|
+
// 仓库级 i18n 检查:语言包文件(zh-CN.json / en-US.json)缺失只在仓库根判定一次
|
|
204
|
+
if (grouped['semantic']) {
|
|
205
|
+
const localeRules = grouped['semantic'].filter((r) => r.detectionMethod === 'locale-file-exists' || /locale-file/i.test(r.id || ''));
|
|
206
|
+
// 文件存在性只查一次(循环外缓存;多条 locale 规则共享同一判定)
|
|
207
|
+
const hasZh = existsSync(join(repoPath, 'zh-CN.json')) || existsSync(join(repoPath, 'locales', 'zh-CN.json'));
|
|
208
|
+
const hasEn = existsSync(join(repoPath, 'en-US.json')) || existsSync(join(repoPath, 'locales', 'en-US.json'));
|
|
209
|
+
for (const rule of localeRules) {
|
|
210
|
+
if (!hasZh || !hasEn) {
|
|
211
|
+
findings.push(makeFinding({
|
|
212
|
+
file: `${repoPath}/package.json`, line: 1, rule: rule.id, kind: 'semantic',
|
|
213
|
+
severity: 'notice',
|
|
214
|
+
message: `${rule.message || rule.name}(缺 ${!hasZh ? 'zh-CN.json' : ''} ${!hasEn ? 'en-US.json' : ''})`,
|
|
215
|
+
dimensions: rule.dimensions || ['文档'],
|
|
216
|
+
exemptHint: HINT_QUALITY,
|
|
217
|
+
scoreImpact: 0,
|
|
218
|
+
}));
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
if (grouped['folder']) {
|
|
223
|
+
let gitignoreText = '';
|
|
224
|
+
try { gitignoreText = existsSync(join(repoPath, '.gitignore')) ? readFileSync(join(repoPath, '.gitignore'), 'utf8') : ''; } catch { /* 忽略 */ }
|
|
225
|
+
findings.push(...checkFolderRules({ root: repoPath, rules: grouped['folder'], gitignoreText }));
|
|
226
|
+
}
|
|
227
|
+
// 私密文件拦截(private 槽位,1.0.4,T1-T33 考古验收):git ls-files × private_files glob × 远端可见性分级
|
|
228
|
+
const privateFiles = opts.privateFiles
|
|
229
|
+
?? (() => { try { return loadRuleFiles(opts.slots, { dir: opts.rulesetDir, disabledSlots: opts.disabledSlots }).merged.private_files || []; } catch { return []; } })();
|
|
230
|
+
if (privateFiles.length) {
|
|
231
|
+
findings.push(...checkPrivateFiles({ root: repoPath, visibility: opts.visibility || 'unknown', privateFiles }));
|
|
232
|
+
}
|
|
233
|
+
decorateTestExemptHint(findings);
|
|
234
|
+
// README 目录树漂移并入审计——仓库根有 README + dshgp-tree 标记块时,
|
|
235
|
+
// 检查真实文件树与 README 树是否一致(新增未列/已删未清/映射孤儿),漂移产生
|
|
236
|
+
// structure/tree-doc-drift finding(warning,不拦提交但提示维护 README 树)。
|
|
237
|
+
appendTreeDocDrift(findings, repoPath);
|
|
238
|
+
// 函数列表漂移并入审计——与文件树同款口径:**只有仓库里存在带 dshgp-functions 标记块的 md 才检查**
|
|
239
|
+
// (其他作者的仓库没有这份文档 → 天然跳过,不误报),漂移产生
|
|
240
|
+
// structure/functions-doc-drift finding(warning,不拦提交但提示运行 doc-func.mjs apply)。
|
|
241
|
+
appendFuncDocDrift(findings, repoPath);
|
|
242
|
+
appendSplitDocsCheck(findings, repoPath);
|
|
243
|
+
appendIgnoreBlindSpot(findings, repoPath, normFiles.length);
|
|
244
|
+
// 审计扩展自动接入(scripts/audit-ext/ 独立脚本动态加载,source: ext:<name>)
|
|
245
|
+
try {
|
|
246
|
+
findings.push(...(await runAuditExt(repoPath, { dir: opts.auditExtDir, log: opts.log })));
|
|
247
|
+
} catch (e) { log?.warn?.(`审计扩展执行失败:${e?.message || e}`); }
|
|
248
|
+
// 按规则包聚合命中数(侧边栏规则包列表的「拦截/警告/通过」= 实际命中数)
|
|
249
|
+
const slotStats = slotStatsFromFindings(findings, buildRuleSlotMap(compiled), countRulesBySlot(compiled));
|
|
250
|
+
// 文档加分制(0 分起、上限 10)——结构信号 + 交叉验证,**不进 findings**
|
|
251
|
+
// (不进扣分维度/门禁/问题计数),由 scoreQuality 的 context.docsScore 单独加分。
|
|
252
|
+
const docsScore = checkDocsScore(repoPath);
|
|
253
|
+
// 分析覆盖率(**信息项,不进评分**)——放在编排层算一次,CLI(cmdAudit)与插件工具(code_audit)
|
|
254
|
+
// 两条路径自然继承同一口径;只有完整文件集才可信(diff 范围返回 skipped,不给失真数字);
|
|
255
|
+
// opts.coverage === false 可整体关闭(大仓库省一次读取+解析)。
|
|
256
|
+
const analysisCoverage = opts.coverage === false
|
|
257
|
+
? null
|
|
258
|
+
: ((opts.scope || 'full') === 'full'
|
|
259
|
+
? await computeAnalysisCoverage({ files: normFiles.map((f) => ({ path: f.path, full: readText(f.full) || '' })) })
|
|
260
|
+
: { skipped: 'diff 范围只含变动文件,覆盖率需 scope=full' });
|
|
261
|
+
return {
|
|
262
|
+
ok: true, scope: opts.scope || 'full', repo: repoPath, findings, summary: summarize(findings), slotStats, files: normFiles.length,
|
|
263
|
+
docsScore,
|
|
264
|
+
analysisCoverage,
|
|
265
|
+
// 层级聚合 YAML(summary → 拦截级别 → 目录 → 文件 → 规则明细)
|
|
266
|
+
yaml: findingsToYaml(findings),
|
|
267
|
+
};
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
export async function auditFull(repoPath, opts = {}) {
|
|
271
|
+
const root = repoPath;
|
|
272
|
+
// `.auditignore` 原先仅在 git 仓库生效(内部走 git check-ignore),
|
|
273
|
+
// 非 git 目录下该文件形同不存在。现在非 git 但**存在 .auditignore** 时也把 root 传下去,
|
|
274
|
+
// 由 collector 切换到纯 JS 匹配器兜底(lib/audit/gitignore-match.js),
|
|
275
|
+
// 两种路径返回同构的忽略集,调用方无感知。不存在该文件时仍传 null,避免无谓遍历。
|
|
276
|
+
const isGit = isGitRepo(root);
|
|
277
|
+
const hasAuditIgnore = existsSync(join(root, '.auditignore'));
|
|
278
|
+
// 门控补 `.gitignore`:非 git 目录(解压源码包 / 临时导出 / 克隆未完成)同样带 `.gitignore`,
|
|
279
|
+
// 此前只认「git 仓库 or .auditignore」⇒ 这类目录的 .gitignore 被完全无视,被忽略的内容
|
|
280
|
+
// 照样进审计(实测:默认与 --include-ignored 结果一致,属审计范围 bug)。
|
|
281
|
+
const hasGitIgnore = existsSync(join(root, '.gitignore'));
|
|
282
|
+
const gitIgnoreRoot = opts.gitIgnoreRoot !== false && (isGit || hasAuditIgnore || hasGitIgnore) ? root : null;
|
|
283
|
+
const collected = await collectTextFiles(root, {
|
|
284
|
+
depth: opts.depth ?? 10,
|
|
285
|
+
gitIgnoreRoot,
|
|
286
|
+
includeIgnored: opts.includeIgnored,
|
|
287
|
+
testExemptRoot: root,
|
|
288
|
+
});
|
|
289
|
+
// 大仓库降级:超上限按「变动优先」截断,避免弱 CPU 上扫几万文件卡死(见 capScanFiles)
|
|
290
|
+
const { files, truncated } = capScanFiles(collected, root, opts.maxScanFiles);
|
|
291
|
+
return auditFiles(repoPath, files, { ...opts, scope: 'full', truncated });
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
/** 把「目录树宿主 md 漂移」(tree-doc checkDrift)并入审计 findings。
|
|
295
|
+
* 宿主不再死认 README.md——自动探测含 dshgp-tree 标记块的 md
|
|
296
|
+
* (README 有块用 README;否则找 docs/ 等含块的 md),findings.file 用宿主相对路径。 */
|
|
297
|
+
function appendTreeDocDrift(findings, repoPath) {
|
|
298
|
+
try {
|
|
299
|
+
const host = findMarkedHostMd(repoPath, 'dshgp-tree');
|
|
300
|
+
if (!existsSync(host)) return; // 无宿主 md 不检查
|
|
301
|
+
const r = checkDrift({ readmePath: host, root: repoPath });
|
|
302
|
+
if (!r || !Array.isArray(r.issues)) return;
|
|
303
|
+
const hostRel = relative(repoPath, host) || README_FILE_NAME;
|
|
304
|
+
const real = (r.issues || []).filter((i) => i.type !== 'no-block'); // 无树块=未启用,非漂移
|
|
305
|
+
if (real.length) {
|
|
306
|
+
// missing(新增未更新)= 提交中间态——未跟踪新文件提交前 gitLsFiles 计入
|
|
307
|
+
// 而宿主导树未及 apply,提交后 sync/apply 自动消除 → 降 notice 不扣分;
|
|
308
|
+
// stale/orphan(树列已删文件 / 索引映射不存在)= 真漂移 → warning 保持。
|
|
309
|
+
const missing = real.filter((i) => i.type === 'missing');
|
|
310
|
+
const bad = real.filter((i) => i.type !== 'missing');
|
|
311
|
+
if (missing.length) {
|
|
312
|
+
findings.push(makeFinding({
|
|
313
|
+
file: hostRel, line: 1, rule: 'structure/tree-doc-drift', kind: 'max-depth',
|
|
314
|
+
severity: 'notice',
|
|
315
|
+
message: `${hostRel} 目录树待更新:${missing.map((i) => i.msg).join(';')}(新增文件,git 提交后运行 doc-tree.mjs sync/apply 登记)`,
|
|
316
|
+
dimensions: ['可维护性'], scoreImpact: 0,
|
|
317
|
+
}));
|
|
318
|
+
}
|
|
319
|
+
if (bad.length) {
|
|
320
|
+
findings.push(makeFinding({
|
|
321
|
+
file: hostRel, line: 1, rule: 'structure/tree-doc-drift', kind: 'max-depth',
|
|
322
|
+
severity: 'warning', message: `${hostRel} 目录树漂移:${bad.map((i) => i.msg).join(';')}(运行 doc-tree.mjs sync/apply 修复)`,
|
|
323
|
+
dimensions: ['可维护性'], scoreImpact: 1,
|
|
324
|
+
}));
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
// 工作区未提交变动文件 → notice 提示「注释可能需更新」(tree-doc 已记录 mtime)。
|
|
328
|
+
const wt = (r.worktreeChanges && Object.entries(r.worktreeChanges)) || [];
|
|
329
|
+
if (wt.length) {
|
|
330
|
+
const by = (code) => wt.filter(([, v]) => v?.status === code).length;
|
|
331
|
+
findings.push(makeFinding({
|
|
332
|
+
file: hostRel, line: 1, rule: 'structure/tree-doc-worktree-change', kind: 'max-depth',
|
|
333
|
+
severity: 'notice',
|
|
334
|
+
message: `工作区 ${wt.length} 个文件有未提交变动(M ${by('M')} / A ${by('A')} / D ${by('D')})——doc-tree 已记录修改时间,相关文件注释可能需更新;git 提交后重新 doc-tree sync 清除提示`,
|
|
335
|
+
dimensions: ['可维护性'], scoreImpact: 0,
|
|
336
|
+
}));
|
|
337
|
+
}
|
|
338
|
+
} catch { /* 宿主缺失/非 git 目录:跳过(不因漂移检查失败干扰审计) */ }
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
// 把「函数列表宿主 md 漂移」(doc-func checkFuncDrift)并入审计 findings。
|
|
342
|
+
// 口径与 appendTreeDocDrift 一致:**宿主 md 带 dshgp-functions 标记块才检查**——
|
|
343
|
+
// 其他作者的仓库没有这份文档 → 直接返回,不产生任何 finding(避免对外仓误报)。
|
|
344
|
+
// 漂移 = 块内容与最新扫描不一致(典型:新增函数未登记)→ warning(提示运行 doc-func.mjs apply);
|
|
345
|
+
// 无标记块(type=no-block)视为「未启用该文档」,不算漂移。
|
|
346
|
+
// 为什么用 warning 而非 tree 的 notice:tree 的 missing 属提交中间态(提交后 apply 自动消除),
|
|
347
|
+
// 函数列表漂移在提交后依然存在(没人跑 apply 就一直不一致),保持 warning 才会被看见。
|
|
348
|
+
function appendFuncDocDrift(findings, repoPath) {
|
|
349
|
+
try {
|
|
350
|
+
const host = findMarkedHostMd(repoPath, 'dshgp-functions');
|
|
351
|
+
if (!existsSync(host)) return; // 无宿主 md 不检查(非本插件生态的仓库天然跳过)
|
|
352
|
+
const r = checkFuncDrift({ hostPath: host, root: repoPath });
|
|
353
|
+
if (!r || !Array.isArray(r.issues)) return;
|
|
354
|
+
const hostRel = relative(repoPath, host) || README_FILE_NAME;
|
|
355
|
+
const real = r.issues.filter((i) => i.type !== 'no-block'); // 无块=未启用,非漂移
|
|
356
|
+
if (!real.length) return;
|
|
357
|
+
findings.push(makeFinding({
|
|
358
|
+
file: hostRel, line: 1, rule: 'structure/functions-doc-drift', kind: 'max-depth',
|
|
359
|
+
severity: 'warning',
|
|
360
|
+
message: `${hostRel} 函数列表漂移:${real.map((i) => i.msg).join(';')}`,
|
|
361
|
+
dimensions: ['可维护性'], scoreImpact: 1,
|
|
362
|
+
}));
|
|
363
|
+
} catch { /* 宿主缺失/扫描失败:跳过(不因漂移检查失败干扰审计) */ }
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
/**
|
|
367
|
+
* 分体式文档审计:版本记录 / 函数列表等长文档不应直接内嵌 README,
|
|
368
|
+
* 应存独立 md 并带标记块(`<!-- dshgp-<marker>:start/end -->`),README 只链接引用。
|
|
369
|
+
* 复用公共探测 findMarkedHostMd(repo, marker):宿主=README.md(有标记)或 docs/ 下带标记的 md。
|
|
370
|
+
* 宿主缺失(README 无标记块且无 docs/ 对应 md)→ warning 提示建分体文档。
|
|
371
|
+
*/
|
|
372
|
+
function appendSplitDocsCheck(findings, repoPath) {
|
|
373
|
+
// 只对 dsh 插件仓库生效(外溢误报修复):dshgp-version/dshgp-functions
|
|
374
|
+
// 标记块是 dsh 插件生态的文档组织规范,对任意项目报「版本记录应分体存放」属规则
|
|
375
|
+
// 不适配(pix-ezviewer 等外部项目被报)。判定:package.json 的 name 以 dsh- 开头
|
|
376
|
+
// (dsh 插件唯一特征)——普通 JS/Java/Python 项目不查。
|
|
377
|
+
try {
|
|
378
|
+
const pkgPath = join(repoPath, 'package.json');
|
|
379
|
+
if (existsSync(pkgPath)) {
|
|
380
|
+
const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'));
|
|
381
|
+
const name = String(pkg?.name || '');
|
|
382
|
+
if (!name.startsWith('dsh-')) return;
|
|
383
|
+
} else return; // 无 package.json 的仓库(Java/Android/Python 等)非 dsh 插件
|
|
384
|
+
} catch { return; }
|
|
385
|
+
// 采用门控(2026-10-13 用户修正):**仓库必须已经用了我们的标记块**(dshgp-version / dshgp-functions /
|
|
386
|
+
// dshgp-tree 任一带来标记块内容),本检查才生效。别人可能压根不想要文档维护,或只是不想用我们这套
|
|
387
|
+
// 自带管理 ⇒ 那种仓库不进审计、零 finding(此前只按「package.json name 以 dsh- 开头」判定,
|
|
388
|
+
// 对不用我们文档管理的 dsh 插件也会提示建分体文档,属越界)。
|
|
389
|
+
const adopted = ['dshgp-version', 'dshgp-functions', 'dshgp-tree'].some((mk) => {
|
|
390
|
+
try {
|
|
391
|
+
const h = findMarkedHostMd(repoPath, mk);
|
|
392
|
+
return existsSync(h) && hasMarkBlock(readFileSync(h, 'utf8'), mk);
|
|
393
|
+
} catch { return false; }
|
|
394
|
+
});
|
|
395
|
+
if (!adopted) return;
|
|
396
|
+
const specs = [
|
|
397
|
+
{ marker: 'dshgp-version', label: '版本记录', file: 'docs/ 带 dshgp-version 标记块的 md(如 CHANGELOG.md)', rule: 'structure/version-host-missing' },
|
|
398
|
+
{ marker: 'dshgp-functions', label: '函数列表', file: 'docs/ 带 dshgp-functions 标记块的 md(如 FUNCTIONS.md)', rule: 'structure/functions-host-missing' },
|
|
399
|
+
];
|
|
400
|
+
for (const sp of specs) {
|
|
401
|
+
try {
|
|
402
|
+
const host = findMarkedHostMd(repoPath, sp.marker);
|
|
403
|
+
if (!existsSync(host)) continue; // 宿主缺失(repo 不存在/无 md)跳过 // dsh-skip-residue(固定 2 项 spec 的循环,I/O 开销恒定极小)
|
|
404
|
+
const hostRel = relative(repoPath, host) || README_FILE_NAME;
|
|
405
|
+
const inReadme = hostRel === README_FILE_NAME;
|
|
406
|
+
const hasBlock = (() => { try { return hasMarkBlock(readFileSync(host, 'utf8'), sp.marker); } catch { return false; } })(); // dsh-skip-residue(同上)
|
|
407
|
+
// 宿主是 README 但 README 无该标记块 → 未建立分体文档 → 提示
|
|
408
|
+
if (inReadme && !hasBlock) {
|
|
409
|
+
// README 内嵌该文档视为「未分体」——提示迁 docs/(notice,不拦,非错误)
|
|
410
|
+
findings.push(makeFinding({
|
|
411
|
+
file: README_FILE_NAME, line: 1, rule: sp.rule, kind: 'min-occurrences',
|
|
412
|
+
severity: 'info',
|
|
413
|
+
message: `分体式文档建议:${sp.label}建议存 ${sp.file}(带 ${sp.marker} 标记块),README 仅链接引用;若坚持内嵌 README 可豁免(docs/skill「文档组织」节)`,
|
|
414
|
+
dimensions: ['可维护性'], scoreImpact: 0, exemptHint: 'dsh-skip-style(文件头=整文件)',
|
|
415
|
+
}));
|
|
416
|
+
} else if (!inReadme) {
|
|
417
|
+
// 分体成立:宿主是 docs/ 的 md → 确认该文档存在且标记块完整
|
|
418
|
+
findings.push(makeFinding({
|
|
419
|
+
file: hostRel, line: 1, rule: sp.rule + '-ok', kind: 'min-occurrences',
|
|
420
|
+
severity: 'info', message: `${sp.label}已分体存放(${hostRel},${sp.marker} 标记块就绪),README 链接引用 ✓`,
|
|
421
|
+
dimensions: ['可维护性'], scoreImpact: 0, exemptHint: 'dsh-skip-style(文件头=整文件)',
|
|
422
|
+
}));
|
|
423
|
+
}
|
|
424
|
+
} catch { /* 非 git 目录跳过 */ }
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
/** 供 appendSplitDocsCheck 用的标记块存在性判断(复用 findBlock 语义,局部实现避免循环依赖)。 */
|
|
429
|
+
function hasMarkBlock(text, marker) {
|
|
430
|
+
return text.indexOf(`<!-- ${marker}:start -->`) !== -1 && text.indexOf(`<!-- ${marker}:end -->`) !== -1;
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
/** 改动审计:git status --porcelain 取工作区变动文件 → 逐文件审计(仅 git 项目)。
|
|
434
|
+
* 非 git 项目退化为 auditFull,但 scope 仍标记 changed(调用方语义一致)。
|
|
435
|
+
*/
|
|
436
|
+
export async function auditChanged(repoPath, opts = {}) {
|
|
437
|
+
const changed = collectChangedFiles(repoPath);
|
|
438
|
+
if (changed === null) {
|
|
439
|
+
const auditRes = await auditFull(repoPath, opts);
|
|
440
|
+
auditRes.scope = 'changed';
|
|
441
|
+
return auditRes;
|
|
442
|
+
}
|
|
443
|
+
// 删除的没有可读内容;非文本文件(png/jpg 等二进制扩展名、>1MB)跳过——
|
|
444
|
+
// 1.0.13 修复:PNG 等图片改动进 diff 审计会被 readText 以 UTF-8 读入 → 二进制乱码触发 regex 误报
|
|
445
|
+
// 修复:.auditignore 目录豁免对 changed 扫描生效(此前仅 full 扫描生效——
|
|
446
|
+
// collectChangedFiles 只过滤了 .test 空文件目录,.auditignore 声明「不审计但入库」的
|
|
447
|
+
// 文件/目录(如油猴脚本 scripts/)在 diff 审计里仍被扫,函数长度等规则误拦提交)。
|
|
448
|
+
// 判定复用 git check-ignore(core.excludesFile=.auditignore,与 full 扫描同一语义)。
|
|
449
|
+
const auditIgnorePath = join(repoPath, '.auditignore');
|
|
450
|
+
const hasAuditIgnore = existsSync(auditIgnorePath);
|
|
451
|
+
const ignoreExtraArgs = hasAuditIgnore ? ['-c', `core.excludesFile=${auditIgnorePath}`] : [];
|
|
452
|
+
const isAuditIgnored = (rel) => {
|
|
453
|
+
if (!hasAuditIgnore) return false;
|
|
454
|
+
try {
|
|
455
|
+
// 修复:补 --no-index——git check-ignore 默认只对未跟踪文件生效,
|
|
456
|
+
// 已跟踪文件(如 templates/js/core/app.js)即使命中 .auditignore 规则也不忽略
|
|
457
|
+
// (退出码 1);加 --no-index 强制按路径匹配 ignore 规则,已跟踪文件同样命中。
|
|
458
|
+
// 与全量审计 collector.js 的 check-ignore 调用(--stdin --no-index)对齐,
|
|
459
|
+
// 否则「.auditignore 目录豁免对 changed 扫描生效」只对未跟踪文件成立。
|
|
460
|
+
execFileSync('git', ['-C', repoPath, ...ignoreExtraArgs, 'check-ignore', '-q', '--no-index', '--', rel], {
|
|
461
|
+
encoding: 'utf8', timeout: CHECK_IGNORE_TIMEOUT_MS, stdio: ['ignore', 'pipe', 'pipe'],
|
|
462
|
+
});
|
|
463
|
+
return true; // exit 0 = 命中忽略
|
|
464
|
+
} catch { return false; } // exit 1 = 未忽略;异常保守视为不忽略
|
|
465
|
+
};
|
|
466
|
+
const targets = changed.filter((f) => f.status !== 'D' && isTextFile(f.full) && !isAuditIgnored(f.rel));
|
|
467
|
+
// 重构:与 full 共用 auditFiles 公共核心——规则编译/逐文件审计/仓库级
|
|
468
|
+
// 检查(locale/folder)/private/收尾/slotStats/docsScore/yaml 全部统一,范围天然由
|
|
469
|
+
// targets 决定(repoHasJsYamlImport 与 repoLevel 代表文件按本次变动取,同旧语义)。
|
|
470
|
+
return auditFiles(repoPath, targets, { ...opts, scope: 'changed' });
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
/** 统一审计入口(设置项 auditScanScope 决定默认走哪个)。 */
|
|
474
|
+
export async function auditWithScope(repoPath, { scope = 'diff', ...opts } = {}) {
|
|
475
|
+
return scope === 'full' ? await auditFull(repoPath, opts) : auditChanged(repoPath, opts);
|
|
476
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 审计对外门面(稳定 API 面)—— 审计按独立包设计的对外契约。
|
|
3
|
+
*
|
|
4
|
+
* 为什么需要本文件(2026-10-13):
|
|
5
|
+
* 审计部分要能被别的 DSH 插件/项目依赖(长期目标是独立 npm 包,当前形态是整包子路径导出),
|
|
6
|
+
* 因此对外只暴露**冻结的最小面**,其余导出(checks/rule/score 内部件)视为内部实现,可随时调整。
|
|
7
|
+
* 外部用法:node: `import { auditWithScope } from 'dsh-git-push/audit'`
|
|
8
|
+
*
|
|
9
|
+
* 稳定性承诺:本文件导出的符号只在 minor/major 版本变更时才会增删(随整包发版,见
|
|
10
|
+
* 开发者文档/dsh-git-push/审计独立包设计-20261013.md;抽成独立包时本文件整体搬走,消费方 import 路径不变)。
|
|
11
|
+
*
|
|
12
|
+
* 依赖边界:本文件及其依赖的子图**不得**引用宿主(cordis / @deepseek-ai/* / lib/app / lib/plugin / lib/cli /
|
|
13
|
+
* lib/client / scripts/**)——由 test/test-audit-git-boundary.mjs 机器门禁守住。
|
|
14
|
+
*/
|
|
15
|
+
export {
|
|
16
|
+
auditWithScope, // 按范围审计(提交门禁用:diff / full)
|
|
17
|
+
auditFull, // 全量审计
|
|
18
|
+
auditChanged, // 仅改动集
|
|
19
|
+
auditFile, // 单文件审计
|
|
20
|
+
buildRuleSlotMap, // 规则槽位映射
|
|
21
|
+
summarize, // findings → 结论汇总
|
|
22
|
+
} from './index.js';
|
|
23
|
+
|
|
24
|
+
export { formatAnalysisCoverageLine } from './analysis-coverage.js';
|