dsh-git-push 2.20.18 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (198) hide show
  1. package/README.md +3 -2
  2. package/cli-tool.mjs +2 -4
  3. package/cli.mjs +36 -2
  4. package/lib/app/apply.js +9 -9
  5. package/lib/app/command-registry.js +44 -20
  6. package/lib/app/handlers/meta.js +7 -142
  7. package/lib/app/handlers/npm.js +18 -1
  8. package/lib/app/handlers/preprocess.js +107 -0
  9. package/lib/app/handlers/repo-actions.js +2 -2
  10. package/lib/app/http-handlers.js +25 -12
  11. package/lib/app/index.js +2 -1
  12. package/lib/app/inject-text.js +3 -2
  13. package/lib/app/preprocess-client.js +136 -0
  14. package/lib/app/repo-ownership.js +1 -1
  15. package/lib/app/schema.js +3 -3
  16. package/lib/app/severity.js +14 -0
  17. package/lib/app/slash-commands.js +5 -164
  18. package/lib/app/tool-call.js +75 -140
  19. package/lib/app/tools.js +13 -6
  20. package/lib/cli/commands-preprocess.mjs +74 -0
  21. package/lib/cli/commands-tool.mjs +3 -2
  22. package/lib/cli/commands-vcs.mjs +4 -4
  23. package/lib/cli/shared.mjs +42 -13
  24. package/lib/client-parts/git/controller.js +2 -2
  25. package/lib/client.js +2 -2
  26. package/lib/commit-push/pre-commit-engine.js +57 -10
  27. package/lib/commit-push.js +125 -36
  28. package/lib/{exempt/index.js → git/exempt-markers.js} +8 -1
  29. package/lib/git/ignore.js +1 -1
  30. package/lib/git/repos.js +2 -2
  31. package/lib/git/sensitive.js +1 -1
  32. package/lib/npm/publish.js +20 -5
  33. package/lib/plugin/auto-push.js +2 -2
  34. package/lib/preprocess/providers.js +191 -0
  35. package/lib/self/index.js +1 -1
  36. package/lib/skip-dirs.js +14 -55
  37. package/package.json +29 -37
  38. package/scripts/build-client.mjs +2 -0
  39. package/scripts/check.mjs +4 -2
  40. package/scripts/local-registry.mjs +2 -1
  41. package/skills/dev/dsh-git-push.md +5 -0
  42. package/cli-audit.mjs +0 -141
  43. package/lib/app/audit-api.js +0 -173
  44. package/lib/app/host-doc-checks.js +0 -25
  45. package/lib/app/scope-check.js +0 -69
  46. package/lib/ast/brace.js +0 -120
  47. package/lib/ast/callgraph.js +0 -135
  48. package/lib/ast/code-lines.js +0 -175
  49. package/lib/ast/consts.js +0 -12
  50. package/lib/ast/control-flow.js +0 -470
  51. package/lib/ast/credential.js +0 -315
  52. package/lib/ast/dataflow.js +0 -391
  53. package/lib/ast/dup-code.js +0 -165
  54. package/lib/ast/fs-hotspots.js +0 -154
  55. package/lib/ast/index.js +0 -38
  56. package/lib/ast/io-risk-const.js +0 -95
  57. package/lib/ast/io-risk-fn.js +0 -208
  58. package/lib/ast/io-risk-loop.js +0 -308
  59. package/lib/ast/io-risk.js +0 -314
  60. package/lib/ast/lang.js +0 -156
  61. package/lib/ast/line-count.js +0 -52
  62. package/lib/ast/magic-number.js +0 -272
  63. package/lib/ast/naming.js +0 -292
  64. package/lib/ast/perf.js +0 -488
  65. package/lib/ast/scope-collisions.js +0 -228
  66. package/lib/ast/scope.js +0 -241
  67. package/lib/ast/shell.js +0 -131
  68. package/lib/ast/size.js +0 -448
  69. package/lib/ast/symbol-index.js +0 -399
  70. package/lib/ast/tokenizer.js +0 -421
  71. package/lib/ast/treesitter.js +0 -413
  72. package/lib/audit/analysis-coverage.js +0 -98
  73. package/lib/audit/audit-file.js +0 -205
  74. package/lib/audit/auditignore-rules.js +0 -148
  75. package/lib/audit/checks.js +0 -17
  76. package/lib/audit/client-entry.js +0 -93
  77. package/lib/audit/collector.js +0 -610
  78. package/lib/audit/ext-runner.js +0 -80
  79. package/lib/audit/file-context.js +0 -391
  80. package/lib/audit/finding.js +0 -101
  81. package/lib/audit/gitignore-match.js +0 -113
  82. package/lib/audit/glob.js +0 -63
  83. package/lib/audit/history-report.js +0 -100
  84. package/lib/audit/history.js +0 -126
  85. package/lib/audit/ignore-blind.js +0 -102
  86. package/lib/audit/index.js +0 -33
  87. package/lib/audit/orchestrate.js +0 -672
  88. package/lib/audit/public.js +0 -24
  89. package/lib/audit/repo-level.js +0 -30
  90. package/lib/audit/report-yaml.js +0 -90
  91. package/lib/audit/scope-policy.js +0 -110
  92. package/lib/audit/slot.js +0 -66
  93. package/lib/audit-rules/audit-rules-comment.yml +0 -199
  94. package/lib/audit-rules/audit-rules-cpp.yml +0 -114
  95. package/lib/audit-rules/audit-rules-csharp.yml +0 -82
  96. package/lib/audit-rules/audit-rules-docs.yml +0 -32
  97. package/lib/audit-rules/audit-rules-dsh.yml +0 -177
  98. package/lib/audit-rules/audit-rules-filehealth.yml +0 -42
  99. package/lib/audit-rules/audit-rules-folder.yml +0 -99
  100. package/lib/audit-rules/audit-rules-frontend.yml +0 -335
  101. package/lib/audit-rules/audit-rules-go.yml +0 -103
  102. package/lib/audit-rules/audit-rules-i18n.yml +0 -45
  103. package/lib/audit-rules/audit-rules-java.yml +0 -105
  104. package/lib/audit-rules/audit-rules-nodejs.yml +0 -662
  105. package/lib/audit-rules/audit-rules-npm.yml +0 -187
  106. package/lib/audit-rules/audit-rules-paths.yml +0 -98
  107. package/lib/audit-rules/audit-rules-performance.yml +0 -245
  108. package/lib/audit-rules/audit-rules-php.yml +0 -101
  109. package/lib/audit-rules/audit-rules-private.yml +0 -24
  110. package/lib/audit-rules/audit-rules-python.yml +0 -106
  111. package/lib/audit-rules/audit-rules-robustness.yml +0 -31
  112. package/lib/audit-rules/audit-rules-rust.yml +0 -109
  113. package/lib/audit-rules/audit-rules-structure.yml +0 -158
  114. package/lib/audit-rules/audit-rules-swift.yml +0 -99
  115. package/lib/audit-rules/audit-rules-template.yml +0 -108
  116. package/lib/audit-ui-sdk/contract.js +0 -117
  117. package/lib/audit-ui-sdk/index.js +0 -17
  118. package/lib/checks/button-bind.js +0 -347
  119. package/lib/checks/common.js +0 -170
  120. package/lib/checks/credential-file.js +0 -43
  121. package/lib/checks/dataflow.js +0 -40
  122. package/lib/checks/dispatch.js +0 -117
  123. package/lib/checks/dup-code.js +0 -69
  124. package/lib/checks/dup-const.js +0 -232
  125. package/lib/checks/file-health.js +0 -150
  126. package/lib/checks/filter.js +0 -137
  127. package/lib/checks/folder.js +0 -173
  128. package/lib/checks/fs-scanner.js +0 -57
  129. package/lib/checks/hardcoded-path.js +0 -98
  130. package/lib/checks/index.js +0 -49
  131. package/lib/checks/io.js +0 -66
  132. package/lib/checks/magic-number.js +0 -42
  133. package/lib/checks/npm-json.js +0 -273
  134. package/lib/checks/private.js +0 -64
  135. package/lib/checks/regex.js +0 -298
  136. package/lib/checks/scope-collision.js +0 -68
  137. package/lib/checks/semantic.js +0 -134
  138. package/lib/checks/structural.js +0 -281
  139. package/lib/cli/commands-audit.mjs +0 -142
  140. package/lib/cli/commands-doc.mjs +0 -127
  141. package/lib/client-parts/audit/audit.js +0 -301
  142. package/lib/exempt/tool.js +0 -198
  143. package/lib/git/module-splitter.js +0 -47
  144. package/lib/link-check/index.js +0 -187
  145. package/lib/lint-adapter/detect.js +0 -161
  146. package/lib/lint-adapter/index.js +0 -50
  147. package/lib/lint-adapter/runner.js +0 -133
  148. package/lib/rule/compilers/credential.js +0 -62
  149. package/lib/rule/compilers/dataflow.js +0 -38
  150. package/lib/rule/compilers/file-health.js +0 -75
  151. package/lib/rule/compilers/frontend.js +0 -86
  152. package/lib/rule/compilers/func.js +0 -35
  153. package/lib/rule/compilers/helpers.js +0 -71
  154. package/lib/rule/compilers/index.js +0 -29
  155. package/lib/rule/compilers/link-semantic.js +0 -45
  156. package/lib/rule/compilers/list-kinds.js +0 -12
  157. package/lib/rule/compilers/numeric-kinds.js +0 -73
  158. package/lib/rule/compilers/regex.js +0 -78
  159. package/lib/rule/compilers/structure.js +0 -107
  160. package/lib/rule/compilers.js +0 -17
  161. package/lib/rule/homoglyph.js +0 -45
  162. package/lib/rule/loader.js +0 -274
  163. package/lib/rule/registry.js +0 -122
  164. package/lib/rule/scope.js +0 -67
  165. package/lib/score/docs-score.js +0 -166
  166. package/lib/score/index.js +0 -234
  167. package/scripts/__pycache__/module-splitter.cpython-38.pyc +0 -0
  168. package/scripts/audit-ext/_example-readme-present.mjs +0 -34
  169. package/scripts/audit-ext/dsh-inject-declarations.mjs +0 -209
  170. package/scripts/audit-ext/variable-min-length.mjs +0 -102
  171. package/scripts/audit-gate.mjs +0 -235
  172. package/scripts/audit-runner.mjs +0 -35
  173. package/scripts/audit-runtime-check.mjs +0 -129
  174. package/scripts/browser-page-probe.mjs +0 -271
  175. package/scripts/check-js-scope.mjs +0 -87
  176. package/scripts/clean-date-comments.py +0 -102
  177. package/scripts/cpu-sample.mjs +0 -188
  178. package/scripts/doc-drift.mjs +0 -200
  179. package/scripts/hot-path-probe-cjs.cjs +0 -71
  180. package/scripts/hot-path-probe-fs-shim.mjs +0 -28
  181. package/scripts/hot-path-probe-fsp-shim.mjs +0 -31
  182. package/scripts/hot-path-probe.mjs +0 -153
  183. package/scripts/module-splitter.py +0 -800
  184. package/scripts/picker-repro.mjs +0 -115
  185. package/scripts/platform-scan.mjs +0 -168
  186. package/scripts/probe-recheck.mjs +0 -47
  187. package/scripts/rename-locator.mjs +0 -97
  188. package/scripts/rule-switch.mjs +0 -97
  189. package/scripts/rules-solo-audit.mjs +0 -173
  190. package/scripts/scan-file-io.mjs +0 -717
  191. package/scripts/scan-fs-hotspots.mjs +0 -107
  192. package/scripts/symbol-index.mjs +0 -85
  193. package/scripts/verify-prestep.mjs +0 -100
  194. package/skills/dev/audit-rule-authoring.md +0 -58
  195. package/skills/guide/guide-audit.md +0 -270
  196. /package/lib/{audit → app}/ownership.js +0 -0
  197. /package/lib/app/{schema-audit.js → schema-preprocess.js} +0 -0
  198. /package/lib/{audit-defaults.js → git/defaults.js} +0 -0
@@ -1,24 +0,0 @@
1
- # 私密拦截审计规则(强制加载槽位)
2
- # 强制加载:无论 auditRuleOrder 如何配置,本槽位永远合并进最终规则集(末尾追加,优先级最高)。
3
- # 语义:仓库跟踪到以下私密文件时,按远端可见性分级——
4
- # public → blocker 拦截提交(私密文件已可被任何人获取);private/unknown → warning 提醒。
5
- # 本文件是规则文件也是权重文件:清单增删即规则调整(与插件其它 YAML 规则一致)。
6
- metadata:
7
- name: 私密文件拦截审计(强制槽位)
8
- author: EIGHTfs
9
- version: "1.0.0"
10
- private_files:
11
- - "**/id_ed25519"
12
- - "**/id_rsa"
13
- - "**/*.pem"
14
- - "**/*.key"
15
- - "**/github-token"
16
- - "**/.git-push-token"
17
- - "**/.env"
18
- - "**/.env.*"
19
- - "**/data/sensitive/**"
20
- - "**/.ssh/**"
21
- - "**/.dsh/git-push/**"
22
- - "**/.npmrc"
23
- - "**/*@*.{md,txt,js,json}" # 邮箱形态文件名(如 your-name@example.com 占位文件)——历史踩坑:真实邮箱做占位文件名入库,含空文件仓无法走 Git Data API 推送且邮箱公开
24
- rules: []
@@ -1,106 +0,0 @@
1
- # ============================================================
2
- # Python 代码审计规则集
3
- # 作者:DeepSeek
4
- # 版本:1.0.0
5
- # 适用:Python 项目
6
- # 描述:按文件类型识别路由——.py 文件由本槽位承载语言无关规则,
7
- # nodejs 槽位的同类规则不再接管 Python(2026-10-05 划分)。
8
- # 背景:全量审计 KToolBox(Python + TSX 混合,408 文件)时 nodejs slot 对 .py
9
- # 套 JS 规则,3009 条问题里 2882 条来自 nodejs(评分失真 56/C)。
10
- # 修复:① AST 层豁免 Python 枚举成员(magic-number 的
11
- # collectPythonEnumAssignLines)、i18n 键/路由路径(repeated 豁免)、
12
- # 文档示例凭据(placeholder-credential 文档级豁免);
13
- # ② 本槽位承接 Python 文件的语言无关规则(命名/长度/复杂度/嵌套/魔数)。
14
- # 最后更新:2026-10-05
15
- # ============================================================
16
-
17
- metadata:
18
- name: "Python 审计规则集"
19
- version: "1.0.0"
20
- language: "python"
21
- author: "DeepSeek"
22
- description: "Python 项目语言无关规则:命名规范、魔数、函数长度、嵌套深度、圈复杂度、文件长度"
23
- last_updated: "2026-10-05"
24
-
25
- rules:
26
- # ----- 1. 可读性 -----
27
- # 全部规则 exts: ["py"]——本槽位只审计 Python 文件(文件类型识别路由的落点)。
28
- # 检查器复用:max_depth/max_lines/max_complexity/min_length 字段由 numeric-kinds
29
- # 编译器自动派发到 max-depth/max-lines/func-lines/max-complexity/min-length kind,
30
- # 与 nodejs 槽位同一套检查器(tokenizer 支持 py 语法,class/def/缩进可解析)。
31
-
32
- - id: python/variable-min-length
33
- name: "Python 变量名长度不少于 2 个字符"
34
- category: "readability"
35
- severity: "warning"
36
- description: "过短的变量名(如 a, b, x)降低代码可读性(Python 版)"
37
- min_length: 2
38
- exts: ["py"]
39
- exceptions: ["i", "j", "k", "n", "e", "cb"]
40
- fixable: false
41
-
42
- - id: python/magic-number
43
- name: "Python 硬编码魔数检测(枚举成员豁免版)"
44
- kind: "magic-number-smart"
45
- category: "readability"
46
- severity: "warning"
47
- description: "检测硬编码魔数,自动豁免版本号/日期/HTTP 状态码/常见常量/**Python 枚举成员**(class X(Enum/IntEnum) 体内的大写 NAME = 数字)"
48
- magic_number_hints: ["timeout", "retry", "max", "min", "limit", "size", "count", "port", "interval", "delay", "duration", "threshold", "buffer", "chunk"]
49
- legitimate_hints: ["version", "date", "year", "month", "day", "hour", "minute", "second", "http", "status"]
50
- force_count: 3
51
- exts: ["py"]
52
- fixable: true
53
- mitigation: "提取命名常量并注释含义:MAX_RETRY = 3; 版本号/日期/HTTP 状态码/常见常量/枚举成员自动豁免"
54
-
55
- - id: python/max-nesting-depth
56
- name: "Python 嵌套过深(缩进层级 > 4)"
57
- category: "readability"
58
- severity: "warning"
59
- description: "代码缩进嵌套超过 4 层(如 for→for→if→if),可读性灾难,应提前 return 或抽函数(Python 版)"
60
- max_depth: 4
61
- exts: ["py"]
62
- fixable: false
63
-
64
- - id: python/max-function-length
65
- name: "Python 函数长度不超过 50 行"
66
- category: "readability"
67
- severity: "warning"
68
- description: "过长的函数难以理解和维护(Python 版)"
69
- max_lines: 50
70
- exts: ["py"]
71
- # 2026-10-05(评审规则③):序列化/反序列化职责函数豁免——意义明确、变量生命周期
72
- # 仅当前会话时代码常超百行,过度拆分复杂化数据传递与生命周期(得不偿失)。
73
- scope_rules:
74
- - scope: "serialization"
75
- action: "exempt"
76
- reason: "序列化/反序列化职责函数:意义明确且变量生命周期仅当前会话,超百行是职责自然形态"
77
- fixable: true
78
-
79
- - id: python/max-file-length
80
- name: "Python 文件总行数不超过 400 行"
81
- category: "readability"
82
- severity: "warning"
83
- description: "单文件超过 400 行时应拆分模块(Python 版;存量超大文件为已知债务,仅提醒不拦截)"
84
- max_lines: 400
85
- exts: ["py"]
86
- fixable: false
87
-
88
- - id: python/comment-density
89
- name: "Python 行注释密度过高(注释复述代码)"
90
- category: "readability"
91
- severity: "warning"
92
- description: "变量即注释——语义明确的代码里变量名已表达内容,额外的行注释不加深理解;只保留具有隐性约束、复杂设计、外部契约、非显然决策的块注释,注释应解释「为什么」而非复述「做了什么」"
93
- threshold: 0.4
94
- exts: ["py"]
95
- fixable: false
96
-
97
- # ----- 2. 可维护性 -----
98
- - id: python/max-cyclomatic-complexity
99
- name: "Python 圈复杂度不超过 10(50 以上 blocker)"
100
- category: "maintainability"
101
- severity: "blocker"
102
- description: "圈复杂度评级(2026-10-02 用户口径):1~10 良好、11~20 中等(warning)、21~50 高风险(warning,应拆分)、50+ 极难维护(blocker 拦提交)——分支点:if/elif 每分支、for/while、try/except、with/assert、and/or"
103
- max_complexity: 10
104
- block_complexity: 50
105
- exts: ["py"]
106
- fixable: false
@@ -1,31 +0,0 @@
1
- # dsh-skip-sensitive: 规则定义文件含符号示范文本(fs.writeFile 等非真实数据)
2
- # dsh-skip-residue: 规则定义文件含 debugger/console 模式串示范(规则定义本身)
3
- # dsh-git-push 审计规则(robustness 槽位,1.0.3)
4
- # 规则类型由编译函数按字段自动指派(pattern/patterns → regex kind)。
5
- # dimensions:10 维度绑定,支持一字段多维度。
6
- metadata:
7
- name: "健壮性审计规则(写文件目录保障等)"
8
- version: "1.0.3"
9
-
10
- rules:
11
- # ── 写文件前确保父目录存在(mkdir-before-write,用户素材)──
12
- - id: robustness/mkdir-before-write
13
- name: "写文件前必须确保目录存在"
14
- category: "robustness"
15
- severity: "warning"
16
- description: "本函数体内未见 mkdir/ensureDir 类建目录调用就往目标路径写文件——若目录由自定义辅助函数或调用方准备,请确认后忽略"
17
- # 措辞刻意**不断言「代码有 bug」**:判定是静态的,认不出的形态(跨文件 helper、动态目录、
18
- # 由调用方保证的目录)都会落在这里。写成断言式会让人以为代码真错了(外部会话反馈第 3 点)。
19
- # 同函数体的 mkdir / ensure*Dir / mkdirp / mkdtemp,以及**本文件内**「函数体含 mkdir」的
20
- # helper 调用,都会被判为已建目录(见 lib/audit/file-context.js 的 hasMkdirInSameFunction)。
21
- # 正则初筛 → token 级精筛(makeCodeLineFilter):剔除注释与字符串里的调用示例。
22
- # 本规则是纯 regex,此前会把**说明本规则自身的文档**也命中——实测
23
- # lib/checks/common.js 的 JSDoc(「会把注释/字符串里的 `fs.writeFile(...)`
24
- # 示例一并命中」这句话本身)被报成 mkdir-before-write,属自举误报。
25
- astConfirm: true
26
- patterns:
27
- - "fs\\.(writeFile|writeFileSync|appendFile|appendFileSync|createWriteStream)\\s*\\("
28
- # 豁免场景:目录通常已存在的常见情况
29
- exceptions:
30
- - "目标目录为项目根目录"
31
- - "目标目录已被显式创建"
@@ -1,109 +0,0 @@
1
- # ============================================================
2
- # Rust 代码审计规则集(首版 · 语言专项)
3
- # 版本:0.2.0
4
- # 适用:Rust 项目
5
- # 描述:本槽位首版语言专项规则(**纯 pattern 层**,不依赖 AST 函数范围)。
6
- # 规则依据:对真实 Rust 仓(dtolnay/anyhow 等样本仓)实测各候选模式的出现次数后选型。
7
- # (AST 层的 min_length/max_lines/max_complexity/magic-number 仍待补 LANG_FUNC_RANGES.rust)
8
- # 口径:exts 只认 .rs;测试目录排除(测试里 unwrap/println 是惯用写法)。
9
- # ============================================================
10
-
11
- metadata:
12
- name: "Rust 审计规则集(首版 · 语言专项)"
13
- version: "0.2.0"
14
- language: "rust"
15
- author: "DeepSeek"
16
- description: "Rust 项目语言专用规则(pattern 层首版:unwrap/unimplemented!/panic!/println!/unsafe)"
17
- last_updated: "2026-10-16"
18
-
19
- rules:
20
- # ----- 1. 健壮性 -----
21
-
22
- - id: rust/unwrap-in-production
23
- name: "Rust 生产代码避免裸 unwrap()"
24
- category: "robustness"
25
- severity: "warning"
26
- description: "裸 unwrap() 在 None/Err 时直接 panic(等于崩溃);生产路径应用 ? / unwrap_or / match 显式处置"
27
- # 只匹配无参 unwrap()(unwrap_or/unwrap_or_else 等带参形态不在此列 ✓)
28
- patterns:
29
- - "\\.unwrap\\s*\\(\\s*\\)"
30
- exts: ["rs"]
31
- exclude_paths:
32
- - "tests/"
33
- - "test/"
34
- - "benches/"
35
- - "benchmarks/"
36
- - "examples/"
37
- - "example/"
38
- fixable: false
39
-
40
- - id: rust/unimplemented-macro
41
- name: "Rust 禁止遗留 unimplemented!/todo!"
42
- category: "robustness"
43
- severity: "error"
44
- description: "unimplemented!/todo! 是明确的「未实现」占位,运行到即 panic;合入主干前必须补齐实现"
45
- # astConfirm:行级「是否代码行」判定——实测 anyhow 的 16 条命中里 **14 条落在文档注释**
46
- # (`/// # unimplemented!()` 这类用法示例 ✗)⇒ 不加这层会把文档当违规
47
- astConfirm: true
48
- patterns:
49
- - "(?<![\\w!])(?:unimplemented|todo)\\s*!"
50
- exts: ["rs"]
51
- exclude_paths:
52
- - "tests/"
53
- - "test/"
54
- - "examples/"
55
- - "example/"
56
- fixable: false
57
-
58
- - id: rust/panic-macro
59
- name: "Rust 慎用 panic!"
60
- category: "robustness"
61
- severity: "warning"
62
- description: "panic! 用于不可恢复错误;库代码应返回 Result,把处置权交给调用方"
63
- # 同 unimplemented-macro:文档注释里常出现 panic! 示例 ⇒ 行级代码判定
64
- astConfirm: true
65
- patterns:
66
- - "(?<![\\w!])panic\\s*!"
67
- exts: ["rs"]
68
- exclude_paths:
69
- - "tests/"
70
- - "test/"
71
- - "examples/"
72
- - "example/"
73
- fixable: false
74
-
75
- # ----- 2. 可维护性 -----
76
-
77
- - id: rust/println-debug
78
- name: "Rust 避免用 println! 输出运行期信息"
79
- category: "maintainability"
80
- severity: "notice"
81
- description: "println! 直写 stdout 且无级别/目标控制;库与服务代码应走 log/tracing"
82
- astConfirm: true
83
- patterns:
84
- - "(?<![\\w!])println\\s*!"
85
- - "(?<![\\w!])print\\s*!"
86
- exts: ["rs"]
87
- exclude_paths:
88
- - "tests/"
89
- - "test/"
90
- - "benches/"
91
- - "examples/"
92
- - "example/"
93
- # build.rs 是构建脚本:编译期进度/诊断打印是常态(实测 anyhow 的 13 条里有 8 条在 build.rs)
94
- - "build.rs"
95
- fixable: false
96
-
97
- # ----- 3. 安全 -----
98
-
99
- - id: rust/unsafe-block
100
- name: "Rust unsafe 块需显式评审"
101
- category: "security"
102
- severity: "error"
103
- description: "unsafe 关闭借用检查等保证,内存安全需自行论证;每处 unsafe 都应附安全前提注释,且尽量收敛到最小块"
104
- astConfirm: true
105
- patterns:
106
- - "(?<![\\w:.])unsafe\\s*\\{"
107
- - "(?<![\\w:.])unsafe\\s+fn\\b"
108
- exts: ["rs"]
109
- fixable: false
@@ -1,158 +0,0 @@
1
- # 目录结构规范(本地定制版)
2
- # 依据:DeepSeek《项目目录结构规范(最小通用版)v1.0》+ 本地逐条取舍讨论。
3
- # 定位:本项目(DSH 插件 / 纯 JS + ESM + 无编译)的目录结构约定——
4
- # 不是照搬通用规范,而是「取最小集 + 按需扩展 + 统一单数」。
5
- # 执行:path-regex 规则校验「新增/变更文件的路径」是否违反单数命名(warning 提醒不拦截);
6
- # 目录缺失/依赖方向等结构性约定由人/AI 遵守(详见 directory_roles 与 dependency_rules)。
7
- metadata:
8
- name: 目录结构规范(本地定制版)
9
- author: EIGHTfs
10
- version: "1.0.0"
11
- description: "dsh-git-push 目录结构取舍结论:lib/ 平铺即源码(不引入 src/)、docs/ skills/ 保留、无 script/config/dist/log 空目录;统一单数命名(tool/ test/ doc/,不用 tools/ tests/ docs/)"
12
-
13
- # ============================================================
14
- # 一、取舍结论(2026-09-09 逐条讨论后定稿)
15
- # ============================================================
16
- decisions:
17
- - item: "src/"
18
- keep: false
19
- reason: "纯 JS + ESM + 无编译,src/ 无收益(不编译就不需要源码/产物分离);已模块化拆分,lib/ 即源码"
20
- - item: "lib/"
21
- keep: true
22
- reason: "DSH 插件生态惯例,lib/ 即核心代码目录(33 个功能模块);与规范『lib/ 只放第三方适配』语义错位但保留——插件场景下 lib/ 就是 src/"
23
- - item: "tool/ 独立目录"
24
- keep: false
25
- reason: "cli.mjs 留根级(package.json bin 指向)+ lib/plugin-tools.js 单文件(9 工具 286 行)够用;到 30+ 工具再拆 tool/"
26
- - item: "test/ 分层(unit/integration/e2e/fixture)"
27
- keep: false
28
- reason: "纯函数级单测无 unit/integration 实质分界;14 个 test-<module>.mjs 平铺,找测试=找模块;fixture 多了再收 test/fixture/"
29
- - item: "doc/ 单数"
30
- keep: false
31
- reason: "现有 docs/(复数)已建立索引习惯,改名纯成本;新增目录一律单数,存量 docs/ 作为历史约定保留"
32
- - item: "script/ config/ dist/ log/"
33
- keep: false
34
- reason: "无构建步骤(源码即产物);配置走 settings 机制 + lib/ 内 yml 规则数据(audit-rules/ 同源部署,不抽顶层)"
35
- - item: "skills/"
36
- keep: true
37
- reason: "DSH 插件特性:注入给 AI 的手册(dsh-git-push.md / dsh-git-push-functions.md / git-workflow-gitpush/),通用规范未覆盖"
38
- - item: "client/ 独立目录(fullstack 场景)"
39
- keep: false
40
- reason: "DSH 客户端插件必须挂固定命名空间,不能自由放 client/;前端在 lib/client.js + lib/viewer.js 内"
41
-
42
- # ============================================================
43
- # 二、核心原则
44
- # ============================================================
45
- principles:
46
- - "一致性优先于花哨:同类文件放同目录,同目录命名风格统一"
47
- - "统一单数:所有功能目录用单数(tool/、test/、doc/、lib/),不用复数(tools/、tests/、docs/、libs/)"
48
- - "工具与源码同库:cli.mjs 根级 + lib/plugin-tools.js 注册 agent 工具,不建空 tool/ 目录"
49
- - "规则数据随代码:audit-rules/*.yml 放 lib/ 子目录(files 白名单 + 相对路径解析依赖)"
50
- - "最小可用:不预设未来需求,目录按需添加"
51
-
52
- # ============================================================
53
- # 三、目录清单(单数标准 + 复数禁止)
54
- # ============================================================
55
- naming:
56
- standard_singular:
57
- - "lib/" # 核心代码(本项目语义:即 src/)
58
- - "test/" # 测试(test-<module>.mjs 平铺)
59
- - "doc/" # 文档标准名(本项目存量用 docs/,新目录用 doc/)
60
- - "tool/" # 工具标准名(当前未建独立目录,cli.mjs 根级 + lib/plugin-tools.js)
61
- - "script/" # 运维脚本(当前无)
62
- - "config/" # 非代码配置(当前无,配置走 settings)
63
- - "dist/" # 构建产物(当前无)
64
- - "log/" # 日志(当前无)
65
- forbidden_plural:
66
- - "tools/"
67
- - "tests/"
68
- - "libs/"
69
- - "docs/" # 存量例外:现有 docs/ 保留不报;新目录禁止再建复数 docs/
70
- - "scripts/"
71
- - "configs/"
72
- allowed_legacy:
73
- - "docs/" # 历史约定(任务清单/检查清单所在),不再新增兄弟复数目录
74
-
75
- # ============================================================
76
- # 四、各目录职责(本地实际)
77
- # ============================================================
78
- directory_roles:
79
- - name: "lib/"
80
- role: "全部业务代码(平级模块化,等价规范 src/core + src/host + src/shared 合并)"
81
- contents:
82
- - "core.js - 门面 re-export(13 模块,0 import,等价 shared 无依赖层)"
83
- - "git-core.js - git 基础执行"
84
- - "github-api.js - GitHub API 访问(Git Data API / SSH 回退)"
85
- - "commit-push.js - 提交推送编排"
86
- - "audit.js - 审计引擎(L0 静态 + 规则执行)"
87
- - "rule-packs.js - YAML 规则装载/编译"
88
- - "audit-rules/ - 规则数据(nodejs/frontend/comment/dsh/npm/version/template/private/structure)"
89
- - "plugin-*.js - 装配层(host 等价:工具注册/HTTP/设置/审计服务接线)"
90
- - "client.js viewer.js- 客户端 UI(DSH 命名空间内)"
91
- dependencies: "模块间单向依赖、无环(拆分时保证);装配层依赖业务模块,业务模块不依赖装配层"
92
-
93
- - name: "test/"
94
- role: "自动化测试(纯函数级单测)"
95
- contents:
96
- - "test-<module>.mjs - 按被测模块命名(audit/core/rule-packs/cli/quality/viewer... 11 套件 476 断言)"
97
- dependencies: "对应 lib/ 模块结构"
98
-
99
- - name: "docs/"
100
- role: "文档(存量复数,历史约定保留)"
101
- contents:
102
- - "任务清单 / code-quality-checklist.yaml / 方案模板"
103
- dependencies: "无"
104
-
105
- - name: "skills/"
106
- role: "注入给 AI 的手册(DSH 插件特性)"
107
- contents:
108
- - "dsh-git-push.md / dsh-git-push-functions.md / task-completion-report.md / git-workflow-gitpush/"
109
- dependencies: "无"
110
-
111
- # ============================================================
112
- # 五、根目录文件
113
- # ============================================================
114
- root_files:
115
- - name: "package.json"
116
- required: true
117
- description: "项目元信息与依赖(files 白名单:lib/skills/docs/cordis.patch.yml)"
118
- - name: "README.md"
119
- required: true
120
- description: "项目说明(含版本记录表)"
121
- - name: ".gitignore"
122
- required: true
123
- description: "忽略规则"
124
- - name: "cli.mjs"
125
- required: true
126
- description: "CLI 入口(package.json bin: git-sluice)"
127
- - name: "cordis.patch.yml"
128
- required: true
129
- description: "DSH 插件配置(插件根)"
130
- - name: ".env.example"
131
- required: false
132
- description: "环境变量模板(当前无,配置走 settings)"
133
-
134
- # ============================================================
135
- # 六、依赖方向规则(已满足,防未来破坏)
136
- # ============================================================
137
- dependency_rules:
138
- - "core.js(门面) → 各业务模块(git-core/github-api/repo-scan/...)"
139
- - "plugin-*.js(装配层) → 业务模块(单向,业务模块不依赖装配层)"
140
- - "audit.js → rule-packs.js → audit-rules/*.yml(规则数据单向)"
141
- - "禁止: 业务模块 → 装配层(plugin-*);装配层只在注册/接线时引用业务模块"
142
- - "禁止: 规则 yml 依赖代码;代码引擎不得依赖具体规则内容(数据驱动)"
143
-
144
- # ============================================================
145
- # 七、机器执行:单数命名校验(path-regex,warning 提醒不拦截)
146
- # ============================================================
147
- # kind: path-regex——对新增/变更文件的路径匹配;命中复数目录名 → warning。
148
- # 注意:docs/ 是存量允许例外(allowed_legacy),不在此拦截。
149
- rules:
150
- - id: structure/dir-singular
151
- name: "目录命名统一单数(复数禁止)"
152
- category: "maintainability"
153
- severity: "warning"
154
- kind: "path-regex"
155
- description: "功能目录统一单数(tool/ test/ doc/ lib/),复数(tools/ tests/ docs/ scripts/ configs/ libs/)违反一致性原则"
156
- pattern: "(?:^|/)(tools|tests|scripts|configs|libs|logs)/"
157
- fixable: false
158
- mitigation: "目录改单数:tools/→tool/、tests/→test/、scripts/→script/、configs/→config/、libs/→lib/、logs/→log/"
@@ -1,99 +0,0 @@
1
- # ============================================================
2
- # Swift 代码审计规则集(首版 · 语言专项)
3
- # 版本:0.2.0
4
- # 适用:Swift 项目(iOS/macOS)
5
- # 描述:本槽位首版语言专项规则(**纯 pattern 层**,不依赖 AST 函数范围)。
6
- # 规则依据:对真实 Swift 仓(SnapKit/SnapKit 等样本仓)实测各候选模式的出现次数后选型——
7
- # 例:`as!` 17 次、`fatalError(` 16 次(都是真实存在的强制形态 ✓),而 `try!` 0 次
8
- # (仍是高价值规则 ✓:一旦出现就是崩溃点)。
9
- # (AST 层的 min_length/max_lines/max_complexity/magic-number 仍待补 LANG_FUNC_RANGES.swift)
10
- # ============================================================
11
-
12
- metadata:
13
- name: "Swift 审计规则集(首版 · 语言专项)"
14
- version: "0.2.0"
15
- language: "swift"
16
- author: "DeepSeek"
17
- description: "Swift 项目语言专用规则(pattern 层首版:try!/as!/fatalError/print 调试/隐式解包属性)"
18
- last_updated: "2026-10-16"
19
-
20
- rules:
21
- # ----- 1. 健壮性 -----
22
-
23
- - id: swift/force-try
24
- name: "Swift 避免 try! 强制抛错"
25
- category: "robustness"
26
- severity: "error"
27
- description: "try! 在抛错时直接崩溃;应 try? 兜底或 do/catch 显式处置(能被测试覆盖的分支才算处理过)"
28
- patterns:
29
- - "(?<![\\w.])try\\s*!"
30
- exts: ["swift"]
31
- exclude_paths:
32
- - "Tests/"
33
- - "tests/"
34
- - "Examples/"
35
- - "examples/"
36
- fixable: false
37
-
38
- - id: swift/force-cast
39
- name: "Swift 避免 as! 强制类型转换"
40
- category: "robustness"
41
- severity: "warning"
42
- description: "as! 类型不符即崩溃;应 as? + guard/if let 分支处理,或改用协议/泛型在编译期约束类型"
43
- patterns:
44
- - "(?<![\\w.])as\\s*!"
45
- exts: ["swift"]
46
- exclude_paths:
47
- - "Tests/"
48
- - "tests/"
49
- - "Examples/"
50
- - "examples/"
51
- fixable: false
52
-
53
- - id: swift/fatal-error
54
- name: "Swift fatalError 需限定在不可恢复处"
55
- category: "robustness"
56
- severity: "warning"
57
- description: "fatalError 直接终止进程;只应用于「程序性不可能到达」的断言式场景(如接口误用),业务错误应抛错或返回 Result"
58
- patterns:
59
- - "(?<![\\w.])fatalError\\s*\\("
60
- exts: ["swift"]
61
- exclude_paths:
62
- - "Tests/"
63
- - "tests/"
64
- - "Examples/"
65
- - "examples/"
66
- fixable: false
67
-
68
- # ----- 2. 可维护性 -----
69
-
70
- - id: swift/print-debug
71
- name: "Swift 避免用 print 输出运行期信息"
72
- category: "maintainability"
73
- severity: "notice"
74
- description: "print 无级别/无目标控制且在生产会直写控制台;应走 os.Logger 等项目日志设施"
75
- patterns:
76
- - "(?<![\\w.])print\\s*\\("
77
- exts: ["swift"]
78
- exclude_paths:
79
- - "Tests/"
80
- - "tests/"
81
- - "Examples/"
82
- - "examples/"
83
- fixable: false
84
-
85
- - id: swift/iuo-property
86
- name: "Swift 慎用隐式解包可选类型(IUO)"
87
- category: "robustness"
88
- severity: "warning"
89
- description: "`var x: T!` 把解包风险推迟到运行期(未赋值即崩溃);应显式 Optional + 可选绑定,仅在生命周期确实保证时使用并注释理由"
90
- # 负向环视排除 `!=`(不等号):`:` 后类型以 `!` 结尾且其后不是 `=`
91
- patterns:
92
- - ":\\s*[A-Za-z_][\\w.\\[\\]<>]*\\s*!(?!=)"
93
- exts: ["swift"]
94
- exclude_paths:
95
- - "Tests/"
96
- - "tests/"
97
- - "Examples/"
98
- - "examples/"
99
- fixable: false
@@ -1,108 +0,0 @@
1
- # ============================================================
2
- # 审计规则纯模板(自定义规则入口)
3
- # 作者:DeepSeek
4
- # 版本:1.0.0
5
- # 描述:空白模板,用于自定义添加审计规则
6
- # 最后更新:2026-09-08
7
- # ============================================================
8
-
9
- metadata:
10
- name: "自定义审计规则集"
11
- version: "1.0.0"
12
- language: "all"
13
- author: "DeepSeek"
14
- description: "根据项目需求自定义填充规则"
15
- last_updated: "2026-09-08"
16
-
17
- rules:
18
- # ----- 示例规则(请替换为你的规则) -----
19
- # - id: category/rule-name
20
- # name: "规则显示名称"
21
- # category: "category"
22
- # severity: "warning" # error | warning | info
23
- # description: "规则详细说明"
24
- # pattern: "^正则表达式$"
25
- # fixable: true
26
- # examples:
27
- # bad: "错误示例"
28
- # good: "正确示例"
29
-
30
- # ----- 目录结构校验(kind: path-regex——对文件路径跑正则,如复数目录名) -----
31
- # - id: structure/dir-singular
32
- # name: "目录命名统一单数"
33
- # category: "maintainability"
34
- # severity: "warning"
35
- # kind: "path-regex"
36
- # pattern: "(?:^|/)(tools|tests|scripts|configs|libs|logs)/"
37
-
38
- # ----- 嵌套深度(kind: max-depth——缩进层级超阈值) -----
39
- # - id: readability/max-nesting-depth
40
- # name: "嵌套过深"
41
- # category: "readability"
42
- # severity: "warning"
43
- # max_depth: 3
44
-
45
- # ----- 重复硬编码字符串(kind: repeated-string——字面量出现数 + 白名单豁免) -----
46
- # - id: security/no-repeated-hardcoded-literals
47
- # name: "检测重复出现的硬编码文本"
48
- # category: "security"
49
- # severity: "warning"
50
- # min_occurrences: 3
51
- # ignore_patterns: ["^\\d+$", "^utf-?8$"]
52
- # ignore_values: ["0", "1", "true", "false", "null", "undefined", "''", "\"\""]
53
-
54
- # ----- 空规则占位(启动时无检查) -----
55
- - id: placeholder/example
56
- name: "示例规则(可删除)"
57
- category: "placeholder"
58
- severity: "info"
59
- description: "请替换为实际规则"
60
- pattern: "^$"
61
- fixable: false
62
-
63
- # ----- 严重级别映射(可自定义) -----
64
- severity_map:
65
- error: "error"
66
- warning: "warning"
67
- info: "info"
68
-
69
- # ----- 阈值配置(按需调整) -----
70
- thresholds:
71
- max_warnings: 20
72
- max_errors: 0
73
- max_info: 50
74
-
75
- # ----- 忽略规则(按需调整) -----
76
- ignore:
77
- - pattern: "**/node_modules/**/*"
78
- rules: ["*"]
79
- - pattern: "**/dist/**/*"
80
- rules: ["*"]
81
- - pattern: "**/*.{test,spec}.js"
82
- rules: ["*"]
83
-
84
- # ----- 输出配置(按需调整) -----
85
- output:
86
- format: "json"
87
- include_suggestions: true
88
- include_code_snippets: true
89
-
90
- # ============================================================
91
- # 注释豁免标记速查(每种拦截类型可独立豁免)
92
- # ============================================================
93
- # 位置语义:写在「文件头注释(前 3 行)」= 整个文件豁免该拦截类型;
94
- # 写在「对应位置注释」= 只豁免该位置(secret 支持行尾单行)。
95
- #
96
- # dsh-skip-sensitive → 豁免敏感内容(secret/凭据/隐私措辞)——行尾=单行 / 文件头=整文件
97
- # dsh-skip-size → 豁免二进制/大文件检查(只能写文件头——文件大小是整文件属性)
98
- # dsh-skip-func-length → 豁免函数长度检查(文件头=全文件;函数定义行尾=单函数)
99
- # dsh-skip-syntax → 豁免语法/JSON/YAML 解析(只能写文件头)
100
- # dsh-skip-quality → 豁免质量评分(func-lines/silent-catch/sync-in-async)(文件头)
101
- # dsh-skip-residue → 豁免残留类(debugger/todo/console)(行尾=单行 / 文件头=整文件)
102
- # dsh-skip-style → 豁免全部 styleRules(文件头)
103
- #
104
- # 示例:
105
- # // dsh-skip-sensitive (行尾=本行不做敏感扫描)
106
- # /** dsh-skip-size */ (文件头=本文件不报大文件)
107
- # function x() { ... } // dsh-skip-func-length (函数定义行尾=跳过该函数长度检查)
108
- include_fix_instructions: true