dsh-git-push 0.0.0-stage → 2.8.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.auditignore +30 -0
- package/.gitignore +39 -0
- package/LICENSE +21 -0
- package/README.md +1486 -2
- package/cli.mjs +360 -0
- package/cordis.patch.yml +14 -0
- package/lib/ARCHITECTURE.md +34 -0
- package/lib/BUGFIX-NOTES-2026-09-14.md +278 -0
- package/lib/app/apply.js +275 -0
- package/lib/app/audit-api.js +158 -0
- package/lib/app/command-registry.js +266 -0
- package/lib/app/constants.js +16 -0
- package/lib/app/handlers/account.js +166 -0
- package/lib/app/handlers/clone.js +168 -0
- package/lib/app/handlers/http-constants.js +9 -0
- package/lib/app/handlers/identity-rewrite.js +94 -0
- package/lib/app/handlers/meta.js +175 -0
- package/lib/app/handlers/npm.js +169 -0
- package/lib/app/handlers/repo-actions.js +143 -0
- package/lib/app/handlers/repos.js +231 -0
- package/lib/app/handlers/settings.js +62 -0
- package/lib/app/host-doc-checks.js +25 -0
- package/lib/app/http-handlers.js +131 -0
- package/lib/app/index.js +30 -0
- package/lib/app/inject-text.js +192 -0
- package/lib/app/scan-root.js +23 -0
- package/lib/app/schema.js +150 -0
- package/lib/app/settings-bridge.js +167 -0
- package/lib/app/slash-commands.js +395 -0
- package/lib/app/slot-stats.js +35 -0
- package/lib/app/tool-call.js +672 -0
- package/lib/app/tools.js +34 -0
- package/lib/ast/brace.js +105 -0
- package/lib/ast/callgraph.js +135 -0
- package/lib/ast/code-lines.js +114 -0
- package/lib/ast/consts.js +12 -0
- package/lib/ast/control-flow.js +461 -0
- package/lib/ast/credential.js +199 -0
- package/lib/ast/dataflow.js +274 -0
- package/lib/ast/dup-code.js +165 -0
- package/lib/ast/index.js +36 -0
- package/lib/ast/io-risk-const.js +95 -0
- package/lib/ast/io-risk-fn.js +208 -0
- package/lib/ast/io-risk-loop.js +308 -0
- package/lib/ast/io-risk.js +314 -0
- package/lib/ast/lang.js +156 -0
- package/lib/ast/line-count.js +52 -0
- package/lib/ast/magic-number.js +272 -0
- package/lib/ast/naming.js +284 -0
- package/lib/ast/perf.js +472 -0
- package/lib/ast/scope.js +241 -0
- package/lib/ast/shell.js +131 -0
- package/lib/ast/size.js +378 -0
- package/lib/ast/symbol-index.js +399 -0
- package/lib/ast/tokenizer.js +341 -0
- package/lib/audit/analysis-coverage.js +98 -0
- package/lib/audit/audit-file.js +182 -0
- package/lib/audit/checks.js +17 -0
- package/lib/audit/client-entry.js +93 -0
- package/lib/audit/collector.js +477 -0
- package/lib/audit/ext-runner.js +80 -0
- package/lib/audit/file-context.js +138 -0
- package/lib/audit/finding.js +50 -0
- package/lib/audit/gitignore-match.js +113 -0
- package/lib/audit/glob.js +63 -0
- package/lib/audit/history-report.js +100 -0
- package/lib/audit/history.js +126 -0
- package/lib/audit/ignore-blind.js +101 -0
- package/lib/audit/index.js +33 -0
- package/lib/audit/orchestrate.js +476 -0
- package/lib/audit/public.js +24 -0
- package/lib/audit/repo-level.js +30 -0
- package/lib/audit/report-yaml.js +86 -0
- package/lib/audit/slot.js +65 -0
- package/lib/audit-defaults.js +18 -0
- package/lib/audit-rules/audit-rules-comment.yml +247 -0
- package/lib/audit-rules/audit-rules-cpp.yml +22 -0
- package/lib/audit-rules/audit-rules-docs.yml +32 -0
- package/lib/audit-rules/audit-rules-dsh.yml +162 -0
- package/lib/audit-rules/audit-rules-filehealth.yml +42 -0
- package/lib/audit-rules/audit-rules-folder.yml +99 -0
- package/lib/audit-rules/audit-rules-frontend.yml +335 -0
- package/lib/audit-rules/audit-rules-go.yml +22 -0
- package/lib/audit-rules/audit-rules-i18n.yml +45 -0
- package/lib/audit-rules/audit-rules-java.yml +105 -0
- package/lib/audit-rules/audit-rules-nodejs.yml +647 -0
- package/lib/audit-rules/audit-rules-npm.yml +187 -0
- package/lib/audit-rules/audit-rules-paths.yml +92 -0
- package/lib/audit-rules/audit-rules-performance.yml +215 -0
- package/lib/audit-rules/audit-rules-php.yml +22 -0
- package/lib/audit-rules/audit-rules-private.yml +24 -0
- package/lib/audit-rules/audit-rules-python.yml +106 -0
- package/lib/audit-rules/audit-rules-robustness.yml +27 -0
- package/lib/audit-rules/audit-rules-rust.yml +22 -0
- package/lib/audit-rules/audit-rules-structure.yml +159 -0
- package/lib/audit-rules/audit-rules-swift.yml +22 -0
- package/lib/audit-rules/audit-rules-template.yml +108 -0
- package/lib/checks/button-bind.js +276 -0
- package/lib/checks/common.js +170 -0
- package/lib/checks/credential-file.js +43 -0
- package/lib/checks/dataflow.js +40 -0
- package/lib/checks/dispatch.js +112 -0
- package/lib/checks/dup-code.js +69 -0
- package/lib/checks/dup-const.js +232 -0
- package/lib/checks/file-health.js +150 -0
- package/lib/checks/filter.js +137 -0
- package/lib/checks/folder.js +173 -0
- package/lib/checks/hardcoded-path.js +98 -0
- package/lib/checks/index.js +46 -0
- package/lib/checks/io.js +66 -0
- package/lib/checks/magic-number.js +42 -0
- package/lib/checks/npm-json.js +273 -0
- package/lib/checks/private.js +63 -0
- package/lib/checks/regex.js +256 -0
- package/lib/checks/semantic.js +134 -0
- package/lib/checks/structural.js +274 -0
- package/lib/cli/commands-account.mjs +107 -0
- package/lib/cli/commands-audit.mjs +144 -0
- package/lib/cli/commands-doc.mjs +127 -0
- package/lib/cli/commands-vcs.mjs +175 -0
- package/lib/client/index.js +162 -0
- package/lib/client-parts/00-loader.js +33 -0
- package/lib/client-parts/01-const.js +207 -0
- package/lib/client-parts/02-utils.js +62 -0
- package/lib/client-parts/03-icons.js +12 -0
- package/lib/client-parts/10-account.js +83 -0
- package/lib/client-parts/11-browser.js +95 -0
- package/lib/client-parts/20-repo.js +374 -0
- package/lib/client-parts/21-audit.js +301 -0
- package/lib/client-parts/22-settings.js +146 -0
- package/lib/client-parts/23-npm.js +383 -0
- package/lib/client-parts/30-page.js +56 -0
- package/lib/client-parts/40-controller.js +1092 -0
- package/lib/client-parts/41-actions.js +279 -0
- package/lib/client-parts/99-apply.js +72 -0
- package/lib/client.js +3195 -0
- package/lib/commit-push.js +148 -0
- package/lib/context/index.js +363 -0
- package/lib/core/atomic-json.js +98 -0
- package/lib/core/config.js +40 -0
- package/lib/core/credentials.js +274 -0
- package/lib/core/endpoints.js +109 -0
- package/lib/core/exec.js +162 -0
- package/lib/exempt/index.js +292 -0
- package/lib/fs/edit-after-read.js +103 -0
- package/lib/fsx.js +87 -0
- package/lib/git/account-status.js +140 -0
- package/lib/git/account.js +233 -0
- package/lib/git/api.js +136 -0
- package/lib/git/atomic-json.js +6 -0
- package/lib/git/browse.js +38 -0
- package/lib/git/clone-download.js +397 -0
- package/lib/git/clone-history-mode.js +143 -0
- package/lib/git/clone-history.js +175 -0
- package/lib/git/clone-jobs.js +250 -0
- package/lib/git/clone-replay-io.js +172 -0
- package/lib/git/clone-replay.js +275 -0
- package/lib/git/clone.js +445 -0
- package/lib/git/cloud.js +46 -0
- package/lib/git/commit-message.js +141 -0
- package/lib/git/config.js +6 -0
- package/lib/git/cred-env.js +88 -0
- package/lib/git/credentials.js +6 -0
- package/lib/git/endpoints.js +6 -0
- package/lib/git/exec.js +6 -0
- package/lib/git/identity-rewrite.js +297 -0
- package/lib/git/identity.js +150 -0
- package/lib/git/ignore.js +69 -0
- package/lib/git/index.js +41 -0
- package/lib/git/module-splitter.js +47 -0
- package/lib/git/post-push.js +101 -0
- package/lib/git/push-diagnose.js +142 -0
- package/lib/git/push.js +476 -0
- package/lib/git/remote-resolve.js +146 -0
- package/lib/git/remote.js +128 -0
- package/lib/git/repo-index.js +512 -0
- package/lib/git/repos.js +235 -0
- package/lib/git/scan-runner.js +159 -0
- package/lib/git/sensitive.js +134 -0
- package/lib/git/transport.js +430 -0
- package/lib/git/visibility.js +35 -0
- package/lib/git/wrapped-git.js +68 -0
- package/lib/http/index.js +170 -0
- package/lib/index.js +24 -0
- package/lib/link-check/index.js +187 -0
- package/lib/npm/account.js +64 -0
- package/lib/npm/install.js +211 -0
- package/lib/npm/npmrc.js +56 -0
- package/lib/npm/publish.js +171 -0
- package/lib/npm/registry.js +168 -0
- package/lib/plugin/auto-detect.js +92 -0
- package/lib/plugin/auto-push.js +154 -0
- package/lib/plugin/index.js +250 -0
- package/lib/readme-templates/readme.yml +38 -0
- package/lib/rule/compilers/credential.js +62 -0
- package/lib/rule/compilers/dataflow.js +38 -0
- package/lib/rule/compilers/file-health.js +75 -0
- package/lib/rule/compilers/frontend.js +86 -0
- package/lib/rule/compilers/func.js +35 -0
- package/lib/rule/compilers/helpers.js +71 -0
- package/lib/rule/compilers/index.js +29 -0
- package/lib/rule/compilers/link-semantic.js +45 -0
- package/lib/rule/compilers/list-kinds.js +12 -0
- package/lib/rule/compilers/numeric-kinds.js +66 -0
- package/lib/rule/compilers/regex.js +78 -0
- package/lib/rule/compilers/structure.js +80 -0
- package/lib/rule/compilers.js +17 -0
- package/lib/rule/homoglyph.js +45 -0
- package/lib/rule/loader.js +270 -0
- package/lib/rule/registry.js +115 -0
- package/lib/rule/scope.js +67 -0
- package/lib/score/docs-score.js +166 -0
- package/lib/score/index.js +140 -0
- package/lib/self/index.js +196 -0
- package/lib/skip-dirs.js +64 -0
- package/lib/tool-probes.json +50 -0
- package/lib/user-requirements.json +14 -0
- package/lib/vendor/js-yaml/LICENSE +21 -0
- package/lib/vendor/js-yaml/js-yaml.mjs +3073 -0
- package/package.json +95 -4
- package/scripts/__pycache__/module-splitter.cpython-38.pyc +0 -0
- package/scripts/audit-ext/_example-readme-present.mjs +34 -0
- package/scripts/audit-ext/variable-min-length.mjs +102 -0
- package/scripts/audit-runner.mjs +35 -0
- package/scripts/audit-runtime-check.mjs +129 -0
- package/scripts/browser-page-probe.mjs +271 -0
- package/scripts/build-client.mjs +119 -0
- package/scripts/check.mjs +88 -0
- package/scripts/clean-date-comments.py +102 -0
- package/scripts/cpu-sample.mjs +188 -0
- package/scripts/doc-drift.mjs +200 -0
- package/scripts/doc-func.mjs +212 -0
- package/scripts/doc-tree.mjs +456 -0
- package/scripts/doc-version.mjs +220 -0
- package/scripts/frontend-preview-check.mjs +124 -0
- package/scripts/hot-path-probe-cjs.cjs +71 -0
- package/scripts/hot-path-probe-fs-shim.mjs +28 -0
- package/scripts/hot-path-probe-fsp-shim.mjs +31 -0
- package/scripts/hot-path-probe.mjs +153 -0
- package/scripts/module-splitter.py +800 -0
- package/scripts/platform-scan.mjs +168 -0
- package/scripts/preview-gen.mjs +489 -0
- package/scripts/preview-local-runner.mjs +55 -0
- package/scripts/preview-server-direct.mjs +116 -0
- package/scripts/preview-server.mjs +305 -0
- package/scripts/preview-slot-data.mjs +123 -0
- package/scripts/probe-recheck.mjs +47 -0
- package/scripts/readme-gen.mjs +268 -0
- package/scripts/rename-locator.mjs +97 -0
- package/scripts/rule-switch.mjs +97 -0
- package/scripts/rules-solo-audit.mjs +173 -0
- package/scripts/scan-file-io.mjs +713 -0
- package/scripts/scan-hardcoded-paths.mjs +125 -0
- package/scripts/scan-repos.mjs +167 -0
- package/scripts/scan-version.mjs +122 -0
- package/scripts/scrub-user-wording.mjs +420 -0
- package/scripts/symbol-index.mjs +85 -0
- package/scripts/sync-plugin-install.mjs +223 -0
- package/scripts/sync-plugin.mjs +279 -0
- package/scripts/verify-prestep.mjs +100 -0
- package/skills/dev/audit-rule-authoring.md +58 -0
- package/skills/dev/dsh-git-push.md +323 -0
- package/skills/dev/git-push-live-fix.md +45 -0
- package/skills/dsh-repo-index.md +35 -0
- package/skills/guide/guide-audit.md +167 -0
- package/skills/guide/guide-cli-scripts.md +104 -0
- package/skills/guide/guide-clone-repos.md +173 -0
- package/skills/guide/guide-commit-push.md +156 -0
- package/skills/guide/guide-inject-ui.md +166 -0
- package/skills/guide/guide-slash-completion.md +118 -0
- package/skills/workflow/README.md +21 -0
- package/skills/workflow/git-commit-discipline.md +68 -0
- package/skills/workflow/git-project-startup.md +85 -0
- package/skills/workflow/git-rebuild-process.md +57 -0
- package/skills/workflow/github-operations.md +91 -0
- package/skills/workflow/readme-sync-git-md.md +28 -0
- package/skills/workflow/task-completion-report.md +73 -0
- package/skills/workflow/tool-json-add-ask.md +35 -0
- package/skills/workflow/versioning-rule.md +211 -0
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
// dsh-skip-residue: 豁免注册表元数据含 debugger/console 关键词声明(规则定义,非真实残留)
|
|
2
|
+
import { join, resolve, dirname, sep } from 'node:path';
|
|
3
|
+
import { statSync } from 'node:fs';
|
|
4
|
+
/**
|
|
5
|
+
* dsh-git-push 豁免总入口
|
|
6
|
+
*
|
|
7
|
+
* dsh-skip-* 注册表:每个豁免类型声明「能豁免哪些维度/拦截类型(blocked)」。
|
|
8
|
+
* 位置语义:文件头注释(前 3 行)= 整文件豁免;对应行行内注释 = 单点豁免(仅部分标记支持)。
|
|
9
|
+
* 消费:auditFile 统一调 exemptForFinding(finding, text) 判定是否豁免;扫描问题自带 exemptHint。
|
|
10
|
+
* 场景对照(12 场景,见 docs/WORKBOARD-v2.md §3.6):
|
|
11
|
+
* 整文件豁免:dsh-skip-sensitive/size/func-length/syntax/quality/residue/style 写文件头
|
|
12
|
+
* 单点豁免:dsh-skip-sensitive/residue 行内注释(行尾)→ 本行对应检查关闭
|
|
13
|
+
*/
|
|
14
|
+
export const EXEMPT_MARKERS = {
|
|
15
|
+
'dsh-skip-sensitive': {
|
|
16
|
+
dimensions: ['安全性'],
|
|
17
|
+
blocked: ['[FUNC]', 'credential-file', 'credential-ref', 'path-regex', 'regex'], // path-regex 含私钥路径类;regex 是宽声明(安全类按 rule 名细分)
|
|
18
|
+
// regex 宽声明:security/* 规则带 pattern 字段编译成 regex kind,
|
|
19
|
+
// 需按 rule 名细分(含 security/credential/secret/password/hardcoded 等安全词才算敏感类)
|
|
20
|
+
sensitiveRules: ['security', 'credential', 'credref', 'credfile', 'secret', 'password', 'hardcoded'],
|
|
21
|
+
lineLevel: true, // 支持行内单点豁免
|
|
22
|
+
hint: '文件头注释=整文件;行尾注释=本行免敏感扫描',
|
|
23
|
+
},
|
|
24
|
+
'dsh-skip-size': {
|
|
25
|
+
dimensions: ['可部署性'],
|
|
26
|
+
blocked: ['binary', 'large-file'],
|
|
27
|
+
lineLevel: false,
|
|
28
|
+
hint: '只能写文件头(文件大小是整文件属性)',
|
|
29
|
+
},
|
|
30
|
+
'dsh-skip-func-length': {
|
|
31
|
+
dimensions: ['可读性', '可维护性'],
|
|
32
|
+
blocked: ['func-lines'],
|
|
33
|
+
lineLevel: true, // 函数定义行行尾可豁免单函数
|
|
34
|
+
hint: '文件头=全文件;函数定义行行尾=单函数',
|
|
35
|
+
},
|
|
36
|
+
'dsh-skip-complexity': {
|
|
37
|
+
dimensions: ['可维护性'],
|
|
38
|
+
// 与 dsh-skip-func-length 对称——**单一职责但天然多分支**的函数
|
|
39
|
+
// (词素分派器/正则状态机/路由表/收集器)圈复杂度超过数值阈值 15 属合理
|
|
40
|
+
// 结构,行级豁免单个函数(在函数定义行行尾写标记)。
|
|
41
|
+
// 注意:这是「承认结构必然」而非「掩盖可拆」——凡能按职责拆出的都先拆,
|
|
42
|
+
// 只对拆分后仍天然分支的函数豁免(实测:拆分产物 19~24 大多是这类)。
|
|
43
|
+
blocked: ['max-complexity', 'max-depth'],
|
|
44
|
+
lineLevel: true, // 函数定义行行尾可豁免单函数
|
|
45
|
+
hint: '文件头=全文件;函数定义行行尾=单函数',
|
|
46
|
+
},
|
|
47
|
+
'dsh-skip-syntax': {
|
|
48
|
+
dimensions: ['健壮性'],
|
|
49
|
+
blocked: ['syntax', 'json-parse', 'yaml-parse'],
|
|
50
|
+
lineLevel: false,
|
|
51
|
+
hint: '只能写文件头',
|
|
52
|
+
},
|
|
53
|
+
'dsh-skip-quality': {
|
|
54
|
+
dimensions: ['可读性', '可维护性', '健壮性', '性能'],
|
|
55
|
+
// magic-number-smart:配置数据表(如 lib/score/index.js 的权重表/衰减系数表)
|
|
56
|
+
// 数字是「键名 → 参数」映射值,键名已表意,拆成 WEIGHT_X = 15 反而割裂表格。
|
|
57
|
+
// 该 kind 此前不在任何豁免清单里,导致文件头标记**形同虚设**——
|
|
58
|
+
// lib/score/index.js 从 v1.3.1 起就写着豁免理由却一直被报 7 条魔数;
|
|
59
|
+
// 而规则自身的 exemptHint 又建议用 dsh-skip-quality 豁免,提示与实际行为不符。
|
|
60
|
+
// blacklist:措辞黑名单类 finding(lib/checks/regex.js 的 blocker/分数制两处)——
|
|
61
|
+
// 这两处一直提示 `dsh-skip-quality`,但该 kind 此前不在任何标记的 blocked 里
|
|
62
|
+
// ⇒ 写了标记也不豁免(与上面 magic-number-smart 同一类 bug:提示与实际行为不符)。
|
|
63
|
+
// 注意维度:blacklist 的 finding dimensions 是 ['文档'],与本条 dimensions 不同,
|
|
64
|
+
// 豁免统计按标记维度归类时该 finding 会记在「质量」而非「文档」——如需精确归类,
|
|
65
|
+
// 应另立 dsh-skip-wording(blocked:['blacklist'],dimensions:['文档'])。
|
|
66
|
+
// comment-density / file-health:这两类 finding 一直提示 dsh-skip-quality,
|
|
67
|
+
// 但它们的 kind 也不在任何标记的 blocked 里(同 blacklist/magic-number-smart 一类 bug:
|
|
68
|
+
// 提示写了不生效)⇒ 一并补进本条(注释密度与文件健康度都属「质量评分」语义)。
|
|
69
|
+
blocked: ['func-lines', 'empty-catch', 'sync-fs', 'magic-number-smart', 'blacklist',
|
|
70
|
+
'comment-density', 'file-health'],
|
|
71
|
+
lineLevel: false,
|
|
72
|
+
hint: '文件头=整文件免质量评分(func-lines/empty-catch/sync-fs/magic-number-smart/blacklist 措辞/comment-density/file-health)',
|
|
73
|
+
},
|
|
74
|
+
'dsh-skip-residue': {
|
|
75
|
+
dimensions: ['可读性', '可维护性'],
|
|
76
|
+
blocked: ['regex'], // 需按 rule 前缀细分(debugger/todo/console 残留 + io-risk 单行 I/O)
|
|
77
|
+
// 补 io-risk——io-risk 规则 exemptHint 本就推荐 dsh-skip-residue 行尾,
|
|
78
|
+
// 但 residueRules 只含 debugger/todo/console 导致提示与行为不符(写了标记不豁免)。
|
|
79
|
+
// 补 client-node-builtin-require——该规则只查浏览器 client 半部,
|
|
80
|
+
// 对项目根的 Node CLI 工具(cli.js 等)属误报;行尾 dsh-skip-residue 应能豁免。
|
|
81
|
+
residueRules: ['debugger', 'todo', 'console', 'io-risk', 'client-node-builtin-require'],
|
|
82
|
+
lineLevel: true, // 行尾注释=本行
|
|
83
|
+
hint: '行尾=本行;文件头=整文件免 debugger/todo/console 残留 + io-risk 单行',
|
|
84
|
+
},
|
|
85
|
+
'dsh-skip-style': {
|
|
86
|
+
dimensions: ['可读性'],
|
|
87
|
+
blocked: ['regex', 'min-occurrences'], // 需按 rule 前缀细分(style-* 数值风格规则);min-occurrences 是 lib/audit/orchestrate.js 分体文档提示用的非 regex kind
|
|
88
|
+
styleRules: ['min-length', 'max-lines', 'max-complexity', 'max-depth', 'min-occurrences', 'repeated-string'],
|
|
89
|
+
lineLevel: false,
|
|
90
|
+
hint: '文件头=整文件免全部 styleRules',
|
|
91
|
+
},
|
|
92
|
+
'dsh-skip-i18n': {
|
|
93
|
+
dimensions: ['文档'],
|
|
94
|
+
blocked: ['regex'], // 需按 rule 前缀细分(i18n/* 国际化审计规则)
|
|
95
|
+
i18nRules: ['i18n'],
|
|
96
|
+
lineLevel: true, // 行尾注释=本行免 i18n 硬编码;文件头=整文件
|
|
97
|
+
hint: '文件头=整文件免 i18n 审计(无国际化需求的项目/文件);行尾=本行硬编码文案',
|
|
98
|
+
},
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
/** 文件头豁免检测:读文件前 3 行是否含任一标记。 */
|
|
102
|
+
export function hasHeaderExempt(text, marker) {
|
|
103
|
+
if (!text) return false;
|
|
104
|
+
const head = text.split('\n').slice(0, 3).join('\n');
|
|
105
|
+
return head.includes(marker);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/** 行级豁免检测:某行是否含标记(行内注释)。 */
|
|
109
|
+
export function hasLineExempt(line, marker) {
|
|
110
|
+
return typeof line === 'string' && line.includes(marker);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* 文件类别豁免清单(1.0.0):某些文件类别里「看起来像问题」的写法其实是刻意的。
|
|
115
|
+
* - 测试文件(test/**):同步 fs 便于断点断言、console.log 便于失败定位
|
|
116
|
+
* - 脚本/CLI(scripts/**、cli.mjs):命令行工具本就同步执行 + stdout 输出是产品行为
|
|
117
|
+
* 只豁免这些类别里**确属刻意**的规则;敏感信息/语法/大文件等硬问题不豁免。
|
|
118
|
+
*/
|
|
119
|
+
export const CATEGORY_EXEMPT = {
|
|
120
|
+
test: { pathMatch: /(^|\/)test\//, rules: ['residue', 'console-log', 'sync-fs', 'empty-catch', 'performance'] },
|
|
121
|
+
script: { pathMatch: /(^|\/)(scripts\/|cli\.mjs$)/, rules: ['residue', 'console-log', 'sync-fs'] },
|
|
122
|
+
};
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* 判定 finding 是否属文件类别豁免(路径 + 规则双条件)。
|
|
126
|
+
* @param {object} finding 统一问题对象(需含 file 与 rule/kind)
|
|
127
|
+
* @returns {boolean} true=豁免
|
|
128
|
+
*/
|
|
129
|
+
export function isCategoryExempt(finding = {}) {
|
|
130
|
+
const file = String(finding.file || '');
|
|
131
|
+
const target = `${finding.rule || ''} ${finding.kind || ''}`.toLowerCase();
|
|
132
|
+
for (const meta of Object.values(CATEGORY_EXEMPT)) {
|
|
133
|
+
if (!meta.pathMatch.test(file)) continue;
|
|
134
|
+
if (meta.rules.some((r) => target.includes(r))) return true;
|
|
135
|
+
}
|
|
136
|
+
return false;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* 判定单个 finding 是否被豁免。
|
|
141
|
+
* 整文件豁免(文件头前 3 行含标记)→ 该 finding 的 kind 命中 blocked 即豁免;
|
|
142
|
+
* 行级豁免(finding.line 所在行含标记,且标记支持 lineLevel)→ 豁免。
|
|
143
|
+
* residue/style 走 rule 前缀细分(blocked=['regex'] + 规则名含 debugger/todo/console / style-*)。
|
|
144
|
+
* @param {object} finding 统一问题对象
|
|
145
|
+
* @param {string} text 文件全文(用于取文件头与行)
|
|
146
|
+
* @returns {boolean} true=豁免(应丢弃该 finding)
|
|
147
|
+
*/
|
|
148
|
+
export function exemptForFinding(finding, text = '') { // dsh-skip-complexity: 豁免判定器本体(9 标记 × blocked/细分规则多条件链,职责单一)
|
|
149
|
+
if (!finding) return false;
|
|
150
|
+
if (isCategoryExempt(finding)) return true; // 文件类别豁免(测试/脚本的刻意用法)
|
|
151
|
+
const lines = String(text).split('\n');
|
|
152
|
+
const kind = finding.kind || '';
|
|
153
|
+
const rule = finding.rule || '';
|
|
154
|
+
for (const [marker, meta] of Object.entries(EXEMPT_MARKERS)) {
|
|
155
|
+
const blockedHit = meta.blocked.includes(kind);
|
|
156
|
+
// residue/style:blocked 里的 'regex' 是**宽声明**,需按 rule 前缀细分;
|
|
157
|
+
// 但细分支必须只在 kind === 'regex' 时生效——否则 blocked 里直接列的非 regex kind
|
|
158
|
+
// (如 style 的 'min-occurrences',orchestrate.js 的分体文档提示用它做 kind)
|
|
159
|
+
// 会被 rule 名细分误杀:规则名不含 styleRules 词 ⇒ 写了标记也不豁免(实测复现)。
|
|
160
|
+
// sensitive/i18n 两个分支本就带 kind === 'regex' 前置,这里补齐一致。
|
|
161
|
+
let kindHit = blockedHit;
|
|
162
|
+
if (kind === 'regex' && blockedHit && meta.residueRules && meta.residueRules.length) {
|
|
163
|
+
kindHit = meta.residueRules.some((r) => rule.toLowerCase().includes(r));
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
if (kind === 'regex' && blockedHit && meta.styleRules && meta.styleRules.length) {
|
|
167
|
+
kindHit = meta.styleRules.some((r) => rule.toLowerCase().includes(r));
|
|
168
|
+
}
|
|
169
|
+
if (kind === 'regex' && meta.i18nRules && meta.i18nRules.length) {
|
|
170
|
+
kindHit = meta.i18nRules.some((r) => rule.toLowerCase().includes(r));
|
|
171
|
+
}
|
|
172
|
+
// sensitive 细分只在 regex 宽声明时生效(直接 kind 命中如 [FUNC]/credential-*/path-regex 不受 rule 名约束)
|
|
173
|
+
if (kind === 'regex' && meta.sensitiveRules && meta.sensitiveRules.length) {
|
|
174
|
+
kindHit = meta.sensitiveRules.some((r) => rule.toLowerCase().includes(r));
|
|
175
|
+
}
|
|
176
|
+
if (!kindHit) continue;
|
|
177
|
+
// 整文件豁免(文件头前 3 行)
|
|
178
|
+
if (hasHeaderExempt(lines.slice(0, 3).join('\n'), marker)) return true;
|
|
179
|
+
// 行级豁免(支持 lineLevel 且本行含标记)
|
|
180
|
+
if (meta.lineLevel) {
|
|
181
|
+
const line = lines[finding.line - 1] || '';
|
|
182
|
+
if (hasLineExempt(line, marker)) return true;
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
return false;
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
/** 按问题 rule/kind 反查豁免标记(生成 exemptHint 用)。 */
|
|
189
|
+
export function exemptHintFor(ruleOrKind) {
|
|
190
|
+
for (const [marker, meta] of Object.entries(EXEMPT_MARKERS)) {
|
|
191
|
+
if (meta.blocked.includes(ruleOrKind)) return `${marker} — ${meta.hint}`;
|
|
192
|
+
}
|
|
193
|
+
return 'dsh-skip-sensitive(行尾=本行 / 文件头=整文件)';
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/* ─────────────── 目录标记判定缓存(性能优化,2026-10-09) ───────────────
|
|
197
|
+
* 为什么要有:`.samples` / `.test` 的判定原先**每遇到一个路径就从自身向上逐级 statSync**
|
|
198
|
+
* (找空标记文件)。深度为 d 的文件要付 2d+2 次同步 stat —— 实测全量审计(252 文件)
|
|
199
|
+
* 共 1560 次 statSync,主要来源就是这里;同步 stat 还会阻塞事件循环。
|
|
200
|
+
* 缓存口径:键 = **目录绝对路径**,值 = 该目录**自身**是否含空标记文件;
|
|
201
|
+
* 向上查找时逐级命中缓存即短路,同一目录全仓库只判定一次。
|
|
202
|
+
* 失效:本模块只判定「空标记文件是否存在」这一事实,同一进程内仓库内容被视为稳定
|
|
203
|
+
* (扫描期间大量文件变动不是被支持的场景);测试可用 clearExemptMarkerCache() 重置。
|
|
204
|
+
*/
|
|
205
|
+
const MARKER_CACHE_MAX = 20000; // 目录数上限,防极端仓库把缓存撑爆(可 env 覆盖)
|
|
206
|
+
const SAMPLES_MARKER_CACHE = new Map();
|
|
207
|
+
const TEST_MARKER_CACHE = new Map();
|
|
208
|
+
|
|
209
|
+
/** 读/写缓存时的统一入口:返回 undefined = 未缓存。 */
|
|
210
|
+
function cacheGet(cache, dir) { return cache.has(dir) ? cache.get(dir) : undefined; }
|
|
211
|
+
|
|
212
|
+
/** 目录**自身**是否含 `name` 空标记文件(结果按目录缓存)。 */
|
|
213
|
+
function dirHasEmptyMarker(dir, name, cache) {
|
|
214
|
+
const hit = cacheGet(cache, dir);
|
|
215
|
+
if (hit !== undefined) return hit;
|
|
216
|
+
let has = false;
|
|
217
|
+
try {
|
|
218
|
+
const st = statSync(join(dir, name));
|
|
219
|
+
has = st.isFile() && st.size === 0;
|
|
220
|
+
} catch { has = false; /* 无该级标记 */ }
|
|
221
|
+
const max = Number(process.env.DSH_GIT_PUSH_MARKER_CACHE_MAX || MARKER_CACHE_MAX) || MARKER_CACHE_MAX;
|
|
222
|
+
if (cache.size >= max) cache.clear(); // 简单回收:极端场景退化为不缓存,不影响正确性
|
|
223
|
+
cache.set(dir, has);
|
|
224
|
+
return has;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
/** 供测试使用:清空目录标记缓存。 */
|
|
228
|
+
export function clearExemptMarkerCache() {
|
|
229
|
+
SAMPLES_MARKER_CACHE.clear();
|
|
230
|
+
TEST_MARKER_CACHE.clear();
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* 目录级豁免:判断 relPath(相对 repoPath)是否位于含 `.samples` 空文件的目录内。
|
|
235
|
+
* `.samples` 空文件 = 整目录豁免标记:该目录(含子目录)内容照常出审计/扫描结果,
|
|
236
|
+
* 但不构成提交推送拦截(blocker 不算、敏感文件不写 .gitignore 不解除跟踪)——
|
|
237
|
+
* 专为样本/测试目录设计(故意构造坏样本时不被门禁挡住推送)。
|
|
238
|
+
* @param {string} repoPath 仓库根(绝对路径)
|
|
239
|
+
* @param {string} relPath 相对路径(文件或目录)
|
|
240
|
+
* @returns {boolean} 命中豁免标记返回 true
|
|
241
|
+
*/
|
|
242
|
+
export function isSampleExemptDir(repoPath, relPath = '') {
|
|
243
|
+
if (!repoPath || !relPath) return false;
|
|
244
|
+
const root = resolve(repoPath);
|
|
245
|
+
const abs = resolve(root, String(relPath).replace(/\\/g, '/'));
|
|
246
|
+
// 防逃逸:解析后的路径必须在仓库根内(含根自身)
|
|
247
|
+
if (abs !== root && !abs.startsWith(root + sep)) return false;
|
|
248
|
+
// 从路径所在目录向上逐级找 .samples(文件路径取 dirname;目录路径从自身开始)
|
|
249
|
+
let dir = abs;
|
|
250
|
+
try {
|
|
251
|
+
const st = statSync(abs);
|
|
252
|
+
if (!st.isDirectory()) dir = dirname(abs);
|
|
253
|
+
} catch { dir = dirname(abs); }
|
|
254
|
+
for (;;) {
|
|
255
|
+
// 目录标记判定走缓存:同一目录全仓库只 statSync 一次(原来每文件每级都 stat)
|
|
256
|
+
if (dirHasEmptyMarker(dir, '.samples', SAMPLES_MARKER_CACHE)) return true;
|
|
257
|
+
if (dir === root) return false;
|
|
258
|
+
const parent = dirname(dir);
|
|
259
|
+
if (parent === dir) return false;
|
|
260
|
+
dir = parent;
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* 测试目录豁免:判断 relPath(相对 repoPath)是否位于含 `.test` 空文件的目录内。
|
|
265
|
+
* `.test` 空文件 = 整目录扫描跳过标记:该目录(含子目录)在审计/敏感扫描时**直接跳过**,
|
|
266
|
+
* 不出任何结果(比 .samples 更强——.samples 照常出结果但不拦截,.test 完全跳过)。
|
|
267
|
+
* 专为测试 fixture 目录设计:故意构造的坏样本/含危险模式的样本目录,彻底不参与扫描。
|
|
268
|
+
* @param {string} repoPath 仓库根(绝对路径)
|
|
269
|
+
* @param {string} relPath 相对路径(文件或目录)
|
|
270
|
+
* @returns {boolean} 命中跳过标记返回 true
|
|
271
|
+
*/
|
|
272
|
+
export function isTestExemptDir(repoPath, relPath = '') {
|
|
273
|
+
if (!repoPath || !relPath) return false;
|
|
274
|
+
const root = resolve(repoPath);
|
|
275
|
+
const abs = resolve(root, String(relPath).replace(/\\/g, '/'));
|
|
276
|
+
// 防逃逸:解析后的路径必须在仓库根内(含根自身)
|
|
277
|
+
if (abs !== root && !abs.startsWith(root + sep)) return false;
|
|
278
|
+
// 从路径所在目录向上逐级找 .test(文件路径取 dirname;目录路径从自身开始)
|
|
279
|
+
let dir = abs;
|
|
280
|
+
try {
|
|
281
|
+
const st = statSync(abs);
|
|
282
|
+
if (!st.isDirectory()) dir = dirname(abs);
|
|
283
|
+
} catch { dir = dirname(abs); }
|
|
284
|
+
for (;;) {
|
|
285
|
+
// 同上:目录标记判定走缓存
|
|
286
|
+
if (dirHasEmptyMarker(dir, '.test', TEST_MARKER_CACHE)) return true;
|
|
287
|
+
if (dir === root) return false;
|
|
288
|
+
const parent = dirname(dir);
|
|
289
|
+
if (parent === dir) return false;
|
|
290
|
+
dir = parent;
|
|
291
|
+
}
|
|
292
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 「读改合一」编辑核心(工具 edit_after_read 的实现层;纯逻辑、可单测、无副作用注入面)。
|
|
3
|
+
*
|
|
4
|
+
* 【为什么需要】宿主的编辑守卫只认「用 read 工具读过」,而**真实读过内容**的手段很多
|
|
5
|
+
* (sed -n / cat / node -e / grep 上下文等)——守卫是工具偏见,不是安全边界。
|
|
6
|
+
* 本核心把「读」与「改」合成一步:**自己读当前文件** → 校验 → 字面替换 → 写回。
|
|
7
|
+
* 于是「确实读过」由构造保证,且比宿主守卫更严:
|
|
8
|
+
* ① **版本比对**:读后到写前若文件被改动(mtime/size 变化)→ 拒绝,提示重读;
|
|
9
|
+
* ② **唯一性校验**:默认要求 old 在文件里**恰好出现一次**(防误替换),需要多处替换显式传 all:true;
|
|
10
|
+
* ③ **字面匹配**:old 按字面(含空白)精确匹配,不做正则解释,避免「以为在改 A 实际改了 B」。
|
|
11
|
+
*
|
|
12
|
+
* 【不做的事】不解析语法、不做结构化匹配 —— 那是 ast-grep 的活;本核心只管「安全的字面替换」。
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { readFileSync, statSync, writeFileSync } from 'node:fs';
|
|
16
|
+
|
|
17
|
+
/** 统计不重叠出现次数。 */
|
|
18
|
+
export function countOccurrences(text, needle) {
|
|
19
|
+
if (!needle) return 0;
|
|
20
|
+
let n = 0;
|
|
21
|
+
let idx = text.indexOf(needle);
|
|
22
|
+
while (idx !== -1) {
|
|
23
|
+
n += 1;
|
|
24
|
+
idx = text.indexOf(needle, idx + needle.length);
|
|
25
|
+
}
|
|
26
|
+
return n;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/** 文件版本指纹(mtime 毫秒 + 字节数)——用于「读后是否被改动」的比对。 */
|
|
30
|
+
function fingerprint(statFile, path) {
|
|
31
|
+
try {
|
|
32
|
+
const st = statFile(path);
|
|
33
|
+
return `${st.mtimeMs}:${st.size}`;
|
|
34
|
+
} catch {
|
|
35
|
+
return '';
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* 读当前文件 → 校验 → 字面替换 → 写回。
|
|
41
|
+
* @param {object} args
|
|
42
|
+
* @param {string} args.path 目标文件绝对路径(亦接受宿主的 file_path)
|
|
43
|
+
* @param {string} args.old 要被替换的字面文本(含空白,必须精确匹配;亦接受 old_string)
|
|
44
|
+
* @param {string} args.new 替换后的文本(**必传**;要删除请显式传空串 '';亦接受 new_string)
|
|
45
|
+
* @param {boolean} [args.all] 是否替换全部匹配(默认 false:要求唯一匹配;亦接受 replace_all)
|
|
46
|
+
* @param {Function} [args.readFile] 读函数(测试注入)
|
|
47
|
+
* @param {Function} [args.writeFile] 写函数(测试注入)
|
|
48
|
+
* @param {Function} [args.statFile] 状态函数(测试注入)
|
|
49
|
+
* @returns {{ok:boolean, path:string, replaced:number, bytesBefore:number, bytesAfter:number, reason?:string}}
|
|
50
|
+
*/
|
|
51
|
+
export function editAfterRead({
|
|
52
|
+
path: pathArg,
|
|
53
|
+
old: oldArg,
|
|
54
|
+
new: newArg,
|
|
55
|
+
all: allArg,
|
|
56
|
+
file_path: filePathAlias,
|
|
57
|
+
old_string: oldStringAlias,
|
|
58
|
+
new_string: newStringAlias,
|
|
59
|
+
replace_all: replaceAllAlias,
|
|
60
|
+
readFile = readFileSync,
|
|
61
|
+
writeFile = writeFileSync,
|
|
62
|
+
statFile = statSync,
|
|
63
|
+
}) {
|
|
64
|
+
// 参数名与宿主编辑工具对齐(file_path/old_string/new_string/replace_all),同时保留本插件原名,
|
|
65
|
+
// 两套名字都认 —— 避免「记混了参数名」把内容改坏(真实事故:宿主名 + 本工具默认空串 ⇒ 内容被删)。
|
|
66
|
+
const path = pathArg ?? filePathAlias;
|
|
67
|
+
const old = oldArg ?? oldStringAlias;
|
|
68
|
+
const next = newArg ?? newStringAlias;
|
|
69
|
+
const all = (allArg ?? replaceAllAlias) === true;
|
|
70
|
+
const fail = (reason) => ({ ok: false, path, replaced: 0, bytesBefore: 0, bytesAfter: 0, reason });
|
|
71
|
+
if (!path) return fail('缺少 path(或 file_path)');
|
|
72
|
+
if (!old) return fail('缺少 old(要被替换的字面文本;或 old_string)');
|
|
73
|
+
// ⚠️ 安全闸:new 缺失**不再**当删除 —— 缺参数时报错,删除必须显式传空串。
|
|
74
|
+
if (next === undefined || next === null) {
|
|
75
|
+
return fail("缺少 new(替换文本;或 new_string)。要删除该内容请显式传 new: ''");
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
const before = fingerprint(statFile, path);
|
|
79
|
+
let text;
|
|
80
|
+
try {
|
|
81
|
+
text = String(readFile(path, 'utf8'));
|
|
82
|
+
} catch (e) {
|
|
83
|
+
return fail(`读取失败:${(e && e.message) || e}`);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
const hits = countOccurrences(text, old);
|
|
87
|
+
if (hits === 0) return fail('未找到 old(字面精确匹配失败:注意空白/换行必须完全一致)');
|
|
88
|
+
if (hits > 1 && !all) return fail(`old 出现 ${hits} 次,默认要求唯一匹配(确认要全改请传 all:true)`);
|
|
89
|
+
|
|
90
|
+
// 读后到写前若被改动 → 拒绝,避免覆盖别人的修改
|
|
91
|
+
const after = fingerprint(statFile, path);
|
|
92
|
+
if (before && after && before !== after) {
|
|
93
|
+
return fail('读后文件已被改动(版本变化),已拒绝写入;请重新读取后再改');
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
const out = all ? text.split(old).join(next) : text.replace(old, next);
|
|
97
|
+
try {
|
|
98
|
+
writeFile(path, out, 'utf8');
|
|
99
|
+
} catch (e) {
|
|
100
|
+
return fail(`写入失败:${(e && e.message) || e}`);
|
|
101
|
+
}
|
|
102
|
+
return { ok: true, path, replaced: all ? hits : 1, bytesBefore: text.length, bytesAfter: out.length };
|
|
103
|
+
}
|
package/lib/fsx.js
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 文件系统适配层 —— 兼容不支持元数据操作的挂载(CIFS/SMB 网络共享)。
|
|
3
|
+
*
|
|
4
|
+
* 背景(实测于 Synology NAS 挂载 Windows 共享的工作区):
|
|
5
|
+
* 挂载参数含 `nounix,forceuid,forcegid,file_mode=0777,dir_mode=0777`,
|
|
6
|
+
* SMB3 服务端(Windows 类实现)不声明 POSIX Extensions,故:
|
|
7
|
+
* ✓ 纯数据操作:writeFile / readFile / mkdir / readdir / rename / unlink
|
|
8
|
+
* ✗ 元数据操作:chmod / chown / utimes → EPERM(errno=-1,内核本地拒绝)
|
|
9
|
+
* ✗ 服务端复制:copyFile(目标在 CIFS 内)→ EPERM
|
|
10
|
+
* `nounix` 不是可关闭的开关:SMB1 的 UNIX Extensions 已被 SMB2/3 的
|
|
11
|
+
* POSIX Extensions 取代,而服务端不支持协商,去掉该参数仍会回落同样行为。
|
|
12
|
+
*
|
|
13
|
+
* 本模块的作用:把「在 CIFS 上会失败、但失败不影响正确性」的操作统一收口,
|
|
14
|
+
* 让调用方无需每处手写 try/catch,也避免漏写导致整个同步流程抛错中断。
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import { chmodSync, copyFileSync, readFileSync, statSync, unlinkSync, writeFileSync } from 'node:fs';
|
|
18
|
+
import { join } from 'node:path';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* 复制文件:优先 copyFileSync,遇 EPERM/ENOTSUP 回退到读写复制。
|
|
22
|
+
*
|
|
23
|
+
* copyFileSync 在 CIFS 上尝试服务端复制(SMB copychunk)会 EPERM;
|
|
24
|
+
* 回退的 readFile+writeFile 是纯数据通道,实测可用。
|
|
25
|
+
* @param {string} from 源路径
|
|
26
|
+
* @param {string} to 目标路径
|
|
27
|
+
* @param {object} [opts] { encoding } 缺省 utf8;传 'buffer' 走二进制
|
|
28
|
+
* @returns {{ok: boolean, via: string, error?: string}}
|
|
29
|
+
*/
|
|
30
|
+
export function copyFileCompat(from, to, opts = {}) {
|
|
31
|
+
try {
|
|
32
|
+
copyFileSync(from, to);
|
|
33
|
+
return { ok: true, via: 'copyFileSync' };
|
|
34
|
+
} catch (e) {
|
|
35
|
+
if (e?.code !== 'EPERM' && e?.code !== 'ENOTSUP' && e?.code !== 'EOPNOTSUPP') {
|
|
36
|
+
return { ok: false, via: 'copyFileSync', error: `${e?.code || 'ERR'}: ${e?.message || e}` };
|
|
37
|
+
}
|
|
38
|
+
// 回退:纯数据读写(CIFS 上可用)
|
|
39
|
+
try {
|
|
40
|
+
const content = opts.encoding === 'buffer' ? readFileSync(from) : readFileSync(from, 'utf8');
|
|
41
|
+
if (opts.encoding === 'buffer') writeFileSync(to, content);
|
|
42
|
+
else writeFileSync(to, content, 'utf8');
|
|
43
|
+
return { ok: true, via: 'readFile+writeFile' };
|
|
44
|
+
} catch (e2) {
|
|
45
|
+
return { ok: false, via: 'readFile+writeFile', error: `${e2?.code || 'ERR'}: ${e2?.message || e2}` };
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* 尽力设置文件权限;失败静默返回 false。
|
|
52
|
+
* CIFS(nounix)上 chmod 必然 EPERM —— 权限由挂载参数统一决定
|
|
53
|
+
* (forceuid/forcegid/file_mode),调用方不应把失败当错误。
|
|
54
|
+
* @returns {boolean} 是否真的设置成功
|
|
55
|
+
*/
|
|
56
|
+
export function chmodBestEffort(fn, mode) {
|
|
57
|
+
try {
|
|
58
|
+
fn(mode);
|
|
59
|
+
return true;
|
|
60
|
+
} catch {
|
|
61
|
+
return false;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* 目标目录所在的文件系统是否支持元数据操作(chmod/utimes)。
|
|
67
|
+
* 用于把「可执行位保真」这类能力降级写进结果,而不是静默失效。
|
|
68
|
+
*
|
|
69
|
+
* 判定方式:在目标目录内**建临时文件**再 chmod —— 不能直接探测目录本身:
|
|
70
|
+
* /tmp 这类带 sticky bit 的目录 chmod 会 EPERM,但其内文件完全正常,
|
|
71
|
+
* 直接探测目录会把「支持元数据」误判为 false。
|
|
72
|
+
* @param {string} dirPath 一个已存在的目录(通常是被写入的目标目录)
|
|
73
|
+
* @returns {boolean}
|
|
74
|
+
*/
|
|
75
|
+
export function supportsMetadata(dirPath) {
|
|
76
|
+
const probe = join(dirPath, `.fsx-probe-${process.pid}-${Date.now()}`);
|
|
77
|
+
try {
|
|
78
|
+
writeFileSync(probe, '');
|
|
79
|
+
const st = statSync(probe);
|
|
80
|
+
chmodSync(probe, st.mode & 0o777);
|
|
81
|
+
return true;
|
|
82
|
+
} catch {
|
|
83
|
+
return false;
|
|
84
|
+
} finally {
|
|
85
|
+
try { unlinkSync(probe); } catch { /* 清理失败不影响判定 */ }
|
|
86
|
+
}
|
|
87
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Git 执行层 · 账号状态文件
|
|
3
|
+
*
|
|
4
|
+
* 职责:将账号登录信息 / 凭据有效性(token、SSH 各自 ✅❌)持久化到插件配置目录
|
|
5
|
+
* account-status.json。写入时机:每次推送/提交验证账号时刷新;设置侧边栏打开时读取。
|
|
6
|
+
*
|
|
7
|
+
* 文件内容:
|
|
8
|
+
* {
|
|
9
|
+
* username, // 综合有效登录名
|
|
10
|
+
* loggedIn, // token 或 ssh 任一有效
|
|
11
|
+
* token: { valid, login, checkedAt, detail? },
|
|
12
|
+
* ssh: { valid, login, checkedAt, detail? },
|
|
13
|
+
* checkedAt, // 本次探测时间 ISO
|
|
14
|
+
* }
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import { join } from 'node:path';
|
|
18
|
+
import { existsSync, readFileSync, writeFileSync, chmodSync, renameSync, mkdirSync } from 'node:fs';
|
|
19
|
+
import { checkGithubAccount } from './account.js';
|
|
20
|
+
import { credentialsDir } from './credentials.js';
|
|
21
|
+
|
|
22
|
+
const STATUS_FILE = 'account-status.json';
|
|
23
|
+
|
|
24
|
+
/** 账号状态文件路径(配置目录 credentialsDir()/account-status.json)。 */
|
|
25
|
+
export function accountStatusFile({ workspaceRoot = '' } = {}) {
|
|
26
|
+
return join(credentialsDir({ workspaceRoot }), STATUS_FILE);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* 读账号状态文件。无文件/损坏 → null。
|
|
31
|
+
* @returns {object|null} { username, loggedIn, token, ssh, checkedAt }
|
|
32
|
+
*/
|
|
33
|
+
export function readAccountStatus({ workspaceRoot = '' } = {}) {
|
|
34
|
+
const p = accountStatusFile({ workspaceRoot });
|
|
35
|
+
try {
|
|
36
|
+
if (!existsSync(p)) return null;
|
|
37
|
+
return JSON.parse(readFileSync(p, 'utf8'));
|
|
38
|
+
} catch { return null; }
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* 写入账号状态文件(0600,原子写)。失败返回 { ok:false, error },不抛。
|
|
43
|
+
*/
|
|
44
|
+
export function writeAccountStatus(status, { workspaceRoot = '' } = {}) {
|
|
45
|
+
try {
|
|
46
|
+
const dir = credentialsDir({ workspaceRoot });
|
|
47
|
+
mkdirSync(dir, { recursive: true, mode: 0o700 });
|
|
48
|
+
const p = join(dir, STATUS_FILE);
|
|
49
|
+
const tmpPath = `${p}.${process.pid}.tmp`;
|
|
50
|
+
writeFileSync(tmpPath, JSON.stringify(status, null, 2) + '\n', { encoding: 'utf8', mode: 0o600 });
|
|
51
|
+
try { chmodSync(tmpPath, 0o600); } catch { /* CIFS 可能改不了 mode */ }
|
|
52
|
+
renameSync(tmpPath, p);
|
|
53
|
+
return { ok: true, file: p };
|
|
54
|
+
} catch (e) {
|
|
55
|
+
return { ok: false, error: String(e?.message || e) };
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* 由 checkGithubAccount 的结果聚合账号状态对象(token/ssh 有效性快照)。
|
|
61
|
+
* @param {object} result checkGithubAccount 的返回值
|
|
62
|
+
*/
|
|
63
|
+
export function buildAccountStatus(result = {}) {
|
|
64
|
+
const now = new Date().toISOString();
|
|
65
|
+
const ts = result.tokenStatus || {};
|
|
66
|
+
const ss = result.sshStatus || {};
|
|
67
|
+
return {
|
|
68
|
+
username: result.username || '',
|
|
69
|
+
loggedIn: !!result.loggedIn,
|
|
70
|
+
// timeout 标志:本次校验因网络超时未测成(凭据未必无效),供 UI 文案区分,不误导为「已失效」
|
|
71
|
+
// id:账号数字 id(拼 GitHub noreply 提交邮箱用,见 lib/git/identity.js)
|
|
72
|
+
token: { valid: !!ts.valid, login: ts.login || '', id: String(ts.id || ''), checkedAt: ts.checked ? now : '', detail: ts.detail || '', timeout: ts.timeout === true },
|
|
73
|
+
ssh: { valid: !!ss.valid, login: ss.login || '', checkedAt: ss.checked ? now : '', detail: ss.detail || '', timeout: ss.timeout === true },
|
|
74
|
+
// API 通道配额(2026-10-02 功能:UI 显示)——checkGithubAccount 从 /user 响应头提取;
|
|
75
|
+
// 无响应头(代理剥离)时留空,UI 显示「—」。
|
|
76
|
+
apiQuota: result.apiQuota || null,
|
|
77
|
+
checkedAt: now,
|
|
78
|
+
};
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* 用已有的 checkGithubAccount 结果直接写 account-status.json(不重复网络探测)。
|
|
83
|
+
* @param {object} result checkGithubAccount 的返回值
|
|
84
|
+
*/
|
|
85
|
+
/**
|
|
86
|
+
* 统一写入口:由 checkGithubAccount 结果聚合账号状态并写 account-status.json。
|
|
87
|
+
* 收口:返回 `statusUpdated` 标志——调用方(HTTP/tool)透传给 UI,
|
|
88
|
+
* UI 账号信息据此重新读取 account-status(refreshAccount 离线读回)。
|
|
89
|
+
* @param {object} result checkGithubAccount 的返回值
|
|
90
|
+
* @param {{workspaceRoot?: string}} [opts]
|
|
91
|
+
* @returns {{ok:boolean, statusUpdated:boolean, file?:string, error?:string}}
|
|
92
|
+
*/
|
|
93
|
+
export function writeAccountStatusFromResult(result, { workspaceRoot = '' } = {}) {
|
|
94
|
+
const res = writeAccountStatus(buildAccountStatus(result), { workspaceRoot });
|
|
95
|
+
return { ...res, statusUpdated: res.ok === true };
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
/**
|
|
99
|
+
* 探测并刷新账号状态:跑 checkGithubAccount(token 在线 /user + SSH 在线 ssh -T),
|
|
100
|
+
* 聚合为状态对象并写 account-status.json。网络耗时约 1~4s。
|
|
101
|
+
* @param {object} [opts] { workspaceRoot, token }
|
|
102
|
+
* @returns {Promise<{ok:boolean, status?:object, result?:object}>}
|
|
103
|
+
*/
|
|
104
|
+
export async function refreshAccountStatus({ workspaceRoot = '', token = '' } = {}) {
|
|
105
|
+
try {
|
|
106
|
+
const accountInfo = await checkGithubAccount({ workspaceRoot, token });
|
|
107
|
+
const status = buildAccountStatus(accountInfo);
|
|
108
|
+
writeAccountStatus(status, { workspaceRoot });
|
|
109
|
+
return { ok: true, status, result: accountInfo };
|
|
110
|
+
} catch { /* 探测失败则只返回本轮半成品,不落盘 */ }
|
|
111
|
+
}
|
|
112
|
+
// 局部更新 account-status.json 的 apiQuota 字段(保留 token/ssh 等其它字段不动)。
|
|
113
|
+
//
|
|
114
|
+
// 为什么单独一个函数:配额刷新(GET /rate_limit)与账号校验(account-check)是**两个独立时机**——
|
|
115
|
+
// 查看配额时不该重建整份状态(会覆盖掉上次的 token/ssh 校验结果),只覆盖 apiQuota 一项即可。
|
|
116
|
+
//
|
|
117
|
+
// 收口要求(与 writeAccountStatusFromResult 同一约定):
|
|
118
|
+
// ① 返回 `statusUpdated` 标志 —— HTTP 层透传给 UI,UI 据此重读快照(不是无条件拉);
|
|
119
|
+
// ② **状态文件不存在时按空底稿创建** —— 此前直接返回 {ok:false},调用方又忽略返回值,
|
|
120
|
+
// 于是新装环境「查了配额但配置里没有」(配额永远不落盘);创建后 Token 行的配额后缀
|
|
121
|
+
// 在离线读时也能显示。
|
|
122
|
+
//
|
|
123
|
+
// @param {object|null} apiQuota 配额对象({ core:{limit,remaining,resetAt}, search, graphql, codeSearch, checkedAt })
|
|
124
|
+
// @param {{workspaceRoot?: string}} [opts]
|
|
125
|
+
// @returns {{ok:boolean, statusUpdated:boolean, created:boolean, file?:string, error?:string}}
|
|
126
|
+
// created=true 表示本次是新建状态文件(此前不存在)
|
|
127
|
+
export function updateAccountStatusQuota(apiQuota, { workspaceRoot = '' } = {}) {
|
|
128
|
+
const cur = readAccountStatus({ workspaceRoot });
|
|
129
|
+
const created = cur === null;
|
|
130
|
+
// 空底稿:字段与 buildAccountStatus 对齐(token/ssh 标未校验,不伪造「已失效」)
|
|
131
|
+
const next = cur || {
|
|
132
|
+
username: '', loggedIn: false,
|
|
133
|
+
token: { valid: false, login: '', checkedAt: '', detail: '', timeout: false },
|
|
134
|
+
ssh: { valid: false, login: '', checkedAt: '', detail: '', timeout: false },
|
|
135
|
+
checkedAt: '',
|
|
136
|
+
};
|
|
137
|
+
next.apiQuota = apiQuota || null;
|
|
138
|
+
const res = writeAccountStatus(next, { workspaceRoot });
|
|
139
|
+
return { ...res, statusUpdated: res.ok === true, created };
|
|
140
|
+
}
|