dsh-git-push 2.20.19 → 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 +7 -1
- package/lib/app/apply.js +4 -4
- package/lib/app/command-registry.js +22 -17
- package/lib/app/handlers/meta.js +2 -2
- package/lib/app/handlers/preprocess.js +107 -0
- package/lib/app/handlers/repo-actions.js +2 -2
- package/lib/app/http-handlers.js +13 -42
- package/lib/app/index.js +2 -1
- package/lib/app/inject-text.js +3 -3
- 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 +73 -144
- 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 +35 -9
- package/lib/commit-push/pre-commit-engine.js +57 -10
- package/lib/commit-push.js +71 -27
- 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/cli-audit.mjs +0 -141
- 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/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/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
package/lib/audit/public.js
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
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';
|
package/lib/audit/repo-level.js
DELETED
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
import { isRepoLevelSemanticRule } from './checks.js';
|
|
2
|
-
import { CODE_EXTS } from './finding.js';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* 收集「仓库级语义占位规则」id 集合(无任何可执行检测字段、需人工按仓库核查)。
|
|
6
|
-
* 见 checks.js isRepoLevelSemanticRule 的判定说明。
|
|
7
|
-
* @param {object} grouped groupByKind 结果
|
|
8
|
-
* @returns {Set<string>}
|
|
9
|
-
*/
|
|
10
|
-
export function repoLevelSemanticRuleIds(grouped = {}) {
|
|
11
|
-
const out = new Set();
|
|
12
|
-
for (const rule of grouped['semantic'] || []) {
|
|
13
|
-
if (isRepoLevelSemanticRule(rule)) out.add(rule.id);
|
|
14
|
-
}
|
|
15
|
-
return out;
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* 选仓库级规则的「代表文件」:代码文件中路径字典序最小者(稳定可复现)。
|
|
20
|
-
* 无代码文件时返回 null(此时不做去重,逐文件提示以免丢信息)。
|
|
21
|
-
* @param {Array<{path:string}>} files 采集到的文件列表
|
|
22
|
-
* @returns {string|null}
|
|
23
|
-
*/
|
|
24
|
-
export function pickRepoLevelAnchorFile(files = []) {
|
|
25
|
-
const code = files
|
|
26
|
-
.map((f) => String(f?.path || ''))
|
|
27
|
-
.filter((p) => CODE_EXTS.has(p.split('.').pop().toLowerCase()))
|
|
28
|
-
.sort();
|
|
29
|
-
return code.length ? code[0] : null;
|
|
30
|
-
}
|
package/lib/audit/report-yaml.js
DELETED
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 审计结果 YAML 报告(新增)。
|
|
3
|
-
*
|
|
4
|
-
* 把平铺 findings 聚合成层级 YAML:summary → 拦截级别 → 目录 → 文件 → 规则明细。
|
|
5
|
-
* 供 CLI --json / 插件工具 code_audit 返回体携带,便于人读与机器解析。
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
// js-yaml 走 npm 依赖(仓库内不保存副本)。
|
|
9
|
-
// 这里**故意用静态 import**:规则加载是启动关键路径,依赖没装上就应当在模块加载期
|
|
10
|
-
// 抛 ERR_MODULE_NOT_FOUND(错误里带包名,够响亮),而不是被 try/catch 吞成「0 条规则」
|
|
11
|
-
// 继续跑——静默无规则比启动失败更危险(口径见 docs/2026-10-28-弃零依赖引入npm与AST优先规则方案.MD D5)。
|
|
12
|
-
import { dump as yamlDump } from 'js-yaml';
|
|
13
|
-
|
|
14
|
-
/** 拦截级别顺序(聚合时按此排布;未知级别归入其他)。 */
|
|
15
|
-
const SEVERITY_ORDER = ['blocker', 'warning', 'notice', 'info'];
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
* 从发现列表构建层级聚合的 YAML 文本。
|
|
19
|
-
*
|
|
20
|
-
* 层级:
|
|
21
|
-
* summary: { blocker, warning, notice, info, total } —— 拦截级别计数
|
|
22
|
-
* blocker: —— 每级别一个键
|
|
23
|
-
* <目录>: —— 文件所在目录(相对路径或不含文件名的路径段)
|
|
24
|
-
* <文件名>: —— 具体文件
|
|
25
|
-
* rules: —— 该文件命中明细
|
|
26
|
-
* - rule / line / message
|
|
27
|
-
*
|
|
28
|
-
* @param {Array} findings 统一问题对象数组(file/line/rule/severity/message)
|
|
29
|
-
* @param {object} [opts] { includeMessage: true } —— message 过长时可截断
|
|
30
|
-
* @returns {string} YAML 文本(js-yaml dump,noRefs + 不换行)
|
|
31
|
-
*/
|
|
32
|
-
export function findingsToYaml(findings = [], { includeMessage = true, maxMessageLen = 200 } = {}) {
|
|
33
|
-
const list = Array.isArray(findings) ? findings : [];
|
|
34
|
-
// 1) 按拦截级别分组
|
|
35
|
-
const bySeverity = new Map(); // severity → Map(dir → Map(file → rules[]))
|
|
36
|
-
for (const f of list) {
|
|
37
|
-
const sev = f.severity === 'error' ? 'blocker' : (String(f.severity || 'warning'));
|
|
38
|
-
if (!bySeverity.has(sev)) bySeverity.set(sev, new Map());
|
|
39
|
-
const dirFile = bySeverity.get(sev);
|
|
40
|
-
const rel = String(f.file || '');
|
|
41
|
-
// 目录 = 路径去掉最后一段(文件);根级文件目录记 ''(YAML 里用 ./)
|
|
42
|
-
const slash = rel.lastIndexOf('/');
|
|
43
|
-
const dir = slash > 0 ? rel.slice(0, slash + 1) : '';
|
|
44
|
-
const file = slash >= 0 ? rel.slice(slash + 1) : rel;
|
|
45
|
-
if (!dirFile.has(dir)) dirFile.set(dir, new Map());
|
|
46
|
-
const fileMap = dirFile.get(dir);
|
|
47
|
-
if (!fileMap.has(file)) fileMap.set(file, []);
|
|
48
|
-
const entry = { rule: f.rule || '', line: f.line || 0 };
|
|
49
|
-
if (includeMessage) entry.message = String(f.message || '').slice(0, maxMessageLen);
|
|
50
|
-
fileMap.get(file).push(entry);
|
|
51
|
-
}
|
|
52
|
-
// 2) 计数 summary
|
|
53
|
-
const summary = { blocker: 0, warning: 0, notice: 0, info: 0, total: list.length };
|
|
54
|
-
for (const sev of bySeverity.keys()) {
|
|
55
|
-
const n = countSeverity(bySeverity.get(sev) || new Map());
|
|
56
|
-
if (sev === 'blocker') summary.blocker = n;
|
|
57
|
-
else if (sev === 'warning') summary.warning = n;
|
|
58
|
-
else if (sev === 'notice') summary.notice = n;
|
|
59
|
-
else summary.info += n;
|
|
60
|
-
}
|
|
61
|
-
// 3) 组装层级对象(按 SEVERITY_ORDER 排布 + 未知级别)
|
|
62
|
-
const tree = { summary };
|
|
63
|
-
const keyOrder = [...SEVERITY_ORDER, ...new Set([...bySeverity.keys()].filter((s) => !SEVERITY_ORDER.includes(s)))];
|
|
64
|
-
for (const sev of keyOrder) {
|
|
65
|
-
const dirMap = bySeverity.get(sev);
|
|
66
|
-
if (!dirMap || !dirMap.size) {
|
|
67
|
-
tree[sev] = sev === 'blocker' || sev === 'warning' || sev === 'notice' || sev === 'info' ? [] : null;
|
|
68
|
-
continue;
|
|
69
|
-
}
|
|
70
|
-
const sevNode = {};
|
|
71
|
-
for (const [dir, fileMap] of [...dirMap.entries()].sort((a, b) => String(a[0]).localeCompare(String(b[0])))) {
|
|
72
|
-
const dirKey = dir || './';
|
|
73
|
-
sevNode[dirKey] = {};
|
|
74
|
-
for (const [file, rules] of [...fileMap.entries()].sort((a, b) => String(a[0]).localeCompare(String(b[0])))) {
|
|
75
|
-
sevNode[dirKey][file] = { rules };
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
tree[sev] = sevNode;
|
|
79
|
-
}
|
|
80
|
-
return yamlDump(tree, { noRefs: true, lineWidth: -1 });
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
/** 统计一个级别的 dir→file→rules 聚合法命中总数。 */
|
|
84
|
-
function countSeverity(dirMap) {
|
|
85
|
-
let n = 0;
|
|
86
|
-
for (const fileMap of dirMap.values()) {
|
|
87
|
-
for (const rules of fileMap.values()) n += rules.length;
|
|
88
|
-
}
|
|
89
|
-
return n;
|
|
90
|
-
}
|
|
@@ -1,110 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 拼接产物作用域契约的**读取层**(中立模块:工具/独立脚本/审计检查三方共用一份判定)。
|
|
3
|
-
*
|
|
4
|
-
* 为什么单独成模块:同一件事有三个入口(`scope_check` 工具、`scripts/check-js-scope.mjs`、
|
|
5
|
-
* 审计规则 kind=scope-collision),「按文件所属项目取契约」的判定一旦各写一份就会漂移。
|
|
6
|
-
* 放在 lib/app/ 会被 lib/checks/ 反向依赖(现有链路是 app → audit → checks,
|
|
7
|
-
* checks → app 会成环);与 lib/audit/client-entry.js 同款处理:共用逻辑下沉中立模块,
|
|
8
|
-
* 依赖方向保持单向(checks → audit/scope-policy 是叶子模块,无回指)。
|
|
9
|
-
*
|
|
10
|
-
* 核心约定:`dshgp_` 前缀与「顶层零声明」都是**各项目自己的契约**,不是通用规范。
|
|
11
|
-
* 拿本项目的约定去要求别人的文件,会刷出一屏「缺少 dshgp_ 前缀」,把真正的同帧重名淹掉。
|
|
12
|
-
* ① 调用方显式给定 prefix/allowlist → 以显式值为准(调用方明确要求);
|
|
13
|
-
* ② 否则从文件所在目录向上找最近的 package.json,读其 `dshScopeCheck`;
|
|
14
|
-
* ③ 都没有 → 前缀留空、不要求顶层零声明,**只查同帧重名**(唯一通用项)。
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
|
-
import { existsSync, readFileSync } from 'node:fs';
|
|
18
|
-
import { dirname, join, relative, resolve } from 'node:path';
|
|
19
|
-
|
|
20
|
-
/** 策略来源(输出头自证:避免「继承了本仓默认值」被误读成对方的约定)。 */
|
|
21
|
-
export const POLICY_SOURCE = {
|
|
22
|
-
CLI: '命令行',
|
|
23
|
-
PROJECT: '项目 package.json',
|
|
24
|
-
BUILTIN: '内置默认(只查同帧重名)',
|
|
25
|
-
};
|
|
26
|
-
|
|
27
|
-
/** 路径归一化:去掉前导 `./`、反斜杠统一成 `/`(声明值与相对路径两边都用它比)。 */
|
|
28
|
-
function normRelPath(value) {
|
|
29
|
-
return String(value || '').replace(/\\/g, '/').replace(/^\.\//, '');
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
/**
|
|
33
|
-
* 目录 → 最近的 package.json 路径缓存('' = 一路到根都没有)。
|
|
34
|
-
*
|
|
35
|
-
* 为什么需要:审计逐文件调用本模块,全仓 400+ 个 js 就要做 400+ 次「向上找 package.json」;
|
|
36
|
-
* 在 CIFS/HFS 挂载上 stat 单次约 2.8ms,实测这一项 1.2s(占比虽小但纯浪费)。
|
|
37
|
-
* TTL 取 1s:一次审计内连续调用几乎全命中,而两次审计之间(≥1s)必然重新读,
|
|
38
|
-
* 不会把「刚改了 dshScopeCheck 又立刻审计」读成旧值。
|
|
39
|
-
*/
|
|
40
|
-
const DIR_LOOKUP_TTL_MS = 1000;
|
|
41
|
-
const dirLookupCache = new Map(); // dir → { at, configPath }
|
|
42
|
-
|
|
43
|
-
/** 向上找最近的 package.json(带 1s 缓存)。 */
|
|
44
|
-
function findConfigPath(startDir, now) {
|
|
45
|
-
const cached = dirLookupCache.get(startDir);
|
|
46
|
-
if (cached && now - cached.at < DIR_LOOKUP_TTL_MS) return cached.configPath;
|
|
47
|
-
let found = '';
|
|
48
|
-
let dir = startDir;
|
|
49
|
-
for (;;) {
|
|
50
|
-
const candidate = join(dir, 'package.json');
|
|
51
|
-
if (existsSync(candidate)) { found = candidate; break; }
|
|
52
|
-
const parent = dirname(dir);
|
|
53
|
-
if (parent === dir) break; // 到根了还没找到 ⇒ 无声明
|
|
54
|
-
dir = parent;
|
|
55
|
-
}
|
|
56
|
-
dirLookupCache.set(startDir, { at: now, configPath: found });
|
|
57
|
-
return found;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* 读某个文件所属项目的作用域契约。
|
|
62
|
-
*
|
|
63
|
-
* @param {string} file 目标文件路径(绝对路径最稳;相对路径按进程 cwd 解析)
|
|
64
|
-
* @returns {{
|
|
65
|
-
* declared: boolean, 是否找到了显式声明(决定「契约类检查」跑不跑)
|
|
66
|
-
* isDeclaredArtifact: boolean, 当前文件是否在该项目声明的 files 清单里
|
|
67
|
-
* prefix: string, allowlist: string[], topLevelMustBeEmpty: boolean,
|
|
68
|
-
* files: string[], configPath: string, relFromConfig: string, source: string
|
|
69
|
-
* }}
|
|
70
|
-
* `isDeclaredArtifact` 必须为 true 才允许套用 prefix / 顶层零声明:`files` 清单就是
|
|
71
|
-
* 「哪些文件是拼接产物」的声明——不在清单里的文件(如分片源码)套用前缀会把
|
|
72
|
-
* 片段里的局部变量全部误判成缺前缀。
|
|
73
|
-
*/
|
|
74
|
-
export function readProjectScopePolicy(file = '') {
|
|
75
|
-
const target = resolve(file);
|
|
76
|
-
const builtin = {
|
|
77
|
-
declared: false,
|
|
78
|
-
isDeclaredArtifact: false,
|
|
79
|
-
prefix: '',
|
|
80
|
-
allowlist: [],
|
|
81
|
-
topLevelMustBeEmpty: false,
|
|
82
|
-
files: [],
|
|
83
|
-
configPath: '',
|
|
84
|
-
relFromConfig: '',
|
|
85
|
-
source: POLICY_SOURCE.BUILTIN,
|
|
86
|
-
};
|
|
87
|
-
const configPath = findConfigPath(dirname(target), Date.now());
|
|
88
|
-
if (!configPath) return builtin; // 一路到根都没有 package.json ⇒ 按「无声明」处理
|
|
89
|
-
let own;
|
|
90
|
-
try {
|
|
91
|
-
own = JSON.parse(readFileSync(configPath, 'utf8'))?.dshScopeCheck;
|
|
92
|
-
} catch {
|
|
93
|
-
return builtin; // package.json 损坏 → 按「无声明」处理,不抛给调用方
|
|
94
|
-
}
|
|
95
|
-
if (!own || typeof own !== 'object') return builtin; // 找到所属项目但没声明 ⇒ 不套别人的规范
|
|
96
|
-
const files = Array.isArray(own.files) ? own.files.map(String) : [];
|
|
97
|
-
const configDir = dirname(configPath);
|
|
98
|
-
const relFromConfig = normRelPath(relative(configDir, target));
|
|
99
|
-
return {
|
|
100
|
-
declared: true,
|
|
101
|
-
isDeclaredArtifact: files.some((rel) => normRelPath(rel) === relFromConfig),
|
|
102
|
-
prefix: String(own.prefix || ''),
|
|
103
|
-
allowlist: Array.isArray(own.allowlist) ? own.allowlist.map(String) : [],
|
|
104
|
-
topLevelMustBeEmpty: own.topLevelMustBeEmpty === true,
|
|
105
|
-
files,
|
|
106
|
-
configPath,
|
|
107
|
-
relFromConfig,
|
|
108
|
-
source: POLICY_SOURCE.PROJECT,
|
|
109
|
-
};
|
|
110
|
-
}
|
package/lib/audit/slot.js
DELETED
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 按规则包(槽位)聚合审计命中数。
|
|
3
|
-
*
|
|
4
|
-
* 侧边栏规则包列表的「拦截 / 警告 / 通过」显示的是**实际审计命中数**:
|
|
5
|
-
* · 拦截 = 该规则包命中的 blocker/error 级问题数
|
|
6
|
-
* · 警告 = 该规则包命中的 warning 级问题数
|
|
7
|
-
* · 通过 = 该规则包已加载的规则数 −(有命中的规则数)——即「没查出问题的规则」条数
|
|
8
|
-
*
|
|
9
|
-
* 槽位归属来自编译后规则对象的 slot 字段(loader 打 __slot → compileRule 透传);
|
|
10
|
-
* 规则 id → slot 的映射由调用方一次性构建(同一 id 可能多槽位复用,取首个)。
|
|
11
|
-
*
|
|
12
|
-
* @param {Array} findings 审计结果(统一 finding 对象,带 rule/severity)
|
|
13
|
-
* @param {Map<string,string>} ruleSlotMap 规则 id → 槽位名
|
|
14
|
-
* @param {Record<string, number>} [slotRuleCount] 各槽位已加载规则数(用于算「通过」)
|
|
15
|
-
* @returns {Record<string, {blocker:number, warning:number, pass:number, total:number}>}
|
|
16
|
-
*/
|
|
17
|
-
export function slotStatsFromFindings(findings = [], ruleSlotMap = new Map(), slotRuleCount = {}) {
|
|
18
|
-
findings = findings.filter((f) => !f.exempted); // 已确认豁免不计入规则包命中
|
|
19
|
-
const stats = {};
|
|
20
|
-
const hitRules = {}; // slot → Set(命中的规则 id)
|
|
21
|
-
// 先为「所有已加载槽位」建条目:未命中的槽位也要出现在结果里
|
|
22
|
-
// (前端显示「0 拦截 / 0 警告 / 全部规则通过」,否则该行会退回规则条数口径,两种口径混排)
|
|
23
|
-
for (const [slot, count] of Object.entries(slotRuleCount)) {
|
|
24
|
-
stats[slot] = { blocker: 0, warning: 0, pass: count, total: count };
|
|
25
|
-
}
|
|
26
|
-
const ensure = (slot) => {
|
|
27
|
-
if (!stats[slot]) stats[slot] = { blocker: 0, warning: 0, pass: 0, total: slotRuleCount[slot] || 0 };
|
|
28
|
-
return stats[slot];
|
|
29
|
-
};
|
|
30
|
-
for (const f of findings) {
|
|
31
|
-
const slot = ruleSlotMap.get(f.rule);
|
|
32
|
-
if (!slot) continue;
|
|
33
|
-
const st = ensure(slot);
|
|
34
|
-
const sev = f.severity || 'warning';
|
|
35
|
-
if (sev === 'blocker' || sev === 'error') st.blocker++;
|
|
36
|
-
else if (sev === 'warning') st.warning++;
|
|
37
|
-
// notice/info 不计入拦截/警告(与 summarize 语义一致)
|
|
38
|
-
(hitRules[slot] ||= new Set()).add(f.rule);
|
|
39
|
-
}
|
|
40
|
-
// 通过 = 该槽位规则总数 − 有命中的规则数(无命中即「通过」)
|
|
41
|
-
for (const [slot, st] of Object.entries(stats)) {
|
|
42
|
-
const hit = (hitRules[slot] || new Set()).size;
|
|
43
|
-
st.pass = Math.max(0, (slotRuleCount[slot] || 0) - hit);
|
|
44
|
-
}
|
|
45
|
-
return stats;
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
/** 取「规则 id → 槽位」映射(编译后规则集带 slot;同 id 取首个非空槽位)。 */
|
|
49
|
-
export function buildRuleSlotMap(compiledRules = []) {
|
|
50
|
-
const map = new Map();
|
|
51
|
-
for (const r of compiledRules) {
|
|
52
|
-
if (!r?.id || !r?.slot) continue;
|
|
53
|
-
if (!map.has(r.id)) map.set(r.id, r.slot);
|
|
54
|
-
}
|
|
55
|
-
return map;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
/** 统计各槽位已加载规则数(供「通过」列基数)。 */
|
|
59
|
-
export function countRulesBySlot(compiledRules = []) {
|
|
60
|
-
const out = {};
|
|
61
|
-
for (const r of compiledRules) {
|
|
62
|
-
if (!r?.slot) continue;
|
|
63
|
-
out[r.slot] = (out[r.slot] || 0) + 1;
|
|
64
|
-
}
|
|
65
|
-
return out;
|
|
66
|
-
}
|
|
@@ -1,199 +0,0 @@
|
|
|
1
|
-
# ============================================================
|
|
2
|
-
# 注释关键词检测规则集(AI 用户交流注释识别)
|
|
3
|
-
# 作者:DeepSeek
|
|
4
|
-
# 版本:1.0.0
|
|
5
|
-
# 适用:所有 JavaScript / TypeScript / HTML 文件 + 文档(md/txt)
|
|
6
|
-
# exts 说明(2026-09-13):显式声明作用域——本包只查「注释/文档」载体,不查 .json。
|
|
7
|
-
# 不声明时插件配置文件也会被扫:里面写给 AI 的流程约定会被当「公开文档夹带
|
|
8
|
-
# 沟通记录」误报成 blocker,把提交门禁卡死。
|
|
9
|
-
# 描述:检测代码中残留的 AI 用户交流注释
|
|
10
|
-
# 最后更新:2026-09-08
|
|
11
|
-
# ============================================================
|
|
12
|
-
|
|
13
|
-
metadata:
|
|
14
|
-
name: "注释质量检测规则(AI 交流注释识别)"
|
|
15
|
-
version: "1.0.0"
|
|
16
|
-
language: "all"
|
|
17
|
-
author: "DeepSeek"
|
|
18
|
-
description: "检测『用户指示 2』『用户原话』等 AI 协作残留注释"
|
|
19
|
-
last_updated: "2026-09-08"
|
|
20
|
-
|
|
21
|
-
rules:
|
|
22
|
-
- id: documentation/comment-suspicious-detection
|
|
23
|
-
# 归档/笔记类目录整规则跳过:这些文件**本来就是**在记录会话与决策(会话 ID、用户确认、讨论过程),
|
|
24
|
-
# 按「公开文档只写做了什么」去拦是纯误伤(实测某归档库命中 138 条全集中在此类目录)。
|
|
25
|
-
exclude_paths: ["开发者文档/", "sessions/", "worklogs/", "会话/"]
|
|
26
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx", "html", "htm"]
|
|
27
|
-
name: "检测 AI 用户交流可疑注释"
|
|
28
|
-
category: "documentation"
|
|
29
|
-
severity: "blocker"
|
|
30
|
-
description: "检测代码中残留的 AI 用户交流注释(用户说/用户要求/用户原话等,命中即拦截提交)"
|
|
31
|
-
fixable: true
|
|
32
|
-
action: "建议在 PR 前清理,或将关键信息移至 git commit message"
|
|
33
|
-
|
|
34
|
-
# ----- 黑名单(命中即拦截提交;白名单命中整行豁免) -----
|
|
35
|
-
blacklist:
|
|
36
|
-
- pattern: "用户指示"
|
|
37
|
-
- pattern: "用户原话"
|
|
38
|
-
- pattern: "用户反馈"
|
|
39
|
-
- pattern: "根据用户"
|
|
40
|
-
- pattern: "客户要求"
|
|
41
|
-
- pattern: "用户说"
|
|
42
|
-
- pattern: "原话"
|
|
43
|
-
- pattern: "指示"
|
|
44
|
-
- pattern: "用户要求"
|
|
45
|
-
- pattern: "User request"
|
|
46
|
-
- pattern: "require user"
|
|
47
|
-
- pattern: "根据要求"
|
|
48
|
-
- pattern: "User feedback"
|
|
49
|
-
- pattern: "AI 说"
|
|
50
|
-
- pattern: "机器说"
|
|
51
|
-
- pattern: "人工要求"
|
|
52
|
-
- pattern: "用户约定"
|
|
53
|
-
- pattern: "用户规定"
|
|
54
|
-
- pattern: "用户明确"
|
|
55
|
-
- pattern: "用户拍板"
|
|
56
|
-
- pattern: "用户裁决"
|
|
57
|
-
- pattern: "用户:"
|
|
58
|
-
- pattern: "用户(同意|许可|确认|约定|指定|已定调|拍板|让我|要求我|跟我说)"
|
|
59
|
-
# 2026-10-14 补:以下措辞此前漏网(注释里实际出现过「用户方案定稿」「用户定稿」「用户决定」)
|
|
60
|
-
- pattern: "用户(方案|定稿|决定|认为|指出|提到|说过|告诉|希望|想要|偏好|选择|初衷|口径|诉求|指令|吩咐|口述)"
|
|
61
|
-
- pattern: "方案定稿"
|
|
62
|
-
- pattern: "规则定稿"
|
|
63
|
-
- pattern: "定稿(了|版|说明|记录)"
|
|
64
|
-
- pattern: "(本次|上次|上一轮|本轮|这一轮)[ ]*会话"
|
|
65
|
-
- pattern: "会话(记录|里|中|要求|约定)"
|
|
66
|
-
- pattern: "你(要求|让我|希望|提到|指出|说过)"
|
|
67
|
-
- pattern: "AI[ ]*(跟进|协作|沟通|对话|分析|建议|承诺)"
|
|
68
|
-
- pattern: "(沟通|对话)(记录|措辞|词)"
|
|
69
|
-
- pattern: "(商量|协商)后?(结论|结果|定)"
|
|
70
|
-
|
|
71
|
-
# ----- 白名单(业务词豁免:命中则整行不拦截) -----
|
|
72
|
-
whitelist:
|
|
73
|
-
- pattern: "用户ID"
|
|
74
|
-
- pattern: "用户登录"
|
|
75
|
-
- pattern: "用户状态"
|
|
76
|
-
- pattern: "用户权限"
|
|
77
|
-
- pattern: "用户角色"
|
|
78
|
-
- pattern: "用户信息"
|
|
79
|
-
- pattern: "用户数据"
|
|
80
|
-
- pattern: "用户配置"
|
|
81
|
-
- pattern: "用户设置"
|
|
82
|
-
- pattern: "用户会话"
|
|
83
|
-
- pattern: "用户认证"
|
|
84
|
-
- pattern: "用户验证"
|
|
85
|
-
- pattern: "用户注册"
|
|
86
|
-
- pattern: "用户密码"
|
|
87
|
-
- pattern: "用户邮箱"
|
|
88
|
-
- pattern: "用户名"
|
|
89
|
-
- pattern: "用户头像"
|
|
90
|
-
- pattern: "用户组"
|
|
91
|
-
- pattern: "用户表"
|
|
92
|
-
- pattern: "用户服务"
|
|
93
|
-
- pattern: "用户模块"
|
|
94
|
-
- pattern: "用户旅程"
|
|
95
|
-
# 功能描述而非协作残留:工具作用就是「按用户原话」裁断日志(该措辞实测被误拦)
|
|
96
|
-
- pattern: "按用户原话"
|
|
97
|
-
|
|
98
|
-
- id: conv-session-ref
|
|
99
|
-
# 归档/笔记类目录整规则跳过:这些文件**本来就是**在记录会话与决策(会话 ID、用户确认、讨论过程),
|
|
100
|
-
# 按「公开文档只写做了什么」去拦是纯误伤(实测某归档库命中 138 条全集中在此类目录)。
|
|
101
|
-
exclude_paths: ["开发者文档/", "sessions/", "worklogs/", "会话/"]
|
|
102
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx", "html", "htm", "md", "markdown", "txt"]
|
|
103
|
-
name: "文档引用会话"
|
|
104
|
-
category: "documentation"
|
|
105
|
-
severity: "blocker"
|
|
106
|
-
description: "文档含会话/对话引用措辞,公开文档应只写做了什么"
|
|
107
|
-
pattern: "(本会话|本次会话|本对话|开发会话|session-[0-9a-f]{8,})"
|
|
108
|
-
fixable: false
|
|
109
|
-
- id: conv-user-decision
|
|
110
|
-
# 只查**文档**:代码文件(js/mjs/ts/jsx/html 等)的同类命中由 documentation/comment-suspicious-detection
|
|
111
|
-
# 负责(它带 blacklist + AST 精筛,能区分注释与字符串字面量)。
|
|
112
|
-
# 此前本规则 exts 里含代码扩展名 ⇒ 与前者报同一批位置:实测 archify 上两条各报 7 条、
|
|
113
|
-
# (file:line) 交集 5 条,同一条注释被两个 blocker 各拦一次。
|
|
114
|
-
# 归档/笔记类目录整规则跳过:这些文件**本来就是**在记录会话与决策(会话 ID、用户确认、讨论过程),
|
|
115
|
-
# 按「公开文档只写做了什么」去拦是纯误伤(实测某归档库命中 138 条全集中在此类目录)。
|
|
116
|
-
exclude_paths: ["开发者文档/", "sessions/", "worklogs/", "会话/"]
|
|
117
|
-
exts: ["md", "markdown", "txt"]
|
|
118
|
-
name: "文档引用用户决策"
|
|
119
|
-
category: "documentation"
|
|
120
|
-
severity: "blocker"
|
|
121
|
-
description: "文档含「用户同意/要求我」类沟通记录,公开文档应改写"
|
|
122
|
-
pattern: "用户(同意|许可|确认|约定|指定|已定调|拍板|让我|要求我|跟我说)"
|
|
123
|
-
fixable: false
|
|
124
|
-
- id: conv-ai-permit
|
|
125
|
-
# 归档/笔记类目录整规则跳过:这些文件**本来就是**在记录会话与决策(会话 ID、用户确认、讨论过程),
|
|
126
|
-
# 按「公开文档只写做了什么」去拦是纯误伤(实测某归档库命中 138 条全集中在此类目录)。
|
|
127
|
-
exclude_paths: ["开发者文档/", "sessions/", "worklogs/", "会话/"]
|
|
128
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx", "html", "htm", "md", "markdown", "txt"]
|
|
129
|
-
name: "文档 AI 承诺措辞"
|
|
130
|
-
category: "documentation"
|
|
131
|
-
severity: "blocker"
|
|
132
|
-
description: "文档含 AI 承诺类沟通记录,公开文档应改写"
|
|
133
|
-
pattern: "我(同意|许可|确认|答应|承诺|已按你)"
|
|
134
|
-
fixable: false
|
|
135
|
-
- id: conv-negotiate
|
|
136
|
-
# 归档/笔记类目录整规则跳过:这些文件**本来就是**在记录会话与决策(会话 ID、用户确认、讨论过程),
|
|
137
|
-
# 按「公开文档只写做了什么」去拦是纯误伤(实测某归档库命中 138 条全集中在此类目录)。
|
|
138
|
-
exclude_paths: ["开发者文档/", "sessions/", "worklogs/", "会话/"]
|
|
139
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx", "html", "htm", "md", "markdown", "txt"]
|
|
140
|
-
name: "文档协商措辞"
|
|
141
|
-
category: "documentation"
|
|
142
|
-
severity: "blocker"
|
|
143
|
-
description: "文档含协商讨论记录,公开文档应改写"
|
|
144
|
-
pattern: "我们(商量|讨论|约定|沟通|说好|议定)"
|
|
145
|
-
fixable: false
|
|
146
|
-
- id: conv-log
|
|
147
|
-
# 归档/笔记类目录整规则跳过:这些文件**本来就是**在记录会话与决策(会话 ID、用户确认、讨论过程),
|
|
148
|
-
# 按「公开文档只写做了什么」去拦是纯误伤(实测某归档库命中 138 条全集中在此类目录)。
|
|
149
|
-
exclude_paths: ["开发者文档/", "sessions/", "worklogs/", "会话/"]
|
|
150
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx", "html", "htm", "md", "markdown", "txt"]
|
|
151
|
-
name: "文档对话记录引用"
|
|
152
|
-
category: "documentation"
|
|
153
|
-
severity: "blocker"
|
|
154
|
-
description: "文档引用对话/聊天记录,公开文档应改写"
|
|
155
|
-
pattern: "(对话记录|聊天记录|沟通记录|对话内容|聊天内容)"
|
|
156
|
-
fixable: false
|
|
157
|
-
|
|
158
|
-
# ----- 2026-10-05:注释日期检测(评审规则——AI 注释写日期的毛病)-----
|
|
159
|
-
# 日期属于 git commit(author date + diff),注释只解释「为什么」不该记录「什么时候」。
|
|
160
|
-
# 只扫代码注释载体:js/ts/py 等——md/txt 文档内容日期(CHANGELOG/LICENSE/文章)是正常书写,不扫。
|
|
161
|
-
# @since/@deprecated/@version 是 JSDoc 标准标签(版本语义非变更日志),整行白名单豁免。
|
|
162
|
-
- id: comment/no-date-in-comment
|
|
163
|
-
exts: ["js", "mjs", "cjs", "ts", "tsx", "jsx", "html", "htm", "py"]
|
|
164
|
-
name: "禁止注释中写日期"
|
|
165
|
-
category: "documentation"
|
|
166
|
-
severity: "warning"
|
|
167
|
-
description: "日期属于 git commit(author date + diff + message),不应写进代码注释;注释只解释「为什么这么做」,不记录「什么时候改的」——变更历史交给版本控制"
|
|
168
|
-
# 2026-10-02 修:负向断言 `(?![\d.])`——日分量后不能是数字(防 \d{1,2} 只匹配日的一部分
|
|
169
|
-
# 绕过断言)也不能是 `.`(排除文件名引用 BUGFIX-NOTES-2026-09-14.md——文件名含日期是
|
|
170
|
-
# 历史命名,删了引用失真;注释里引用文件名不算「写日期」)。
|
|
171
|
-
pattern: "(?://|\\*|#)\\s*[^\n]*\\d{4}[-/.]\\d{1,2}[-/.]\\d{1,2}(?![\\d.])"
|
|
172
|
-
whitelist_patterns:
|
|
173
|
-
- "@since"
|
|
174
|
-
- "@deprecated"
|
|
175
|
-
- "@version"
|
|
176
|
-
- "@date"
|
|
177
|
-
fixable: false
|
|
178
|
-
|
|
179
|
-
severity_map:
|
|
180
|
-
info: "info"
|
|
181
|
-
|
|
182
|
-
# ----- 阈值 -----
|
|
183
|
-
thresholds:
|
|
184
|
-
max_info: 30
|
|
185
|
-
|
|
186
|
-
# ----- 忽略规则 -----
|
|
187
|
-
ignore:
|
|
188
|
-
- pattern: "**/*.{test,spec}.{js,ts,jsx,tsx}"
|
|
189
|
-
rules: ["*"]
|
|
190
|
-
- pattern: "**/vendor/**/*"
|
|
191
|
-
rules: ["*"]
|
|
192
|
-
- pattern: "**/dist/**/*"
|
|
193
|
-
rules: ["*"]
|
|
194
|
-
|
|
195
|
-
# ----- 输出 -----
|
|
196
|
-
output:
|
|
197
|
-
format: "json"
|
|
198
|
-
include_suggestions: true
|
|
199
|
-
include_fix_instructions: true
|
|
@@ -1,114 +0,0 @@
|
|
|
1
|
-
# ============================================================
|
|
2
|
-
# C/C++ 代码审计规则集(首版 · 语言专项)
|
|
3
|
-
# 版本:0.2.0
|
|
4
|
-
# 适用:C / C++ 项目(含单片机/嵌入式)
|
|
5
|
-
# 描述:本槽位首版语言专项规则(**纯 pattern 层**,不依赖 AST 函数范围)。
|
|
6
|
-
# 规则依据:对真实 C++ 仓(jarro2783/cxxopts 等样本仓)实测各候选模式的出现次数后选型。
|
|
7
|
-
# (AST 层的 min_length/max_lines/max_complexity/magic-number 仍待补 LANG_FUNC_RANGES.cpp)
|
|
8
|
-
# 口径:exts 覆盖实现与头文件;第三方/构建产物目录排除(生成代码里的 new/strcpy 不该报)。
|
|
9
|
-
# ============================================================
|
|
10
|
-
|
|
11
|
-
metadata:
|
|
12
|
-
name: "C/C++ 审计规则集(首版 · 语言专项)"
|
|
13
|
-
version: "0.2.0"
|
|
14
|
-
language: "cpp"
|
|
15
|
-
author: "DeepSeek"
|
|
16
|
-
description: "C/C++ 项目语言专用规则(pattern 层首版:using namespace/裸 new/不安全 C 串函数/malloc-free/catch-all)"
|
|
17
|
-
last_updated: "2026-10-16"
|
|
18
|
-
|
|
19
|
-
rules:
|
|
20
|
-
# ----- 1. 可维护性 -----
|
|
21
|
-
|
|
22
|
-
- id: cpp/using-namespace
|
|
23
|
-
name: "C/C++ 头文件里避免 using namespace"
|
|
24
|
-
category: "maintainability"
|
|
25
|
-
severity: "warning"
|
|
26
|
-
description: "using namespace 把整棵命名空间的名字引入作用域,头文件里会污染所有包含者并引发重载歧义;应写限定名或只 using 具体符号"
|
|
27
|
-
patterns:
|
|
28
|
-
- "using\\s+namespace\\s+[A-Za-z_]"
|
|
29
|
-
exts: ["c", "cc", "cpp", "cxx", "h", "hh", "hpp", "hxx"]
|
|
30
|
-
exclude_paths:
|
|
31
|
-
- "test/"
|
|
32
|
-
- "tests/"
|
|
33
|
-
- "third_party/"
|
|
34
|
-
- "vendor/"
|
|
35
|
-
- "external/"
|
|
36
|
-
- "examples/"
|
|
37
|
-
- "example/"
|
|
38
|
-
fixable: false
|
|
39
|
-
|
|
40
|
-
- id: cpp/raw-new
|
|
41
|
-
name: "C++ 用智能指针替代裸 new"
|
|
42
|
-
category: "maintainability"
|
|
43
|
-
severity: "warning"
|
|
44
|
-
description: "裸 new 的所有权不表达在类型里,异常/提前 return 都会泄漏;应直接用 make_unique/make_shared 或容器"
|
|
45
|
-
# 负向环视排除 `new[]`、`operator new`、`->new` 以及注释里的普通词
|
|
46
|
-
# astConfirm:行级代码判定——实测 cxxopts 命中过注释里的 "start a new line" ✗(`new ` + 普通词)
|
|
47
|
-
astConfirm: true
|
|
48
|
-
patterns:
|
|
49
|
-
- "(?<![\\w.>:])new\\s+[A-Za-z_:]"
|
|
50
|
-
exts: ["c", "cc", "cpp", "cxx", "h", "hh", "hpp", "hxx"]
|
|
51
|
-
exclude_paths:
|
|
52
|
-
- "test/"
|
|
53
|
-
- "tests/"
|
|
54
|
-
- "third_party/"
|
|
55
|
-
- "vendor/"
|
|
56
|
-
- "external/"
|
|
57
|
-
- "examples/"
|
|
58
|
-
- "example/"
|
|
59
|
-
fixable: false
|
|
60
|
-
|
|
61
|
-
# ----- 2. 安全 -----
|
|
62
|
-
|
|
63
|
-
- id: cpp/unsafe-c-string
|
|
64
|
-
name: "C/C++ 避免不检查边界的 C 串函数"
|
|
65
|
-
category: "security"
|
|
66
|
-
severity: "error"
|
|
67
|
-
description: "strcpy/strcat/sprintf/gets 不做边界检查,是栈溢出的经典来源;应用 snprintf/std::string/strncpy_s 等有界替代"
|
|
68
|
-
patterns:
|
|
69
|
-
- "(?<![\\w.>])(?:strcpy|strcat|sprintf|gets|scanf)\\s*\\("
|
|
70
|
-
exts: ["c", "cc", "cpp", "cxx", "h", "hh", "hpp", "hxx"]
|
|
71
|
-
exclude_paths:
|
|
72
|
-
- "test/"
|
|
73
|
-
- "tests/"
|
|
74
|
-
- "third_party/"
|
|
75
|
-
- "vendor/"
|
|
76
|
-
- "examples/"
|
|
77
|
-
- "example/"
|
|
78
|
-
fixable: false
|
|
79
|
-
|
|
80
|
-
- id: cpp/malloc-free
|
|
81
|
-
name: "C/C++ 手工 malloc/free 需成对且有所有权说明"
|
|
82
|
-
category: "security"
|
|
83
|
-
severity: "warning"
|
|
84
|
-
description: "裸 malloc/free(含 calloc/realloc)不表达所有权,容易漏 free/重复 free;C++ 里应优先容器与智能指针,C 里需明确释放责任"
|
|
85
|
-
patterns:
|
|
86
|
-
- "(?<![\\w.>])(?:malloc|calloc|realloc|free)\\s*\\("
|
|
87
|
-
exts: ["c", "cc", "cpp", "cxx"]
|
|
88
|
-
exclude_paths:
|
|
89
|
-
- "test/"
|
|
90
|
-
- "tests/"
|
|
91
|
-
- "third_party/"
|
|
92
|
-
- "vendor/"
|
|
93
|
-
- "examples/"
|
|
94
|
-
- "example/"
|
|
95
|
-
fixable: false
|
|
96
|
-
|
|
97
|
-
# ----- 3. 健壮性 -----
|
|
98
|
-
|
|
99
|
-
- id: cpp/catch-all
|
|
100
|
-
name: "C++ 避免 catch(...) 吞掉一切异常"
|
|
101
|
-
category: "robustness"
|
|
102
|
-
severity: "notice"
|
|
103
|
-
description: "catch(...) 会连内存不足等不可恢复异常一起吞掉,且无法记录原因;应捕获具体类型,确需兜底时要记录并重新抛出"
|
|
104
|
-
patterns:
|
|
105
|
-
- "catch\\s*\\(\\s*\\.\\.\\.\\s*\\)"
|
|
106
|
-
exts: ["c", "cc", "cpp", "cxx", "h", "hh", "hpp", "hxx"]
|
|
107
|
-
exclude_paths:
|
|
108
|
-
- "test/"
|
|
109
|
-
- "tests/"
|
|
110
|
-
- "third_party/"
|
|
111
|
-
- "vendor/"
|
|
112
|
-
- "examples/"
|
|
113
|
-
- "example/"
|
|
114
|
-
fixable: false
|