dsh-git-push 2.20.19 → 3.1.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 +76 -47
- package/cli-tool.mjs +2 -4
- package/cli.mjs +11 -4
- package/lib/app/apply.js +15 -13
- package/lib/app/command-registry.js +26 -19
- package/lib/app/handlers/http-constants.js +8 -0
- package/lib/app/handlers/meta.js +2 -2
- package/lib/app/handlers/preprocess.js +104 -0
- package/lib/app/handlers/repo-actions.js +2 -3
- package/lib/app/handlers/repos.js +137 -10
- package/lib/app/handlers/settings.js +34 -15
- package/lib/app/http-handlers.js +13 -42
- package/lib/app/index.js +3 -2
- package/lib/app/inject-text.js +6 -21
- package/lib/app/preprocess-client.js +136 -0
- package/lib/app/repo-ownership.js +1 -1
- package/lib/app/schema.js +20 -10
- package/lib/app/settings-bridge.js +60 -8
- package/lib/app/severity.js +14 -0
- package/lib/app/slash-commands.js +5 -164
- package/lib/app/tool-call.js +96 -163
- package/lib/cli/commands-preprocess.mjs +74 -0
- package/lib/cli/commands-tool.mjs +3 -2
- package/lib/cli/commands-vcs.mjs +39 -5
- package/lib/cli/shared.mjs +36 -10
- package/lib/client/index.js +11 -16
- package/lib/client-parts/git/account.js +21 -12
- package/lib/client-parts/git/actions.js +23 -77
- package/lib/client-parts/git/apply.js +8 -2
- package/lib/client-parts/git/browser.js +1 -1
- package/lib/client-parts/git/const.js +33 -1
- package/lib/client-parts/git/controller.js +175 -176
- package/lib/client-parts/git/icons.js +1 -1
- package/lib/client-parts/git/loader.js +1 -1
- package/lib/client-parts/git/npm.js +56 -37
- package/lib/client-parts/git/page.js +53 -1
- package/lib/client-parts/git/repo.js +8 -1
- package/lib/client-parts/git/settings.js +13 -1
- package/lib/client-parts/git/state.js +237 -0
- package/lib/client-parts/git/utils.js +1 -1
- package/lib/client.js +631 -312
- package/lib/commit-push/pre-commit-engine.js +629 -30
- package/lib/commit-push.js +127 -67
- package/lib/context/index.js +7 -5
- package/lib/core/config.js +1 -27
- package/lib/core/exec.js +2 -11
- package/lib/{exempt/index.js → git/exempt-markers.js} +8 -1
- package/lib/git/identity-rewrite.js +1 -1
- package/lib/git/ignore.js +1 -1
- package/lib/git/index.js +1 -1
- package/lib/git/push.js +2 -17
- package/lib/git/repo-index.js +8 -3
- package/lib/git/repos.js +2 -2
- package/lib/git/sensitive.js +1 -1
- package/lib/npm/install.js +1 -1
- package/lib/npm/publish.js +20 -5
- package/lib/npm/registry.js +2 -2
- package/lib/plugin/auto-push.js +5 -8
- package/lib/preprocess/providers.js +195 -0
- package/lib/self/index.js +1 -1
- package/lib/skip-dirs.js +14 -55
- package/package.json +31 -42
- package/skills/dev/dsh-git-push.md +9 -9
- package/skills/guide/guide-commit-push.md +11 -13
- package/skills/workflow/README.md +0 -1
- package/skills/workflow/task-completion-report.md +2 -2
- package/.auditignore +0 -30
- package/.gitignore +0 -43
- package/cli-audit.mjs +0 -141
- package/lib/BUGFIX-NOTES-2026-09-14.md +0 -278
- package/lib/app/audit-api.js +0 -173
- package/lib/app/handlers/audit.js +0 -150
- package/lib/app/host-doc-checks.js +0 -25
- package/lib/app/schema-audit.js +0 -42
- 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/preprocess/audit.js +0 -98
- package/lib/preprocess/index.js +0 -78
- 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/lib/user-requirements.json +0 -15
- 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/build-client.mjs +0 -131
- package/scripts/bump-version.mjs +0 -178
- package/scripts/check-js-scope.mjs +0 -87
- package/scripts/check.mjs +0 -203
- package/scripts/clean-date-comments.py +0 -102
- package/scripts/cpu-sample.mjs +0 -188
- package/scripts/doc-drift.mjs +0 -200
- package/scripts/doc-func.mjs +0 -212
- package/scripts/doc-tree.mjs +0 -458
- package/scripts/doc-version.mjs +0 -149
- 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/local-registry.mjs +0 -37
- 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/scan-version.mjs +0 -125
- package/scripts/symbol-index.mjs +0 -85
- package/scripts/verify-prestep.mjs +0 -100
- package/scripts/version-source.mjs +0 -173
- 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/{audit-defaults.js → git/defaults.js} +0 -0
package/lib/preprocess/index.js
DELETED
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 预处理能力汇总层(git 侧只与这一层打交道)
|
|
3
|
-
*
|
|
4
|
-
* 「预处理」= 提交前要跑的外部能力(当前只有审计;将来可能还有 lint / 类型检查 / 安全扫描)。
|
|
5
|
-
* 每个预处理贡献三项能力(见 ./audit.js 头部注释):`params` / `enabled` / `renderResult`。
|
|
6
|
-
* git 侧不 import 任何具体预处理的实现,只调用本层的三个函数 —— 这样加/去掉一个预处理时,
|
|
7
|
-
* git 侧只需改配置或注册表,不用改代码路径。
|
|
8
|
-
*
|
|
9
|
-
* ── 三样刻意留在 git 侧,**不要**搬进预处理(搬了就会出真问题)──
|
|
10
|
-
* ① **`blocked` 布尔**:`lib/app/tool-call.js` 的 `pushJobOutcome` 用它决定
|
|
11
|
-
* 「未推送(被拦截)」还是「未完成:<原因>」——这是「被拦截 ≠ 执行失败」的语义分叉,
|
|
12
|
-
* 属 job 状态机,与审计判定无关。预处理只给文案,不决定 job 状态。
|
|
13
|
-
* ② **引擎 spawn 失败文案**:`lib/commit-push/pre-commit-engine.js` 里的
|
|
14
|
-
* 「找不到引擎命令 / 引擎不可用」。引擎自己没被找到时根本不会执行,
|
|
15
|
-
* 它无法生成「我没被找到」这句话 —— 只有拉起它的 git 侧知道。
|
|
16
|
-
* ③ **兜底默认文案**:预处理可能不可用、可能没实现 renderResult、可能抛错,
|
|
17
|
-
* git 侧必须有一份中性兜底(`lib/commit-push.js` 的 `defaultPreprocessRender`),
|
|
18
|
-
* 保证**不崩、不静默丢信息**。本层只负责「合并谁的渲染结果」,不提供兜底文案。
|
|
19
|
-
*/
|
|
20
|
-
|
|
21
|
-
import { auditPreprocess, auditPreprocessAvailable, AUDIT_COMMIT_PARAMS } from './audit.js';
|
|
22
|
-
|
|
23
|
-
/** 已注册的预处理(当前只有审计;新增时在这里追加,git 侧零改动)。 */
|
|
24
|
-
export const PREPROCESSORS = [auditPreprocess];
|
|
25
|
-
|
|
26
|
-
// 供 command-registry 等历史调用方按原路径继续引用(参数与可用性判据的公开面不变)
|
|
27
|
-
export { auditPreprocess, auditPreprocessAvailable, AUDIT_COMMIT_PARAMS };
|
|
28
|
-
|
|
29
|
-
/**
|
|
30
|
-
* 汇总所有**可用**预处理贡献的参数。
|
|
31
|
-
* @param {object} [cfg] 插件配置
|
|
32
|
-
* @param {boolean} [hasBuiltinEngine] 仅供测试注入
|
|
33
|
-
* @param {Array} [preprocessors] 预处理列表(测试可注入)
|
|
34
|
-
* @returns {Array} 参数 schema 数组
|
|
35
|
-
*/
|
|
36
|
-
export function preprocessParams(cfg = {}, hasBuiltinEngine, preprocessors = PREPROCESSORS) {
|
|
37
|
-
const out = [];
|
|
38
|
-
for (const pp of preprocessors) {
|
|
39
|
-
const enabled = typeof pp.enabled === 'function' ? pp.enabled(cfg, hasBuiltinEngine) : true;
|
|
40
|
-
if (!enabled) continue;
|
|
41
|
-
if (Array.isArray(pp.params)) out.push(...pp.params);
|
|
42
|
-
}
|
|
43
|
-
return out;
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
/**
|
|
47
|
-
* 让**可用**的预处理渲染自己的结果文案。
|
|
48
|
-
*
|
|
49
|
-
* 合并策略:按注册顺序取第一个提供 `renderResult` 的预处理的结果;
|
|
50
|
-
* 多项都提供时逐字段后者覆盖前者(`error` / `apiGuide` / `notes` 各自独立)。
|
|
51
|
-
* 为什么不是"第一个非空就停":`notes` 可能只有某一个预处理提供,逐字段合并更不容易丢信息。
|
|
52
|
-
* 失败策略:任何预处理抛错都**吞掉并继续**——渲染文案失败绝不能把提交门禁带崩
|
|
53
|
-
* (判定已经做完了,这里只是措辞)。
|
|
54
|
-
* @param {object} ctx 数据契约见 lib/preprocess/audit.js 的 auditRenderResult
|
|
55
|
-
* @param {object} [cfg] 插件配置
|
|
56
|
-
* @param {Array} [preprocessors] 预处理列表(测试可注入,传 [] 可验证兜底)
|
|
57
|
-
* @returns {{error?: string, apiGuide?: string, notes?: object}|undefined}
|
|
58
|
-
*/
|
|
59
|
-
export function renderPreprocessResult(ctx = {}, cfg = {}, preprocessors = PREPROCESSORS) {
|
|
60
|
-
let merged;
|
|
61
|
-
for (const pp of preprocessors) {
|
|
62
|
-
const enabled = typeof pp.enabled === 'function' ? pp.enabled(cfg) : true;
|
|
63
|
-
if (!enabled) continue;
|
|
64
|
-
if (typeof pp.renderResult !== 'function') continue;
|
|
65
|
-
let partial;
|
|
66
|
-
try {
|
|
67
|
-
partial = pp.renderResult(ctx);
|
|
68
|
-
} catch {
|
|
69
|
-
continue; // 渲染失败不阻断:留给兜底文案
|
|
70
|
-
}
|
|
71
|
-
if (!partial || typeof partial !== 'object') continue;
|
|
72
|
-
merged = merged || {};
|
|
73
|
-
if (partial.error !== undefined) merged.error = partial.error;
|
|
74
|
-
if (partial.apiGuide !== undefined) merged.apiGuide = partial.apiGuide;
|
|
75
|
-
if (partial.notes && typeof partial.notes === 'object') merged.notes = { ...(merged.notes || {}), ...partial.notes };
|
|
76
|
-
}
|
|
77
|
-
return merged;
|
|
78
|
-
}
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 编译层 · 凭据类 kind(三个,对应原文件「凭据三类」分段)
|
|
3
|
-
*
|
|
4
|
-
* credential-ref(代码里引用凭据变量)、credential-file(凭据文件入库)、
|
|
5
|
-
* [FUNC]([FUNC]/secret- 前缀规则的 pattern 批量编译,安全红线类规则用它)。
|
|
6
|
-
* 三者的共同点是「什么算凭据」的判定语汇,拆开会让判定散落多处,故合成一个模块。
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { registerCompiler } from '../registry.js';
|
|
10
|
-
import { DIMENSIONS, ruleOut, safeRe, severityLevel, pickDimensions } from './helpers.js';
|
|
11
|
-
|
|
12
|
-
/* ───────────────────────── 注册:凭据三类 ───────────────────────── */
|
|
13
|
-
|
|
14
|
-
registerCompiler(
|
|
15
|
-
'credential-ref',
|
|
16
|
-
(r) => /^credref-/.test(r?.id || ''),
|
|
17
|
-
(r, ctx) => {
|
|
18
|
-
const list = [r.pattern, ...(Array.isArray(r.patterns) ? r.patterns : [])].filter(Boolean)
|
|
19
|
-
.map((p) => safeRe(p, r?.name || r?.id, ctx.errors)).filter(Boolean);
|
|
20
|
-
return ruleOut({
|
|
21
|
-
id: r.id, name: r.name || r.id, kind: 'credential-ref', severity: r.severity,
|
|
22
|
-
// patterns 必须传编译后 RegExp(checks.js 直接 p.test(line))
|
|
23
|
-
pattern: list[0], patterns: list.length > 1 ? list.slice(1) : undefined,
|
|
24
|
-
message: r.description || r.name || '凭据引用模式',
|
|
25
|
-
dimensions: pickDimensions(r, [DIMENSIONS.安全性], ctx?.errors),
|
|
26
|
-
});
|
|
27
|
-
},
|
|
28
|
-
);
|
|
29
|
-
|
|
30
|
-
registerCompiler(
|
|
31
|
-
'credential-file',
|
|
32
|
-
(r) => /^credfile-/.test(r?.id || ''),
|
|
33
|
-
(r, ctx) => {
|
|
34
|
-
const re = safeRe(r?.path_pattern || r?.pathPattern || '', r?.name || r?.id, ctx.errors);
|
|
35
|
-
return ruleOut({
|
|
36
|
-
id: r.id, name: r.name || r.id, kind: 'credential-file', severity: r.severity,
|
|
37
|
-
// bugfix:补 level(severityLevel:error→blocker)。原缺省默认 warning,
|
|
38
|
-
// 导致 checkCredentialFiles 的 capSeverity('error', 'blocker') 永远不升 blocker,
|
|
39
|
-
// 与文档契约「yml error → 引擎级 blocker 拦截」不一致,.env 等凭据文件提交不拦截。
|
|
40
|
-
level: severityLevel(r.severity),
|
|
41
|
-
pathPattern: re?.source,
|
|
42
|
-
message: r.description || '凭据文件(路径模式)',
|
|
43
|
-
dimensions: pickDimensions(r, [DIMENSIONS.安全性], ctx?.errors),
|
|
44
|
-
});
|
|
45
|
-
},
|
|
46
|
-
);
|
|
47
|
-
|
|
48
|
-
registerCompiler(
|
|
49
|
-
'[FUNC]',
|
|
50
|
-
(r) => /^(\[FUNC\]|secret)-/.test(r?.id || ''),
|
|
51
|
-
(r, ctx) => {
|
|
52
|
-
const list = [r.pattern, ...(Array.isArray(r.patterns) ? r.patterns : [])].filter(Boolean)
|
|
53
|
-
.map((p) => safeRe(p, r?.name || r?.id, ctx.errors)).filter(Boolean);
|
|
54
|
-
return ruleOut({
|
|
55
|
-
id: r.id, name: r.name || r.id, kind: '[FUNC]', severity: r.severity,
|
|
56
|
-
// patterns 必须传编译后 RegExp(checks.js 直接 p.test(line))
|
|
57
|
-
pattern: list[0], patterns: list.length > 1 ? list.slice(1) : undefined,
|
|
58
|
-
message: r.description || `疑似敏感信息(${r.name || r.id})`,
|
|
59
|
-
dimensions: pickDimensions(r, [DIMENSIONS.安全性], ctx?.errors),
|
|
60
|
-
});
|
|
61
|
-
},
|
|
62
|
-
);
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 编译层 · 数据流类 kind(三层审计 L2 的 yml 侧,)
|
|
3
|
-
*
|
|
4
|
-
* 认领条件:yml 显式声明 kind: "dataflow"。
|
|
5
|
-
* 编译产物:kind=dataflow 的规则对象,携带 filePatterns(L1 文件内容初筛正则,
|
|
6
|
-
* 由 lib/checks/filter.js 的 filterRulesByFileText 消费——未命中 = 非候选文件,
|
|
7
|
-
* 该规则剔除,不进 L2 AST 精查)与 severity/dimensions。
|
|
8
|
-
*
|
|
9
|
-
* 铁律:加字段 = 加函数 + registerCompiler 一行注册;compileRule 主体永不修改。
|
|
10
|
-
* filePatterns 是「规则作用域」的一部分(内容级),与 exts(扩展名级)、
|
|
11
|
-
* exclude_paths(路径级)并列,三者都在 filter 层消费。
|
|
12
|
-
*/
|
|
13
|
-
|
|
14
|
-
import { registerCompiler } from '../registry.js';
|
|
15
|
-
import { DIMENSIONS, ruleOut, severityLevel, pickDimensions } from './helpers.js';
|
|
16
|
-
|
|
17
|
-
registerCompiler(
|
|
18
|
-
'dataflow',
|
|
19
|
-
(r) => r?.kind === 'dataflow',
|
|
20
|
-
(r) => ruleOut({
|
|
21
|
-
id: r.id, name: r.name || r.id, kind: 'dataflow', severity: r.severity || 'warning',
|
|
22
|
-
level: severityLevel(r.severity || 'warning'),
|
|
23
|
-
message: r.description || r.name || '',
|
|
24
|
-
dimensions: pickDimensions(r, [DIMENSIONS.健壮性]),
|
|
25
|
-
extra: {
|
|
26
|
-
// L1 文件内容初筛(filterRulesByFileText 消费):纯正则扫文件文本,
|
|
27
|
-
// 任一命中即候选文件进 L2;未声明 = 不做初筛(全文都算候选)。
|
|
28
|
-
// 字符串条目按子串包含匹配(免转义),RegExp 条目按 test 匹配。
|
|
29
|
-
filePatterns: Array.isArray(r.file_patterns) ? r.file_patterns.map((p) => {
|
|
30
|
-
if (p && typeof p.source === 'string') return new RegExp(p.source); // yml 里 /re/ 字面量形态
|
|
31
|
-
return String(p);
|
|
32
|
-
}) : undefined,
|
|
33
|
-
// L2 判定参数(传给 lib/ast/dataflow.js 的 checkClearAccessAst;缺省用内置默认)
|
|
34
|
-
clearMethods: Array.isArray(r.clear_methods) ? r.clear_methods : undefined,
|
|
35
|
-
accessMethods: Array.isArray(r.access_methods) ? r.access_methods : undefined,
|
|
36
|
-
},
|
|
37
|
-
}),
|
|
38
|
-
);
|
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 编译层 · 文件健康度 kind
|
|
3
|
-
*
|
|
4
|
-
* file-health:体量/结构/文档三维分级加权算健康分(与单条阈值规则的「超了就报」不同,
|
|
5
|
-
* 它是矩阵评分,故单独成模块)。
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import { registerCompiler } from '../registry.js';
|
|
9
|
-
import { DIMENSIONS, ruleOut, severityLevel, pickDimensions } from './helpers.js';
|
|
10
|
-
|
|
11
|
-
/* ───────────────────────── 默认参数(规则条目可用 snake_case 字段覆盖) ───────────────────────── */
|
|
12
|
-
|
|
13
|
-
/** 三维权重(合计 1.0):行数 / 大小 / 单行最大长度。 */
|
|
14
|
-
const DEFAULT_WEIGHT_LINES = 0.4;
|
|
15
|
-
const DEFAULT_WEIGHT_SIZE = 0.35;
|
|
16
|
-
const DEFAULT_WEIGHT_LINE_LENGTH = 0.25;
|
|
17
|
-
// 满分基准 / 下限分:与 lib/checks/file-health.js 共用同一来源(lib/audit-defaults.js)——
|
|
18
|
-
// 两处必须永远相等,各写一份会出现「编译器与检查器按不同基准判健康度」的静默不一致
|
|
19
|
-
// (自审 maintainability/duplicate-constant-def 报的真重复)。
|
|
20
|
-
import { HEALTH_BASE_SCORE as BASE_SCORE, HEALTH_MIN_SCORE as MIN_SCORE } from '../../audit-defaults.js';
|
|
21
|
-
/** 行数等级边界(4 个分隔点 → 0~4 级)。 */
|
|
22
|
-
const DEFAULT_LINE_LEVELS = [200, 400, 800, 1500];
|
|
23
|
-
/** 文件大小等级边界(KB)。 */
|
|
24
|
-
const DEFAULT_SIZE_LEVELS = [30, 100, 300, 1000];
|
|
25
|
-
/** 单行最大长度等级边界(字符)。 */
|
|
26
|
-
const DEFAULT_LINE_LENGTH_LEVELS = [120, 200, 300, 500];
|
|
27
|
-
/** 等级扣分表(level 0~4)。 */
|
|
28
|
-
const DEFAULT_PENALTIES = [0, 1.0, 2.5, 4.5, 7.0];
|
|
29
|
-
/** 严重度分界:score < WARN_SCORE 记 warning,< BLOCK_SCORE 记 blocker(与检查层同一来源)。 */
|
|
30
|
-
import { HEALTH_WARN_SCORE as WARN_SCORE, HEALTH_BLOCK_SCORE as BLOCK_SCORE } from '../../audit-defaults.js';
|
|
31
|
-
|
|
32
|
-
/* ───────────────────────── 注册:文件健康度矩阵(file-health,1.0.13) ───────────────────────── */
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* 文件健康度矩阵评分(确立算法)。
|
|
36
|
-
* 三维独立分级:行数(≤200/201-400/401-800/801-1500/>1500)、大小 KB(≤30/31-100/101-300/301-1000/>1000)、
|
|
37
|
-
* 单行最大长度(≤120/121-200/201-300/301-500/>500)→ 0~4 级;
|
|
38
|
-
* 加权等级 = 行数×0.40 + 大小×0.35 + 行长×0.25;扣分按等级表线性插值(0→0, 1→1.0, 2→2.5, 3→4.5, 4→7.0);
|
|
39
|
-
* score = max(0.1, 10 - penalty);score≥9 pass / 7≤score<9 warning / 5≤score<7 warning / score<5 blocker。
|
|
40
|
-
* 豁免:*.generated.* 与 *.min.* 与 locales/ 整文件跳过;constants/ 行数等级强制 0;routes/ 行数阈值放宽。
|
|
41
|
-
* 认领条件:kind==='file-health'。规则条目可覆盖参数(weight_lines/weight_size/weight_line_length/base_score)。
|
|
42
|
-
*/
|
|
43
|
-
registerCompiler(
|
|
44
|
-
'file-health',
|
|
45
|
-
(r) => r?.kind === 'file-health',
|
|
46
|
-
(r) => ruleOut({
|
|
47
|
-
id: r.id, name: r.name || r.id, kind: 'file-health', severity: r.severity || 'warning',
|
|
48
|
-
level: severityLevel(r.severity || 'warning'),
|
|
49
|
-
message: r.description || r.name || '',
|
|
50
|
-
dimensions: pickDimensions(r, [DIMENSIONS.可维护性, DIMENSIONS.可读性]),
|
|
51
|
-
extra: {
|
|
52
|
-
// 权重(合计 1.0;规则条目可覆盖)
|
|
53
|
-
weightLines: r.weight_lines !== undefined ? Number(r.weight_lines) : DEFAULT_WEIGHT_LINES,
|
|
54
|
-
weightSize: r.weight_size !== undefined ? Number(r.weight_size) : DEFAULT_WEIGHT_SIZE,
|
|
55
|
-
weightLineLength: r.weight_line_length !== undefined ? Number(r.weight_line_length) : DEFAULT_WEIGHT_LINE_LENGTH,
|
|
56
|
-
baseScore: r.base_score !== undefined ? Number(r.base_score) : BASE_SCORE,
|
|
57
|
-
// 等级边界(可覆盖:lines_levels/size_levels/line_length_levels 各 4 个阈值分隔点)
|
|
58
|
-
lineLevels: Array.isArray(r.lines_levels) ? r.lines_levels.map(Number) : [...DEFAULT_LINE_LEVELS],
|
|
59
|
-
sizeLevels: Array.isArray(r.size_levels) ? r.size_levels.map(Number) : [...DEFAULT_SIZE_LEVELS],
|
|
60
|
-
lengthLevels: Array.isArray(r.line_length_levels) ? r.line_length_levels.map(Number) : [...DEFAULT_LINE_LENGTH_LEVELS],
|
|
61
|
-
// 扣分表(level 0~4)
|
|
62
|
-
penalties: Array.isArray(r.level_penalties) ? r.level_penalties.map(Number) : [...DEFAULT_PENALTIES],
|
|
63
|
-
// 豁免(路径包含命中即按规则处理)
|
|
64
|
-
exemptSkip: ['generated.', '.min.', '/locales/', 'locales/'],
|
|
65
|
-
exemptConstants: ['/constants/', 'constants/'],
|
|
66
|
-
exemptRoutes: ['/routes/', 'routes/'],
|
|
67
|
-
// 只对代码文件评健康度——md/txt/json/yml 文档的「行数/行长」不是
|
|
68
|
-
// 代码健康问题(README 表格行天然超长、文档天然几百行),对文档评会误报。
|
|
69
|
-
exts: Array.isArray(r.exts) ? r.exts.map((x) => String(x).toLowerCase().replace(/^\./, '')) : undefined,
|
|
70
|
-
// 阈值:warning 与 blocker 分界(score<warnScore 报 warning,<blockScore 报 blocker)
|
|
71
|
-
warnScore: r.warn_score !== undefined ? Number(r.warn_score) : WARN_SCORE,
|
|
72
|
-
blockScore: r.block_score !== undefined ? Number(r.block_score) : BLOCK_SCORE,
|
|
73
|
-
},
|
|
74
|
-
}),
|
|
75
|
-
);
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 编译层 · 前端与工程约定类 kind(三个)
|
|
3
|
-
*
|
|
4
|
-
* button-bind(按钮是否绑定动作)、magic-number-smart(硬编码魔数,含版本号豁免)、
|
|
5
|
-
* patch-insert(bundle patch 必须顶层 insert)。
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import { registerCompiler } from '../registry.js';
|
|
9
|
-
import { DIMENSIONS, ruleOut, severityLevel, pickDimensions } from './helpers.js';
|
|
10
|
-
|
|
11
|
-
/* ───────────────────────── 注册:按钮事件绑定(button-bind,1.0.5 油猴脚本版) ───────────────────────── */
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* 按钮事件绑定交叉比对(油猴脚本/浏览器扩展专用)。
|
|
15
|
-
* 认领条件:显式 kind==='button-bind',或 category==='button' 且无 patterns/path_pattern(交叉比对型)。
|
|
16
|
-
* 编译产物:保留 id/severity/message/extra(checkButtonBindings 做同文件交叉比对)。
|
|
17
|
-
* 场景:HTML 以字符串内嵌 JS(innerHTML/insertAdjacentHTML/模板字符串/createElement),
|
|
18
|
-
* 事件在 JS 里 addEventListener/onclick= 绑定——不能只看 inline onclick。
|
|
19
|
-
*/
|
|
20
|
-
registerCompiler(
|
|
21
|
-
'button-bind',
|
|
22
|
-
(r) => r?.kind === 'button-bind' || (r?.category === 'button' && !Array.isArray(r?.patterns) && !r?.pattern && !r?.path_pattern),
|
|
23
|
-
(r) => ruleOut({
|
|
24
|
-
id: r.id, name: r.name || r.id, kind: 'button-bind', severity: r.severity || 'warning',
|
|
25
|
-
level: severityLevel(r.severity || 'warning'),
|
|
26
|
-
message: r.description || r.name || '',
|
|
27
|
-
dimensions: pickDimensions(r, [DIMENSIONS.可维护性]),
|
|
28
|
-
extra: {
|
|
29
|
-
buttonInsertPatterns: Array.isArray(r?.insertion_patterns) ? r.insertion_patterns : [],
|
|
30
|
-
bindPatterns: Array.isArray(r?.binding_patterns) ? r.binding_patterns : [],
|
|
31
|
-
},
|
|
32
|
-
}),
|
|
33
|
-
);
|
|
34
|
-
|
|
35
|
-
/* ───────────────────────── 注册:硬编码魔数检测(magic-number-smart,1.0.7 版本号豁免版) ───────────────────────── */
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* 智能硬编码魔数检测(规则来源:审计规则 YAML「硬编码魔数检测规则(版本号豁免版)」——版本号/HTTP 状态码等合法数字豁免)。
|
|
39
|
-
* 认领条件:kind==='magic-number-smart',或 id 含 magic-number-smart。
|
|
40
|
-
* 编译产物:保留 magicHints/legitHints/forceCount 到 extra(checkMagicNumberSmart 消费)。
|
|
41
|
-
* 合并:readability/magic-number(纯 regex 快速版)已并入本规则——smart 按
|
|
42
|
-
* 「数字 + 上下文 + 豁免清单」精确判定,覆盖运算/比较里的全部数字字面量形态,
|
|
43
|
-
* 版本号/日期/HTTP 状态码/常见合法常量/状态枚举/命名常量值不报。
|
|
44
|
-
*/
|
|
45
|
-
registerCompiler(
|
|
46
|
-
'magic-number-smart',
|
|
47
|
-
(r) => r?.kind === 'magic-number-smart' || /magic-number-smart/.test(r?.id || ''),
|
|
48
|
-
(r) => ruleOut({
|
|
49
|
-
id: r.id, name: r.name || r.id, kind: 'magic-number-smart', severity: r.severity || 'warning',
|
|
50
|
-
level: severityLevel(r.severity || 'warning'),
|
|
51
|
-
message: r.description || r.name || '',
|
|
52
|
-
dimensions: pickDimensions(r, [DIMENSIONS.可维护性]),
|
|
53
|
-
extra: {
|
|
54
|
-
magicHints: Array.isArray(r?.magic_number_hints) ? r.magic_number_hints : [],
|
|
55
|
-
legitHints: Array.isArray(r?.legitimate_hints) ? r.legitimate_hints : [],
|
|
56
|
-
forceCount: Number(r?.force_count) || 3,
|
|
57
|
-
// 透传 exts/excludePaths——魔数检测只对代码文件生效
|
|
58
|
-
// (README/CSS/JSON 里的版本号、端口、尺寸是正常书写,不构成硬编码魔数)
|
|
59
|
-
exts: Array.isArray(r.exts) ? r.exts.map((x) => String(x).toLowerCase().replace(/^\./, '')) : undefined,
|
|
60
|
-
excludePaths: Array.isArray(r.exclude_paths) ? r.exclude_paths.map(String) : undefined,
|
|
61
|
-
},
|
|
62
|
-
}),
|
|
63
|
-
);
|
|
64
|
-
|
|
65
|
-
/* ───────────────────────── 注册:patch insert 语义(patch-insert,1.1.1) ───────────────────────── */
|
|
66
|
-
|
|
67
|
-
/**
|
|
68
|
-
* cordis.patch.yml insert 语义检查(修复误报)。
|
|
69
|
-
* 认领条件:kind==='patch-insert'。
|
|
70
|
-
* 编译产物:透传 exts(只对 yml/yaml 生效)与 message,检查器做语义判定:
|
|
71
|
-
* 仅在「insert 块内的 id 与顶层按 id 覆盖行(非 insert 的 - id 行)同 id」时报,
|
|
72
|
-
* 替代旧「命中 insert: 行即提示」——纯 insert(无覆盖行同 id)不再误报。
|
|
73
|
-
*/
|
|
74
|
-
registerCompiler(
|
|
75
|
-
'patch-insert',
|
|
76
|
-
(r) => r?.kind === 'patch-insert',
|
|
77
|
-
(r) => ruleOut({
|
|
78
|
-
id: r.id, name: r.name || r.id, kind: 'patch-insert', severity: r.severity || 'warning',
|
|
79
|
-
level: severityLevel(r.severity || 'warning'),
|
|
80
|
-
message: r.description || r.name || '',
|
|
81
|
-
dimensions: pickDimensions(r, [DIMENSIONS.健壮性, DIMENSIONS.可部署性]),
|
|
82
|
-
extra: {
|
|
83
|
-
exts: Array.isArray(r.exts) ? r.exts.map((x) => String(x).toLowerCase().replace(/^\./, '')) : ['yml', 'yaml'],
|
|
84
|
-
},
|
|
85
|
-
}),
|
|
86
|
-
);
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 编译层 · 函数行数 kind
|
|
3
|
-
*
|
|
4
|
-
* func-lines(单函数行数阈值):yml 里 max_lines 且 name 含函数语义时走这里。
|
|
5
|
-
* 与 numeric-kinds 的 max-lines 区分:max-lines 管整文件行数。
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import { registerCompiler } from '../registry.js';
|
|
9
|
-
import { DIMENSIONS, ruleOut, severityLevel, pickDimensions } from './helpers.js';
|
|
10
|
-
|
|
11
|
-
/* ───────── 函数行数默认阈值 ───────── */
|
|
12
|
-
// 与 lib/checks/structural.js 共用同一来源(lib/audit-defaults.js)——两处必须永远相等,
|
|
13
|
-
// 各写一份会出现「编译器按 50 收口、检查器按别的值判定」的静默不一致(自审 duplicate-constant 报的真重复)
|
|
14
|
-
import { FUNC_LINES_DEFAULT } from '../../audit-defaults.js';
|
|
15
|
-
|
|
16
|
-
/* ───────────────────────── 注册:函数行数 ───────────────────────── */
|
|
17
|
-
|
|
18
|
-
registerCompiler(
|
|
19
|
-
'func-lines',
|
|
20
|
-
(r) => r?.id === 'func-lines' || (r?.max_lines !== undefined && /(function|函数|方法)/i.test(r?.name || '')),
|
|
21
|
-
(r) => {
|
|
22
|
-
const threshold = Number(r.max_lines) || FUNC_LINES_DEFAULT;
|
|
23
|
-
return ruleOut({
|
|
24
|
-
id: r.id, name: r.name || r.id, kind: 'func-lines', severity: r.severity,
|
|
25
|
-
level: severityLevel(r.severity), threshold,
|
|
26
|
-
message: r.description || '单函数超长难读,应拆分',
|
|
27
|
-
dimensions: pickDimensions(r, [DIMENSIONS.可读性, DIMENSIONS.可维护性]),
|
|
28
|
-
extra: {
|
|
29
|
-
blockThreshold: threshold * 2 || 100,
|
|
30
|
-
// 透传 exts(函数长度只对代码文件有意义)
|
|
31
|
-
exts: Array.isArray(r.exts) ? r.exts.map((x) => String(x).toLowerCase().replace(/^\./, '')) : undefined,
|
|
32
|
-
},
|
|
33
|
-
});
|
|
34
|
-
},
|
|
35
|
-
);
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 编译层 · 共享助手
|
|
3
|
-
*
|
|
4
|
-
* safeRe(正则编译 + 错误收集)、DIMENSIONS(评分维度表)、
|
|
5
|
-
* ruleOut(编译结果统一出参结构)、severityLevel(严重度 → 评分等级映射)。
|
|
6
|
-
* 各 kind 编译器共用这些助手,故独立成模块避免互相 import。
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* 正则安全编译(非法正则不抛异常,收集错误返回 null)。
|
|
11
|
-
*
|
|
12
|
-
* 1.0.0 修复:默认加 `i` 标志——规则本意是匹配「凭据/关键词写法」,
|
|
13
|
-
* 大小写不敏感才正确(原实现漏检 apiKey / API_KEY 等驼峰与大写写法)。
|
|
14
|
-
* 规则可用 `(?i)`(同义)、或 `(?-i)` 显式要求大小写敏感。
|
|
15
|
-
*/
|
|
16
|
-
export function safeRe(pattern, label, errors = []) {
|
|
17
|
-
try {
|
|
18
|
-
let src = String(pattern);
|
|
19
|
-
let flags = 'i';
|
|
20
|
-
if (src.startsWith('(?-i)')) { flags = ''; src = src.slice(5); }
|
|
21
|
-
else if (src.startsWith('(?i)')) src = src.slice(4);
|
|
22
|
-
return new RegExp(src, flags);
|
|
23
|
-
} catch (e) {
|
|
24
|
-
errors.push(`规则「${label}」正则非法 ${pattern}: ${e.message}`);
|
|
25
|
-
return null;
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
export const DIMENSIONS = {
|
|
30
|
-
可读性: '可读性', 可维护性: '可维护性', 健壮性: '健壮性', 安全性: '安全性', 性能: '性能',
|
|
31
|
-
测试覆盖: '测试覆盖', 可观测性: '可观测性', 可部署性: '可部署性', 文档: '文档', 开发者体验: '开发者体验',
|
|
32
|
-
};
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* 维度统一解析(统一维度绑定机制):
|
|
36
|
-
* yml 规则条目显式声明 dimensions 时优先(支持一字段多维度);
|
|
37
|
-
* 未声明则回退编译器内置默认维度。
|
|
38
|
-
* 校验:非数组/空数组/含非 10 维度名的条目 → 报错收集 + 回退默认(防静默错绑)。
|
|
39
|
-
* @param {object} r yml 规则条目
|
|
40
|
-
* @param {string[]} fallback 编译器默认维度
|
|
41
|
-
* @param {string[]} [errors] 编译错误收集(可选)
|
|
42
|
-
*/
|
|
43
|
-
export function pickDimensions(r = {}, fallback = [], errors = []) {
|
|
44
|
-
const declared = Array.isArray(r.dimensions) ? r.dimensions : undefined;
|
|
45
|
-
if (!declared || !declared.length) return [...fallback];
|
|
46
|
-
const valid = Object.values(DIMENSIONS);
|
|
47
|
-
const bad = declared.filter((d) => !valid.includes(String(d)));
|
|
48
|
-
if (bad.length) {
|
|
49
|
-
errors.push(`规则「${r?.id || r?.name || '?'}」dimensions 含未知维度(${bad.join('、')}),回退默认 [${fallback.join('、')}]`);
|
|
50
|
-
return [...fallback];
|
|
51
|
-
}
|
|
52
|
-
return [...new Set(declared.map(String))];
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
/** 统一规则对象形状(编译出口)。 */
|
|
56
|
-
export function ruleOut({ id, name, kind, severity = 'warning', level = 'warning', message, pattern, patterns, pathPattern, threshold, dimensions = [], extra = {} }) {
|
|
57
|
-
return {
|
|
58
|
-
ok: true,
|
|
59
|
-
rule: {
|
|
60
|
-
id, name, kind, severity, level, message,
|
|
61
|
-
...(pattern ? { pattern } : {}),
|
|
62
|
-
...(patterns?.length ? { patterns } : {}),
|
|
63
|
-
...(pathPattern ? { pathPattern } : {}),
|
|
64
|
-
...(threshold !== undefined ? { threshold } : {}),
|
|
65
|
-
dimensions: [...new Set(dimensions)],
|
|
66
|
-
...extra,
|
|
67
|
-
},
|
|
68
|
-
};
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
export const severityLevel = (s) => ({ error: 'blocker', warning: 'warning', info: 'pass' }[String(s || 'warning')] || 'warning');
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 规则编译器注册表 · 统一出口
|
|
3
|
-
*
|
|
4
|
-
* 本目录是「规则包 → 可执行检查」的编译层:每个模块负责一类 kind 的编译,
|
|
5
|
-
* 模块加载时调 registerCompiler 完成注册(副作用注册)。
|
|
6
|
-
* index.js 的 import 顺序 = 原文件里的注册顺序,保证 listRegisteredKinds() 次序不变。
|
|
7
|
-
*
|
|
8
|
-
* 分层位置(四层审计架构中「规则」→「实现」之间):
|
|
9
|
-
* lib/audit-rules/*.yml 规则内容(阈值/严重度/豁免清单,改规则只动 yml)
|
|
10
|
-
* lib/rule/* 规则加载、编译、注册(本目录:把 yml 的 kind 编译成检查函数)
|
|
11
|
-
* lib/ast/* · lib/checks/* token 级实现与检查包装
|
|
12
|
-
* lib/audit/* 采集与编排
|
|
13
|
-
*
|
|
14
|
-
* 本文件只做再导出与副作用 import:调用方继续 `from './rule/compilers.js'` 导入,路径稳定。
|
|
15
|
-
* 新增一个 kind 的编译器 → 往对应域模块加一段 registerCompiler 即可,不必动本文件。
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
|
-
import './credential.js';
|
|
19
|
-
import './func.js';
|
|
20
|
-
import './numeric-kinds.js';
|
|
21
|
-
import './regex.js';
|
|
22
|
-
import './link-semantic.js';
|
|
23
|
-
import './structure.js';
|
|
24
|
-
import './frontend.js';
|
|
25
|
-
import './file-health.js';
|
|
26
|
-
import './dataflow.js'; // 三层审计 L2——数据流 kind(clear-then-access)
|
|
27
|
-
|
|
28
|
-
export { safeRe, DIMENSIONS } from './helpers.js';
|
|
29
|
-
export { listRegisteredKinds } from './list-kinds.js';
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 编译层 · 链接与语义类 kind
|
|
3
|
-
*
|
|
4
|
-
* link-check(文档链接有效性,只报不拦)、semantic(语义占位符检查,最后兜底)。
|
|
5
|
-
* 为何合在一起:两者都是「跨文件/跨上下文才能判定」的检查,与正文正则不是一类。
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import { registerCompiler } from '../registry.js';
|
|
9
|
-
import { DIMENSIONS, ruleOut, severityLevel, pickDimensions } from './helpers.js';
|
|
10
|
-
|
|
11
|
-
/* ───────────────────────── 注册:链接判断(link-check,0.2.0) ───────────────────────── */
|
|
12
|
-
|
|
13
|
-
registerCompiler(
|
|
14
|
-
'link-check',
|
|
15
|
-
(r) => r?.kind === 'link-check' || Boolean(r?.flaky_hosts && r?.status_dead),
|
|
16
|
-
(r) => ruleOut({
|
|
17
|
-
id: r.id, name: r.name || r.id, kind: 'link-check', severity: r.severity || 'warning',
|
|
18
|
-
level: severityLevel(r.severity || 'warning'),
|
|
19
|
-
message: r.description || r.name || '',
|
|
20
|
-
dimensions: pickDimensions(r, [DIMENSIONS.文档, DIMENSIONS.可维护性]),
|
|
21
|
-
extra: {
|
|
22
|
-
statusDead: r.status_dead || [],
|
|
23
|
-
statusTransient: r.status_transient || [],
|
|
24
|
-
flakyHosts: r.flaky_hosts || [],
|
|
25
|
-
flakyFactor: r.flaky_factor,
|
|
26
|
-
scoreDead: r.score_dead, scoreDns: r.score_dns, scoreTransient: r.score_transient,
|
|
27
|
-
timeoutMs: r.timeouts_ms, concurrency: r.concurrency, maxLinks: r.max_links,
|
|
28
|
-
},
|
|
29
|
-
}),
|
|
30
|
-
);
|
|
31
|
-
|
|
32
|
-
/* ───────────────────────── 注册:语义规则(最后兜底) ───────────────────────── */
|
|
33
|
-
|
|
34
|
-
registerCompiler(
|
|
35
|
-
'semantic',
|
|
36
|
-
(r) => Boolean(r?.detection_method || r?.category === 'security' || r?.category === 'accessibility'
|
|
37
|
-
|| /\b(路径穿越|path-traversal|test-file|测试|known-vulnerability|漏洞依赖|label|可访问名称)\b/i.test(r?.name || '')
|
|
38
|
-
|| /testing\//i.test(r?.id || '') || /dependency\//i.test(r?.id || '')),
|
|
39
|
-
(r) => ruleOut({
|
|
40
|
-
id: r.id, name: r.name || r.id, kind: 'semantic', severity: r.severity,
|
|
41
|
-
level: severityLevel(r.severity), message: r.description || r.name || '',
|
|
42
|
-
dimensions: pickDimensions(r, [DIMENSIONS.健壮性]),
|
|
43
|
-
extra: { detectionMethod: r.detection_method || null },
|
|
44
|
-
}),
|
|
45
|
-
);
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 编译层 · 注册表查询
|
|
3
|
-
*
|
|
4
|
-
* listRegisteredKinds 输出已注册 kind 清单(供自检/文档/UI 展示)。
|
|
5
|
-
* 与注册动作分离成独立模块,避免查询方 import 整个注册表造成副作用。
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
/** 注册表最终导出(供 ruleset 统计用)。 */
|
|
9
|
-
export function listRegisteredKinds() {
|
|
10
|
-
// 延迟 import 避免循环(registry.js 不反向依赖 compilers)
|
|
11
|
-
return import('../registry.js').then((m) => m.RULE_COMPILERS.map((e) => e.kind));
|
|
12
|
-
}
|
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 编译层 · 数值阈值类 kind(数据表驱动,六个)
|
|
3
|
-
*
|
|
4
|
-
* numericKinds 是一张 kind 定义表(判定式 + 字段提取 + 维度),下方循环按表批量注册。
|
|
5
|
-
* 新增数值类阈值规则只需往表里加一行,不必写编译器——这是本目录里唯一表驱动的模块。
|
|
6
|
-
* min-occurrences 与 repeated-string 共享 min_occurrences 字段,靠 ignore_patterns/
|
|
7
|
-
* ignore_values 是否存在区分,故表里的判定式带这个判断。
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
import { registerCompiler } from '../registry.js';
|
|
11
|
-
import { DIMENSIONS, ruleOut, safeRe, severityLevel, pickDimensions } from './helpers.js';
|
|
12
|
-
|
|
13
|
-
/** 注释密度默认阈值(0~1,规则未配 threshold 时由检查器兜底同值)。 */
|
|
14
|
-
const COMMENT_DENSITY_THRESHOLD_DEFAULT = 0.4;
|
|
15
|
-
|
|
16
|
-
/* ───────────────────────── 注册:数值六类(原 compileNumericRule 拆分) ───────────────────────── */
|
|
17
|
-
|
|
18
|
-
/** 数值字段 → kind 映射(一函数一类型,detect 各查各字段)。 */
|
|
19
|
-
const numericKinds = [
|
|
20
|
-
['min-length', (r) => r?.min_length !== undefined, (r) => ({ threshold: Number(r.min_length) }), [DIMENSIONS.可读性]],
|
|
21
|
-
['max-lines', (r) => r?.max_lines !== undefined && !/(function|函数|方法)/i.test(r?.name || ''), (r) => ({ threshold: Number(r.max_lines) }), [DIMENSIONS.可读性, DIMENSIONS.可维护性]],
|
|
22
|
-
['max-complexity', (r) => r?.max_complexity !== undefined, (r) => ({ threshold: Number(r.max_complexity), ...(r.block_complexity != null ? { block: Number(r.block_complexity) } : {}) }), [DIMENSIONS.可维护性]],
|
|
23
|
-
['max-depth', (r) => r?.max_depth !== undefined, (r) => ({ threshold: Number(r.max_depth) }), [DIMENSIONS.可维护性]],
|
|
24
|
-
// 重复代码(该抽公共函数)——kind=duplicate-code,由 lib/checks/dup-code.js 消费
|
|
25
|
-
['duplicate-code', (r) => r?.kind === 'duplicate-code', (r) => ({
|
|
26
|
-
minLines: Number(r.min_lines) || 5,
|
|
27
|
-
minOccurrences: Number(r.min_occurrences) || 3,
|
|
28
|
-
}), [DIMENSIONS.可维护性]],
|
|
29
|
-
// 同名常量跨文件重复定义(DRY)——kind=duplicate-const,由 lib/checks/dup-const.js 消费
|
|
30
|
-
['duplicate-const', (r) => r?.kind === 'duplicate-const', (r) => ({}), [DIMENSIONS.可维护性]],
|
|
31
|
-
// 逐文件扫描实现过多(仓库级;2026-10-16 由 bench-template 的 scan-fs-hotspots 交接)——
|
|
32
|
-
// kind=multi-file-scanners,由 lib/checks/fs-scanner.js 消费;min_occurrences=阈值(默认 3)。
|
|
33
|
-
// ⚠️ 必须在这里登记:registry.js 对带 kind 的规则会查 RULE_COMPILERS,查不到就
|
|
34
|
-
// **静默丢弃**(报「未知规则类型 kind=…」)——实测本规则一开始就是这么消失的 ✗
|
|
35
|
-
['multi-file-scanners', (r) => r?.kind === 'multi-file-scanners', (r) => ({
|
|
36
|
-
minOccurrences: Number(r.min_occurrences) || 3,
|
|
37
|
-
}), [DIMENSIONS.性能 || DIMENSIONS.可维护性]],
|
|
38
|
-
// 注释冗余密度(用户规则反馈①)——显式 kind 或 id 含 comment-density,
|
|
39
|
-
// threshold 字段承载密度阈值(0~1,默认 0.4 由检查器兜底)
|
|
40
|
-
['comment-density', (r) => r?.kind === 'comment-density' || /comment-density/i.test(String(r?.id || '')), (r) => ({
|
|
41
|
-
threshold: r?.threshold != null ? Number(r.threshold) : COMMENT_DENSITY_THRESHOLD_DEFAULT,
|
|
42
|
-
}), [DIMENSIONS.可读性]],
|
|
43
|
-
// min-occurrences 与 repeated-string 共享 min_occurrences/ignore 字段;带 ignore_patterns/ignore_values 走 repeated-string
|
|
44
|
-
['min-occurrences', (r) => r?.min_occurrences !== undefined && !(Array.isArray(r.ignore_patterns) || Array.isArray(r.ignore_values)), (r) => ({ threshold: Number(r.min_occurrences), min_occurrences: Number(r.min_occurrences), ...(r.min_lines !== undefined ? { minLines: Number(r.min_lines) } : {}) }), [DIMENSIONS.可维护性]],
|
|
45
|
-
['repeated-string', (r) => r?.min_occurrences !== undefined && (Array.isArray(r.ignore_patterns) || Array.isArray(r.ignore_values)), (r, ctx) => ({
|
|
46
|
-
threshold: Number(r.min_occurrences), min_occurrences: Number(r.min_occurrences),
|
|
47
|
-
...(r.min_lines !== undefined ? { minLines: Number(r.min_lines) } : {}),
|
|
48
|
-
ignorePatterns: (r.ignore_patterns || []).map((p) => safeRe(p, r?.name || r?.id, ctx.errors)).filter(Boolean),
|
|
49
|
-
ignoreValues: (r.ignore_values || []).map(String),
|
|
50
|
-
}), [DIMENSIONS.可维护性, DIMENSIONS.可读性]],
|
|
51
|
-
];
|
|
52
|
-
|
|
53
|
-
for (const [kind, detect, field, dimensions] of numericKinds) {
|
|
54
|
-
registerCompiler(
|
|
55
|
-
kind,
|
|
56
|
-
detect,
|
|
57
|
-
(r, ctx) => {
|
|
58
|
-
const f = field(r, ctx);
|
|
59
|
-
return ruleOut({
|
|
60
|
-
id: r.id, name: r.name || r.id, kind, severity: r.severity,
|
|
61
|
-
level: severityLevel(r.severity), message: r.description || r.name || '',
|
|
62
|
-
dimensions: pickDimensions(r, dimensions, ctx?.errors),
|
|
63
|
-
extra: {
|
|
64
|
-
...f,
|
|
65
|
-
exceptions: Array.isArray(r.exceptions) ? r.exceptions : [],
|
|
66
|
-
// 透传 exts——代码结构类数值规则(嵌套深度/函数长度/命名长度)
|
|
67
|
-
// 只应作用于代码文件,否则 md/json/yml 里的示例代码块与文档结构会被误报。
|
|
68
|
-
exts: Array.isArray(r.exts) ? r.exts.map((x) => String(x).toLowerCase().replace(/^\./, '')) : undefined,
|
|
69
|
-
},
|
|
70
|
-
});
|
|
71
|
-
},
|
|
72
|
-
);
|
|
73
|
-
}
|