dsh-git-push 2.20.18 → 2.20.19
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/cli.mjs +29 -1
- package/lib/app/apply.js +8 -8
- package/lib/app/command-registry.js +25 -6
- package/lib/app/handlers/audit.js +150 -0
- package/lib/app/handlers/meta.js +7 -142
- package/lib/app/handlers/npm.js +18 -1
- package/lib/app/http-handlers.js +54 -12
- package/lib/app/inject-text.js +3 -2
- package/lib/app/tool-call.js +9 -3
- package/lib/app/tools.js +13 -6
- package/lib/cli/shared.mjs +7 -4
- package/lib/client-parts/git/controller.js +2 -2
- package/lib/client.js +2 -2
- package/lib/commit-push.js +57 -12
- package/lib/preprocess/audit.js +98 -0
- package/lib/preprocess/index.js +78 -0
- package/lib/self/index.js +1 -1
- package/package.json +1 -1
- package/skills/dev/dsh-git-push.md +5 -0
package/cli.mjs
CHANGED
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
*/
|
|
15
15
|
import { VERSION } from './lib/self/index.js';
|
|
16
16
|
import { runWrappedGit } from './lib/git/wrapped-git.js';
|
|
17
|
+
import { auditPreprocessAvailable } from './lib/app/command-registry.js';
|
|
17
18
|
|
|
18
19
|
// 具名 import 而非 `export ... from`:COMMANDS 表直接引用 cmdXxx 变量名,
|
|
19
20
|
// re-export 不建立本模块作用域绑定,会 ReferenceError。
|
|
@@ -99,6 +100,33 @@ const HELP = `git-sluice v${VERSION} — ${CLI_ENTRIES[CLI_GIT].intro}
|
|
|
99
100
|
|
|
100
101
|
/** 命令表(本侧独有的 COMMANDS;注册表驱动的命令由 shared 的 resolveDispatch 处理)。
|
|
101
102
|
* 注:`git` 不用登记——注册表(git_sluice)已覆盖它,旧 cli.mjs 里那条 COMMANDS['git'] 是死代码。 */
|
|
103
|
+
/**
|
|
104
|
+
* HELP 文本里与「提交前审计预处理」绑定的片段。
|
|
105
|
+
* 为什么要有这张表:参数表(command-registry 的 params)已经是**动态**的——
|
|
106
|
+
* 审计引擎不可用时 `--audit*` 不入签名(传了报「未知参数」);但 HELP 是**手写快照**,
|
|
107
|
+
* 不跟着动态就会在审计剥离后仍宣传一个不存在的参数。审计不可用时按这张表把片段从渲染结果里剔掉。
|
|
108
|
+
* 漂移防护:test/tool/test-cli.mjs 断言「每个片段都真的出现在 HELP 里」——改了 HELP 忘改表会变红。
|
|
109
|
+
*/
|
|
110
|
+
export const AUDIT_HELP_SNIPPETS = Object.freeze([
|
|
111
|
+
' [--audit]',
|
|
112
|
+
' [--audit-exempt-paths <文件,...>]',
|
|
113
|
+
' [--audit-exempt-reason <理由>]',
|
|
114
|
+
';--audit-exempt-paths 本次提交按文件临时豁免审计',
|
|
115
|
+
]);
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* 渲染本侧 HELP(按当前配置决定审计参数出不出现)。
|
|
119
|
+
* @param {object} [cfg] 插件配置
|
|
120
|
+
* @param {boolean} [hasBuiltinEngine] 仅供测试注入「内置引擎是否存在」
|
|
121
|
+
* @returns {string}
|
|
122
|
+
*/
|
|
123
|
+
export function renderHelp(cfg = {}, hasBuiltinEngine) {
|
|
124
|
+
if (auditPreprocessAvailable(cfg, hasBuiltinEngine)) return HELP;
|
|
125
|
+
let text = HELP;
|
|
126
|
+
for (const snippet of AUDIT_HELP_SNIPPETS) text = text.split(snippet).join('');
|
|
127
|
+
return text;
|
|
128
|
+
}
|
|
129
|
+
|
|
102
130
|
export const COMMANDS = new Map([
|
|
103
131
|
['repos', parseVia((flags, positional) => cmdRepos(positional[0] || '.', flags))],
|
|
104
132
|
['index', parseVia((flags, positional) => cmdIndex(positional[0] || '.', flags))],
|
|
@@ -132,7 +160,7 @@ export async function main(argv = process.argv.slice(2)) {
|
|
|
132
160
|
cliName: CLI_GIT,
|
|
133
161
|
argv,
|
|
134
162
|
commands: COMMANDS,
|
|
135
|
-
helpText:
|
|
163
|
+
helpText: () => renderHelp(cliPluginConfig()),
|
|
136
164
|
passthroughGit,
|
|
137
165
|
getConfig: cliPluginConfig,
|
|
138
166
|
});
|
package/lib/app/apply.js
CHANGED
|
@@ -18,7 +18,7 @@ import { loadDefineTool, registerTools, registerContext, registerHttp, registerP
|
|
|
18
18
|
// 两个 import 仍需保留。按 comment-not-delete 保留原行注释,便于回退与对照。
|
|
19
19
|
// 【原代码】import { GIT_PUSH_SETTINGS_NS, name } from './constants.js';
|
|
20
20
|
import { GIT_PUSH_SETTINGS_NS } from './constants.js';
|
|
21
|
-
import { adaptHttpHandler } from './http-handlers.js';
|
|
21
|
+
import { AUDIT_API_PREFIX, adaptHttpHandler } from './http-handlers.js';
|
|
22
22
|
import { readSettings, applySettingsToCfg, writeSettingsKey } from './settings-bridge.js';
|
|
23
23
|
import { FUNCTION_USAGE_HINT, README_CHECK_HINT, buildRequirementsInjectionText } from './inject-text.js';
|
|
24
24
|
// 【原代码】import { Config } from './schema.js';
|
|
@@ -79,7 +79,7 @@ export async function apply(ctx, config = {}) {
|
|
|
79
79
|
} catch { fsCtx = null; }
|
|
80
80
|
const toolCount = registerTools(ctx, {
|
|
81
81
|
defineTool,
|
|
82
|
-
tools: listTools(),
|
|
82
|
+
tools: listTools(cfg), // 传 cfg:函数形态的 params 按当前配置求值
|
|
83
83
|
// 透传 exec(宿主执行工具时注入 exec.agent)——callTool 用它作 jobs.start 的
|
|
84
84
|
// owner(owner 对上了 scoped job 控制器才会放行,否则 start 抛 no controller serves)。
|
|
85
85
|
// 末位透传 fsCtx:工具成功后据此补发 fs/observed(actor=本次 exec ✓)
|
|
@@ -162,12 +162,12 @@ export async function apply(ctx, config = {}) {
|
|
|
162
162
|
const preStepWired = registerPreStepInjection(ctx, { envInjectText, log });
|
|
163
163
|
|
|
164
164
|
// 3) HTTP API:ctx.inject(['webServer']) → register({kind:'prefix', path, handler})
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
});
|
|
165
|
+
// **同一个 handler 注册两个前缀**:/api/git-push(git+共享)与 /api/git-audit(审计)。
|
|
166
|
+
// 为什么不另写一个 handler:鉴权(checkOrigin/checkBodySize/写确认)在 handleHttp 的
|
|
167
|
+
// switch 之前统一执行,复用同一入口才自动继承门禁;另起入口就是一个无门禁的裸端点。
|
|
168
|
+
const httpHandler = (req, res) => adaptHttpHandler(req, res, { ...env, jobs }, cfg);
|
|
169
|
+
const httpWired = registerHttp(ctx, { path: '/api/git-push', handler: httpHandler, log });
|
|
170
|
+
const auditHttpWired = registerHttp(ctx, { path: AUDIT_API_PREFIX, handler: httpHandler, log });
|
|
171
171
|
|
|
172
172
|
// 4) 设置命名空间:settings.register('git-push') —— Host 必须注册命名空间,
|
|
173
173
|
// 配置卡(settings.plugin.item key=git-push)才会与 Host 命名空间相交显示
|
|
@@ -1,3 +1,22 @@
|
|
|
1
|
+
// 审计预处理的「参数 / 可用性判据」真源在 lib/preprocess/audit.js(与 renderResult 同处一处);
|
|
2
|
+
// 本文件只消费它们,并按历史路径 re-export(外部 import { auditPreprocessAvailable } 不受影响)。
|
|
3
|
+
import { AUDIT_COMMIT_PARAMS, auditPreprocess, auditPreprocessAvailable } from '../preprocess/index.js';
|
|
4
|
+
|
|
5
|
+
export { AUDIT_COMMIT_PARAMS, auditPreprocessAvailable };
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* 解析注册表条目的 params(支持数组与函数两种形态)。
|
|
9
|
+
* 函数形态用于「参数按当前配置动态组装」——本意是 git 侧不写死审计层参数。
|
|
10
|
+
* @param {{params: Array|Function}} entry
|
|
11
|
+
* @param {object} [cfg] 当前插件配置(函数形态时传入)
|
|
12
|
+
* @returns {Array} 参数 schema 数组
|
|
13
|
+
*/
|
|
14
|
+
export function resolveEntryParams(entry, cfg, hasBuiltinEngine) {
|
|
15
|
+
const raw = entry && entry.params;
|
|
16
|
+
// 第三个参数只为「测试可注入内置引擎可用性」而存在:生产调用不传 ⇒ 走真实文件存在性判断
|
|
17
|
+
return typeof raw === 'function' ? (raw(cfg || {}, hasBuiltinEngine) || []) : (raw || []);
|
|
18
|
+
}
|
|
19
|
+
|
|
1
20
|
/**
|
|
2
21
|
* 工具命令注册表(方案 B——命令注册表元数据驱动,免维护 CLI)
|
|
3
22
|
*
|
|
@@ -24,7 +43,8 @@ export const TOOL_REGISTRY = [
|
|
|
24
43
|
},
|
|
25
44
|
{
|
|
26
45
|
name: 'git_commit_push', cli: 'commit', description: '一键提交并推送:一次调用 = 审计(blocker 拦截,可关)→ 有改动才 commit → 有可推内容才 push。零改动是**正常成功路径**:返回 ok:true + committed:false(job 状态 completed,不是失败);远端已最新则 ok:true + pushed:false;本地领先远端的已提交内容照样会推。message 必填(零改动时用不到);requirementsConfirmed=true(开发者要求全部核对达标)——**存在要求清单时任何调用都要带**(与有无改动、是否推送无关);push=false 只提交;dryRun 只模拟',
|
|
27
|
-
params
|
|
46
|
+
// params 用函数形态:git 侧不写死审计层参数,审计可用时由预处理贡献(见文件头 AUDIT_COMMIT_PARAMS)
|
|
47
|
+
params: (cfg, hasBuiltinEngine) => [
|
|
28
48
|
{ flag: 'repo', type: 'string', positional: 0, required: true, desc: '仓库绝对路径' },
|
|
29
49
|
{ flag: 'message', type: 'string', required: true, desc: 'commit message(字符串,必填):可写整条提交信息;要传结构化多条目请用 messageItems(它会作为要点与正文)' },
|
|
30
50
|
// ⚠️ 数组/对象形态**必须走独立参数**:宿主在进插件之前先按工具 JSON schema 校验参数,
|
|
@@ -32,18 +52,17 @@ export const TOOL_REGISTRY = [
|
|
|
32
52
|
// 都被读成 string ✗,报 invalid arguments: "message" must be a string ⇒ 非字符串根本到不了插件 ✓)
|
|
33
53
|
{ flag: 'messageItems', type: 'array', desc: '结构化条目数组:元素为字符串,或 {what,type?,scope?,why?,verify?,refs?};仅 what 必填,type/scope/why/verify/refs 可空' },
|
|
34
54
|
{ flag: 'push', type: 'boolean', default: true, desc: '是否推送(默认 true)' },
|
|
35
|
-
{ flag: 'audit', type: 'boolean', desc: '提交前审计(默认取配置)' },
|
|
36
55
|
{ flag: 'dryRun', type: 'boolean', desc: 'dry-run 只模拟不写入' },
|
|
37
56
|
{ flag: 'force', type: 'boolean', desc: 'force 强推(谨慎)' },
|
|
38
57
|
{ flag: 'ignorePatterns', type: 'string', desc: '自定义忽略 pattern(追加 .gitignore)' },
|
|
39
58
|
{ flag: 'requirementsConfirmed', type: 'boolean', desc: '已核对开发者要求' },
|
|
40
59
|
{ flag: 'pushConfirmed', type: 'boolean', desc: '推送门禁放行' },
|
|
41
60
|
{ flag: 'paths', type: 'string', desc: '精确 add 路径(逗号分隔)' },
|
|
42
|
-
{ flag: 'auditExemptPaths', type: 'array', desc: '本次提交按文件临时豁免审计(数组,相对仓库根):所列文件的 finding 不参与拦截判定(含 blocker);仅本次有效,不落盘、不改 .auditignore' },
|
|
43
|
-
{ flag: 'auditExemptReason', type: 'string', desc: '豁免理由(可选,仅回显,不作拦截条件)' },
|
|
44
61
|
{ flag: 'remote', type: 'string', desc: '推送目标 remote(多 remote / fork 场景;缺省 origin)。推送与核验使用同一 remote' },
|
|
45
62
|
{ flag: 'waitCi', type: 'boolean', desc: '推送后等 CI 结果(默认不等):按推送的 sha 查 GitHub Actions,全绿=通过、任一失败=ciFailed、超时/无 CI 如实回报' },
|
|
46
63
|
{ flag: 'ciTimeoutSec', type: 'number', desc: '等 CI 的上限秒数(默认 900)' },
|
|
64
|
+
// 审计预处理贡献的参数(不可用时这里为空 ⇒ 传了会报「未知参数」,而不是静默忽略)
|
|
65
|
+
...(auditPreprocess.enabled(cfg, hasBuiltinEngine) ? auditPreprocess.params : []),
|
|
47
66
|
],
|
|
48
67
|
},
|
|
49
68
|
{
|
|
@@ -208,9 +227,9 @@ export const TOOL_REGISTRY = [
|
|
|
208
227
|
],
|
|
209
228
|
},
|
|
210
229
|
{
|
|
211
|
-
name: 'git_api', cli: 'api', description: '直接调用本插件的 HTTP API(36 条接口,与浏览器/CLI 同源实现:内部走 handleHttp 同一条代码路径)。path
|
|
230
|
+
name: 'git_api', cli: 'api', description: '直接调用本插件的 HTTP API(36 条接口,与浏览器/CLI 同源实现:内部走 handleHttp 同一条代码路径)。path=接口名:git/共享接口传短名(如 status / settings-get),审计接口推荐前缀相对写法(如 git-audit/audit、git-audit/rule-slots),也接受完整路径(/api/git-audit/…);短名形式的审计接口仍可用(旧前缀转发,响应带 Deprecation 头);method 默认 GET;query=查询参数 JSON(如 {"mode":"full"});body=POST 请求体 JSON;不传 path 则列出全部可用接口。写类接口(settings-set / repo-push 等)内部调用按本机同源放行。',
|
|
212
231
|
params: [
|
|
213
|
-
{ flag: 'path', type: 'string', positional: 0, desc: '接口名(缺省 =
|
|
232
|
+
{ flag: 'path', type: 'string', positional: 0, desc: '接口名(缺省 = 列出全部接口);审计接口推荐 git-audit/<接口> 前缀相对写法' },
|
|
214
233
|
{ flag: 'method', type: 'string', desc: 'HTTP 方法(默认 GET;写操作传 POST)' },
|
|
215
234
|
{ flag: 'query', type: 'string', desc: '查询参数 JSON 字符串,如 {"mode":"full"}' },
|
|
216
235
|
{ flag: 'body', type: 'string', desc: 'POST 请求体 JSON 字符串' },
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* HTTP 处理器 · 审计侧(规则包 / 审计结果聚合 / 规则启停 / 豁免提示)
|
|
3
|
+
*
|
|
4
|
+
* 为什么单独成文件:审计侧 HTTP 面要与 git 侧**物理分家**(对应 `/api/git-audit/*` 前缀)——
|
|
5
|
+
* 否则「审计将来能整体抠走」只是路由上的说法,代码层仍混在 meta.js 里。
|
|
6
|
+
* 本文件只放审计专属 handler 与它们的辅助函数(ruleSlotStats / listRuleSlots)。
|
|
7
|
+
*
|
|
8
|
+
* 路由映射(见 lib/app/http-handlers.js):
|
|
9
|
+
* /api/git-audit/{rule-slots,rule-detail,audit,toggle-rule,exempt-hint}
|
|
10
|
+
* 旧 /api/git-push/{同 5 条} 保留一版转发(响应带 Deprecation 头)。
|
|
11
|
+
*/
|
|
12
|
+
import { discoverRuleSlots, loadYamlRuleFile, resolveSlotOrder, setSlotDisabled, RULE_YAML_DIR } from '../../rule/loader.js';
|
|
13
|
+
import { getLastSlotHitStats } from '../slot-stats.js';
|
|
14
|
+
import { getDefaultScanRoot } from '../scan-root.js';
|
|
15
|
+
import { exemptHintForFinding, exemptMarkerCovers, EXEMPT_MARKERS } from '../../exempt/index.js';
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* 由规则包 yml 解析结果算该槽位的规则条数统计。
|
|
19
|
+
*
|
|
20
|
+
* 为什么单独成函数:这段(rules 过滤 + private_files 计数 + pass 推导)原先内联在
|
|
21
|
+
* listRuleSlots 的循环里,与「槽位元数据组装」混在一起,把该函数圈复杂度推到 15
|
|
22
|
+
* (阈值 10,自审 max-cyclomatic-complexity)——拆开后统计口径可单独阅读与复用。
|
|
23
|
+
* 清单驱动槽位(private)用 private_files 条目数计(它们不在 rules 数组里)。
|
|
24
|
+
*/
|
|
25
|
+
function ruleSlotStats(r) {
|
|
26
|
+
const rules = Array.isArray(r.data.rules) ? r.data.rules : [];
|
|
27
|
+
const listed = Array.isArray(r.data.private_files) ? r.data.private_files.length : 0;
|
|
28
|
+
const total = rules.length + listed;
|
|
29
|
+
const blocker = rules.filter((x) => x && (x.severity === 'blocker' || x.severity === 'error')).length + listed;
|
|
30
|
+
const warning = rules.filter((x) => x && x.severity === 'warning').length;
|
|
31
|
+
return { blocker, warning, pass: Math.max(0, total - blocker - warning), total, source: 'rules' };
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** 规则包清单(按规则条数统计;hitStats 参数保留兼容但不再参与计算)。 */
|
|
35
|
+
export function listRuleSlots(order, disabledSlots = [], hitStats = null) {
|
|
36
|
+
const discovered = discoverRuleSlots(RULE_YAML_DIR);
|
|
37
|
+
const slotMeta = {};
|
|
38
|
+
for (const slot of discovered) {
|
|
39
|
+
const r = loadYamlRuleFile(slot, RULE_YAML_DIR);
|
|
40
|
+
if (r.ok && r.data?.metadata) {
|
|
41
|
+
slotMeta[slot] = {
|
|
42
|
+
name: r.data.metadata.name || slot,
|
|
43
|
+
description: r.data.metadata.description || '',
|
|
44
|
+
author: r.data.metadata.author || '',
|
|
45
|
+
stats: ruleSlotStats(r),
|
|
46
|
+
disabled: r.data.disabled === true || disabledSlots.includes(slot),
|
|
47
|
+
};
|
|
48
|
+
} else {
|
|
49
|
+
slotMeta[slot] = { name: slot, description: '', author: '', stats: { blocker: 0, warning: 0, pass: 0, total: 0, source: 'rules' }, disabled: disabledSlots.includes(slot) };
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
const eff = resolveSlotOrder(order && order.length ? order : undefined, { dir: RULE_YAML_DIR });
|
|
53
|
+
return { discovered, order: eff, meta: slotMeta, forced: ['private'] };
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/** GET /api/git-push/rule-slots —— 规则包按包规则条数统计。 */
|
|
57
|
+
export function handleRuleSlots(ctx) {
|
|
58
|
+
const { cfg } = ctx;
|
|
59
|
+
return { status: 200, body: { ok: true, slots: listRuleSlots(cfg.auditRuleOrder, Array.isArray(cfg.auditDisabledSlots) ? cfg.auditDisabledSlots : [], getLastSlotHitStats()) } };
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/** GET /api/git-push/rule-detail —— 单个规则包的规则明细 + severity 统计。 */
|
|
63
|
+
export function handleRuleDetail(ctx) {
|
|
64
|
+
const { query } = ctx;
|
|
65
|
+
const slot = String(query.slot || '');
|
|
66
|
+
if (!slot) return { status: 400, body: { ok: false, code: 'SLOT_REQUIRED', error: '缺少规则包名 slot' } };
|
|
67
|
+
const r = loadYamlRuleFile(slot, RULE_YAML_DIR);
|
|
68
|
+
if (!r.ok) return { status: 404, body: { ok: false, code: 'SLOT_NOT_FOUND', error: r.error } };
|
|
69
|
+
const rules = Array.isArray(r.data?.rules) ? r.data.rules : [];
|
|
70
|
+
const detail = rules.map((rule) => ({
|
|
71
|
+
id: rule.id || '',
|
|
72
|
+
name: rule.name || rule.id || '',
|
|
73
|
+
category: rule.category || '',
|
|
74
|
+
severity: rule.severity || 'notice',
|
|
75
|
+
description: rule.description || '',
|
|
76
|
+
author: rule.author || r.data.metadata?.author || '',
|
|
77
|
+
}));
|
|
78
|
+
const count = (sev) => detail.filter((x) => x.severity === sev).length;
|
|
79
|
+
const stats = {
|
|
80
|
+
blocker: count('blocker') + count('error'),
|
|
81
|
+
warning: count('warning'),
|
|
82
|
+
pass: rules.length - count('blocker') - count('error') - count('warning'),
|
|
83
|
+
total: rules.length,
|
|
84
|
+
};
|
|
85
|
+
return { status: 200, body: { ok: true, slot, meta: { name: r.data?.metadata?.name || slot, description: r.data?.metadata?.description || '', author: r.data?.metadata?.author || '' }, stats, rules: detail } };
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/** POST/GET /api/git-push/audit —— 审计结果 API(请求时聚合)。 */
|
|
89
|
+
export async function handleAudit(ctx) {
|
|
90
|
+
const { query, body, env, cfg } = ctx;
|
|
91
|
+
const { runAuditApi } = await import('../audit-api.js');
|
|
92
|
+
const params = { ...query, ...body };
|
|
93
|
+
const repo = String(params.repo || '').trim()
|
|
94
|
+
|| getDefaultScanRoot(env, { defaultScanRoot: String(cfg.defaultScanRoot || '') });
|
|
95
|
+
if (!repo) return { status: 400, body: { ok: false, code: 'REPO_REQUIRED', error: '缺 repo 参数且无法推断默认扫描根' } };
|
|
96
|
+
try {
|
|
97
|
+
const r = await runAuditApi(repo, params, cfg);
|
|
98
|
+
return { status: 200, body: r };
|
|
99
|
+
} catch (e) {
|
|
100
|
+
return { status: 500, body: { ok: false, code: 'AUDIT_FAIL', error: `审计失败: ${e?.message || e}` } };
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/** POST /api/git-push/toggle-rule —— 启用/禁用规则包(改 yml disabled)。 */
|
|
105
|
+
export function handleToggleRule(ctx) {
|
|
106
|
+
const { body } = ctx;
|
|
107
|
+
const slot = String(body.slot || '');
|
|
108
|
+
const want = body.disabled === true;
|
|
109
|
+
if (!slot) return { status: 400, body: { ok: false, code: 'SLOT_REQUIRED', error: '缺少规则包名 slot' } };
|
|
110
|
+
const r = setSlotDisabled(slot, want);
|
|
111
|
+
if (!r.ok) return { status: 400, body: { ok: false, code: 'SLOT_TOGGLE_FAIL', error: r.error || '切换失败' } };
|
|
112
|
+
return { status: 200, body: { ok: true, slot, disabled: r.disabled, message: want ? '已禁用' : '已启用' } };
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* GET /api/git-push/exempt-hint —— 豁免标记查询(只读)。
|
|
117
|
+
*
|
|
118
|
+
* 入参 query:rule(规则名,如 maintainability/max-complexity)、kind(可选 finding kind)。
|
|
119
|
+
* 出参:{ ok, rule, kind, marker, hint, lineLevel, candidates }。
|
|
120
|
+
*
|
|
121
|
+
* 为什么要有这个端点:豁免标记注册表(EXEMPT_MARKERS)是**单一真源**,外部工具(如
|
|
122
|
+
* dsh-useful-tools 的 exempt 工具)需要「该写哪个标记」时来查,而不是复制一份注册表
|
|
123
|
+
* ——复制必然漂移(历史上「提示与实际行为不符」的 24 种组合就是这么来的)。
|
|
124
|
+
*/
|
|
125
|
+
export function handleExemptHint(ctx) {
|
|
126
|
+
const rule = String(ctx.query?.rule || '').trim();
|
|
127
|
+
const kind = String(ctx.query?.kind || '').trim();
|
|
128
|
+
const finding = { rule, kind };
|
|
129
|
+
const hit = exemptHintForFinding(finding);
|
|
130
|
+
const meta = hit ? EXEMPT_MARKERS[hit.marker] : null;
|
|
131
|
+
const candidates = Object.entries(EXEMPT_MARKERS).map(([marker, m]) => ({
|
|
132
|
+
marker,
|
|
133
|
+
lineLevel: m.lineLevel === true,
|
|
134
|
+
dimensions: m.dimensions || [],
|
|
135
|
+
hint: m.hint || '',
|
|
136
|
+
covers: Boolean(rule || kind) && exemptMarkerCovers(marker, finding),
|
|
137
|
+
}));
|
|
138
|
+
return {
|
|
139
|
+
status: 200,
|
|
140
|
+
body: {
|
|
141
|
+
ok: true,
|
|
142
|
+
rule,
|
|
143
|
+
kind,
|
|
144
|
+
marker: hit ? hit.marker : null,
|
|
145
|
+
hint: hit ? hit.hint : '无任何标记可豁免该 finding(应改代码,或走 .auditignore / 豁免槽位)',
|
|
146
|
+
lineLevel: meta ? meta.lineLevel === true : false,
|
|
147
|
+
candidates,
|
|
148
|
+
},
|
|
149
|
+
};
|
|
150
|
+
}
|
package/lib/app/handlers/meta.js
CHANGED
|
@@ -1,21 +1,20 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* HTTP 处理层 ·
|
|
2
|
+
* HTTP 处理层 · git/共享元信息与只读端点(status/scan/browse/tools/tool-probes)
|
|
3
|
+
*
|
|
4
|
+
* 审计侧(rule-slots / rule-detail / audit / toggle-rule / exempt-hint)已搬到 handlers/audit.js,
|
|
5
|
+
* 与 /api/git-audit 前缀同构——本文件不再 import 任何审计实现。
|
|
3
6
|
*
|
|
4
7
|
* 从 http-handlers.js 的 handleHttp 巨型 switch 拆分而来。
|
|
5
8
|
* 统一签名:handleXxx(ctx) → { status, body };ctx = { req, query, body, env, cfg, path, method }。
|
|
6
9
|
*/
|
|
7
10
|
import { VERSION } from '../../self/index.js';
|
|
8
11
|
import { scanRepos, browseDir } from '../../git/index.js';
|
|
9
|
-
import { getDefaultScanRoot } from '../scan-root.js';
|
|
10
12
|
import { collectToolPaths } from '../../context/index.js';
|
|
11
13
|
import { redactConfig } from '../schema.js';
|
|
12
|
-
import { getLastSlotHitStats } from '../slot-stats.js';
|
|
13
14
|
import { listTools } from '../tools.js';
|
|
14
|
-
import { discoverRuleSlots, loadYamlRuleFile, resolveSlotOrder, setSlotDisabled, RULE_YAML_DIR } from '../../rule/loader.js';
|
|
15
15
|
import { name } from '../constants.js';
|
|
16
16
|
import { readAccountStatus } from '../../git/account-status.js';
|
|
17
17
|
import { identityHintText, resolveCommitIdentity } from '../../git/identity.js';
|
|
18
|
-
import { exemptHintForFinding, exemptMarkerCovers, EXEMPT_MARKERS } from '../../exempt/index.js';
|
|
19
18
|
|
|
20
19
|
/**
|
|
21
20
|
* 当前提交身份(未配身份的仓库会用到的那个):登录账号可用 → 账号身份;
|
|
@@ -68,146 +67,12 @@ export function handleBrowse(ctx) {
|
|
|
68
67
|
}
|
|
69
68
|
|
|
70
69
|
/** GET /api/git-push/tools —— 插件自身工具定义清单(agent 工具)。 */
|
|
71
|
-
export function handleTools() {
|
|
72
|
-
|
|
70
|
+
export function handleTools(ctx = {}) {
|
|
71
|
+
// 传 cfg:函数形态的 params 按当前配置求值(未启用的预处理参数不出现在清单里)
|
|
72
|
+
return { status: 200, body: { ok: true, tools: listTools(ctx.cfg) } };
|
|
73
73
|
}
|
|
74
74
|
|
|
75
75
|
/** GET /api/git-push/tool-probes —— 本机各工具实测路径/版本(真实探测)。 */
|
|
76
76
|
export function handleToolProbes() {
|
|
77
77
|
return { status: 200, body: { ok: true, probes: collectToolPaths(null) } };
|
|
78
78
|
}
|
|
79
|
-
|
|
80
|
-
/**
|
|
81
|
-
* 由规则包 yml 解析结果算该槽位的规则条数统计。
|
|
82
|
-
*
|
|
83
|
-
* 为什么单独成函数:这段(rules 过滤 + private_files 计数 + pass 推导)原先内联在
|
|
84
|
-
* listRuleSlots 的循环里,与「槽位元数据组装」混在一起,把该函数圈复杂度推到 15
|
|
85
|
-
* (阈值 10,自审 max-cyclomatic-complexity)——拆开后统计口径可单独阅读与复用。
|
|
86
|
-
* 清单驱动槽位(private)用 private_files 条目数计(它们不在 rules 数组里)。
|
|
87
|
-
*/
|
|
88
|
-
function ruleSlotStats(r) {
|
|
89
|
-
const rules = Array.isArray(r.data.rules) ? r.data.rules : [];
|
|
90
|
-
const listed = Array.isArray(r.data.private_files) ? r.data.private_files.length : 0;
|
|
91
|
-
const total = rules.length + listed;
|
|
92
|
-
const blocker = rules.filter((x) => x && (x.severity === 'blocker' || x.severity === 'error')).length + listed;
|
|
93
|
-
const warning = rules.filter((x) => x && x.severity === 'warning').length;
|
|
94
|
-
return { blocker, warning, pass: Math.max(0, total - blocker - warning), total, source: 'rules' };
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
/** 规则包清单(按规则条数统计;hitStats 参数保留兼容但不再参与计算)。 */
|
|
98
|
-
export function listRuleSlots(order, disabledSlots = [], hitStats = null) {
|
|
99
|
-
const discovered = discoverRuleSlots(RULE_YAML_DIR);
|
|
100
|
-
const slotMeta = {};
|
|
101
|
-
for (const slot of discovered) {
|
|
102
|
-
const r = loadYamlRuleFile(slot, RULE_YAML_DIR);
|
|
103
|
-
if (r.ok && r.data?.metadata) {
|
|
104
|
-
slotMeta[slot] = {
|
|
105
|
-
name: r.data.metadata.name || slot,
|
|
106
|
-
description: r.data.metadata.description || '',
|
|
107
|
-
author: r.data.metadata.author || '',
|
|
108
|
-
stats: ruleSlotStats(r),
|
|
109
|
-
disabled: r.data.disabled === true || disabledSlots.includes(slot),
|
|
110
|
-
};
|
|
111
|
-
} else {
|
|
112
|
-
slotMeta[slot] = { name: slot, description: '', author: '', stats: { blocker: 0, warning: 0, pass: 0, total: 0, source: 'rules' }, disabled: disabledSlots.includes(slot) };
|
|
113
|
-
}
|
|
114
|
-
}
|
|
115
|
-
const eff = resolveSlotOrder(order && order.length ? order : undefined, { dir: RULE_YAML_DIR });
|
|
116
|
-
return { discovered, order: eff, meta: slotMeta, forced: ['private'] };
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
/** GET /api/git-push/rule-slots —— 规则包按包规则条数统计。 */
|
|
120
|
-
export function handleRuleSlots(ctx) {
|
|
121
|
-
const { cfg } = ctx;
|
|
122
|
-
return { status: 200, body: { ok: true, slots: listRuleSlots(cfg.auditRuleOrder, Array.isArray(cfg.auditDisabledSlots) ? cfg.auditDisabledSlots : [], getLastSlotHitStats()) } };
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
/** GET /api/git-push/rule-detail —— 单个规则包的规则明细 + severity 统计。 */
|
|
126
|
-
export function handleRuleDetail(ctx) {
|
|
127
|
-
const { query } = ctx;
|
|
128
|
-
const slot = String(query.slot || '');
|
|
129
|
-
if (!slot) return { status: 400, body: { ok: false, code: 'SLOT_REQUIRED', error: '缺少规则包名 slot' } };
|
|
130
|
-
const r = loadYamlRuleFile(slot, RULE_YAML_DIR);
|
|
131
|
-
if (!r.ok) return { status: 404, body: { ok: false, code: 'SLOT_NOT_FOUND', error: r.error } };
|
|
132
|
-
const rules = Array.isArray(r.data?.rules) ? r.data.rules : [];
|
|
133
|
-
const detail = rules.map((rule) => ({
|
|
134
|
-
id: rule.id || '',
|
|
135
|
-
name: rule.name || rule.id || '',
|
|
136
|
-
category: rule.category || '',
|
|
137
|
-
severity: rule.severity || 'notice',
|
|
138
|
-
description: rule.description || '',
|
|
139
|
-
author: rule.author || r.data.metadata?.author || '',
|
|
140
|
-
}));
|
|
141
|
-
const count = (sev) => detail.filter((x) => x.severity === sev).length;
|
|
142
|
-
const stats = {
|
|
143
|
-
blocker: count('blocker') + count('error'),
|
|
144
|
-
warning: count('warning'),
|
|
145
|
-
pass: rules.length - count('blocker') - count('error') - count('warning'),
|
|
146
|
-
total: rules.length,
|
|
147
|
-
};
|
|
148
|
-
return { status: 200, body: { ok: true, slot, meta: { name: r.data?.metadata?.name || slot, description: r.data?.metadata?.description || '', author: r.data?.metadata?.author || '' }, stats, rules: detail } };
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/** POST/GET /api/git-push/audit —— 审计结果 API(请求时聚合)。 */
|
|
152
|
-
export async function handleAudit(ctx) {
|
|
153
|
-
const { query, body, env, cfg } = ctx;
|
|
154
|
-
const { runAuditApi } = await import('../audit-api.js');
|
|
155
|
-
const params = { ...query, ...body };
|
|
156
|
-
const repo = String(params.repo || '').trim()
|
|
157
|
-
|| getDefaultScanRoot(env, { defaultScanRoot: String(cfg.defaultScanRoot || '') });
|
|
158
|
-
if (!repo) return { status: 400, body: { ok: false, code: 'REPO_REQUIRED', error: '缺 repo 参数且无法推断默认扫描根' } };
|
|
159
|
-
try {
|
|
160
|
-
const r = await runAuditApi(repo, params, cfg);
|
|
161
|
-
return { status: 200, body: r };
|
|
162
|
-
} catch (e) {
|
|
163
|
-
return { status: 500, body: { ok: false, code: 'AUDIT_FAIL', error: `审计失败: ${e?.message || e}` } };
|
|
164
|
-
}
|
|
165
|
-
}
|
|
166
|
-
|
|
167
|
-
/** POST /api/git-push/toggle-rule —— 启用/禁用规则包(改 yml disabled)。 */
|
|
168
|
-
export function handleToggleRule(ctx) {
|
|
169
|
-
const { body } = ctx;
|
|
170
|
-
const slot = String(body.slot || '');
|
|
171
|
-
const want = body.disabled === true;
|
|
172
|
-
if (!slot) return { status: 400, body: { ok: false, code: 'SLOT_REQUIRED', error: '缺少规则包名 slot' } };
|
|
173
|
-
const r = setSlotDisabled(slot, want);
|
|
174
|
-
if (!r.ok) return { status: 400, body: { ok: false, code: 'SLOT_TOGGLE_FAIL', error: r.error || '切换失败' } };
|
|
175
|
-
return { status: 200, body: { ok: true, slot, disabled: r.disabled, message: want ? '已禁用' : '已启用' } };
|
|
176
|
-
}
|
|
177
|
-
|
|
178
|
-
/**
|
|
179
|
-
* GET /api/git-push/exempt-hint —— 豁免标记查询(只读)。
|
|
180
|
-
*
|
|
181
|
-
* 入参 query:rule(规则名,如 maintainability/max-complexity)、kind(可选 finding kind)。
|
|
182
|
-
* 出参:{ ok, rule, kind, marker, hint, lineLevel, candidates }。
|
|
183
|
-
*
|
|
184
|
-
* 为什么要有这个端点:豁免标记注册表(EXEMPT_MARKERS)是**单一真源**,外部工具(如
|
|
185
|
-
* dsh-useful-tools 的 exempt 工具)需要「该写哪个标记」时来查,而不是复制一份注册表
|
|
186
|
-
* ——复制必然漂移(历史上「提示与实际行为不符」的 24 种组合就是这么来的)。
|
|
187
|
-
*/
|
|
188
|
-
export function handleExemptHint(ctx) {
|
|
189
|
-
const rule = String(ctx.query?.rule || '').trim();
|
|
190
|
-
const kind = String(ctx.query?.kind || '').trim();
|
|
191
|
-
const finding = { rule, kind };
|
|
192
|
-
const hit = exemptHintForFinding(finding);
|
|
193
|
-
const meta = hit ? EXEMPT_MARKERS[hit.marker] : null;
|
|
194
|
-
const candidates = Object.entries(EXEMPT_MARKERS).map(([marker, m]) => ({
|
|
195
|
-
marker,
|
|
196
|
-
lineLevel: m.lineLevel === true,
|
|
197
|
-
dimensions: m.dimensions || [],
|
|
198
|
-
hint: m.hint || '',
|
|
199
|
-
covers: Boolean(rule || kind) && exemptMarkerCovers(marker, finding),
|
|
200
|
-
}));
|
|
201
|
-
return {
|
|
202
|
-
status: 200,
|
|
203
|
-
body: {
|
|
204
|
-
ok: true,
|
|
205
|
-
rule,
|
|
206
|
-
kind,
|
|
207
|
-
marker: hit ? hit.marker : null,
|
|
208
|
-
hint: hit ? hit.hint : '无任何标记可豁免该 finding(应改代码,或走 .auditignore / 豁免槽位)',
|
|
209
|
-
lineLevel: meta ? meta.lineLevel === true : false,
|
|
210
|
-
candidates,
|
|
211
|
-
},
|
|
212
|
-
};
|
|
213
|
-
}
|
package/lib/app/handlers/npm.js
CHANGED
|
@@ -10,7 +10,7 @@ import { join } from 'node:path';
|
|
|
10
10
|
import { readNpmToken, maskToken } from '../../core/credentials.js';
|
|
11
11
|
import { normalizeRegistry, whoami, listOwnedPackages } from '../../npm/registry.js';
|
|
12
12
|
import { npmArgs, writeNpmrc } from '../../npm/npmrc.js';
|
|
13
|
-
import { installPackages, startInstall, validateDest } from '../../npm/install.js';
|
|
13
|
+
import { installPackages, startInstall, installProgress, validateDest } from '../../npm/install.js';
|
|
14
14
|
import { publishPackage } from '../../npm/publish.js';
|
|
15
15
|
import { readNpmAccountStatus, writeNpmAccountStatus, buildNpmAccountStatus, renderNpmAccountBlock } from '../../npm/account.js';
|
|
16
16
|
|
|
@@ -149,6 +149,23 @@ export function handleNpmInstall(ctx) {
|
|
|
149
149
|
* `/npm-publish`:发包。**默认 dry-run**(只体检 + `npm publish --dry-run`,不写 registry ✗);
|
|
150
150
|
* 真发必须同时 `confirm:true` **且** `dryRun:false`(双闸门,防误发不可撤销)。
|
|
151
151
|
*/
|
|
152
|
+
/**
|
|
153
|
+
* 异步安装进度(对应 GitHub 克隆的 `/clone-progress`)。
|
|
154
|
+
*
|
|
155
|
+
* 为什么补这条:前端 `controller.js` 的 `pollInstallProgress()` 一直在 POST 这个路径轮询,
|
|
156
|
+
* 但路由 switch 里从来没有这个 case ⇒ 每次轮询 404,进度框永远拿不到进度(既有 bug)。
|
|
157
|
+
* 实现(`installProgress`)本来就在 `lib/npm/install.js`,只是路由漏了。
|
|
158
|
+
*
|
|
159
|
+
* 返回结构与前端消费对齐:`installProgress()` 返回 `{ ok, progress }`(运行中/终态)
|
|
160
|
+
* 或 `{ ok, state: 'idle' }`(无任务)——前端读 `st.progress`,无 progress 就直接 return,安全。
|
|
161
|
+
*/
|
|
162
|
+
export function handleNpmInstallProgress(ctx) {
|
|
163
|
+
const { body = {}, query = {} } = ctx;
|
|
164
|
+
const consume = body.consume === true || body.consume === 'true'
|
|
165
|
+
|| query.consume === '1' || query.consume === 'true';
|
|
166
|
+
return { status: 200, body: installProgress({ consume }) };
|
|
167
|
+
}
|
|
168
|
+
|
|
152
169
|
export async function handleNpmPublish(ctx) {
|
|
153
170
|
const { env, cfg, body } = ctx;
|
|
154
171
|
const dryRun = body?.dryRun !== false;
|
package/lib/app/http-handlers.js
CHANGED
|
@@ -10,8 +10,11 @@ import { checkOrigin, checkBodySize, checkWriteConfirm, readJsonBody } from '../
|
|
|
10
10
|
import { defaultConfig } from '../client/index.js';
|
|
11
11
|
import {
|
|
12
12
|
handleStatus, handleScan, handleBrowse, handleTools, handleToolProbes,
|
|
13
|
-
handleRuleSlots, handleRuleDetail, handleAudit, handleToggleRule, handleExemptHint,
|
|
14
13
|
} from './handlers/meta.js';
|
|
14
|
+
// 审计侧 handler 已独立成文件(与 /api/git-audit 前缀同构):git 侧路由不再 import 审计实现
|
|
15
|
+
import {
|
|
16
|
+
listRuleSlots, handleRuleSlots, handleRuleDetail, handleAudit, handleToggleRule, handleExemptHint,
|
|
17
|
+
} from './handlers/audit.js';
|
|
15
18
|
import {
|
|
16
19
|
handleReposLocal, handleReposLocalScan, handleReposLocalScanWait, handleReposLocalRefresh, handleReposCloud,
|
|
17
20
|
} from './handlers/repos.js';
|
|
@@ -30,12 +33,10 @@ import {
|
|
|
30
33
|
import {
|
|
31
34
|
handleWorkspacePathsGet, handleWorkspacePathsSet,
|
|
32
35
|
} from './handlers/workspace-paths.js';
|
|
33
|
-
import {
|
|
34
|
-
handleNpmAccount, handleNpmCheck, handleNpmOwned, handleNpmPackages, handleNpmInstall, handleNpmPublish,
|
|
35
|
-
} from './handlers/npm.js';
|
|
36
|
+
import { handleNpmAccount, handleNpmCheck, handleNpmOwned, handleNpmPackages, handleNpmInstall, handleNpmPublish, handleNpmInstallProgress } from './handlers/npm.js';
|
|
36
37
|
import { appendHttpRejectLog } from './settings-bridge.js';
|
|
37
38
|
/** 规则槽位清单对外导出(实现迁至 handlers/meta.js)。 */
|
|
38
|
-
export { listRuleSlots } from './handlers/
|
|
39
|
+
export { listRuleSlots } from './handlers/audit.js';
|
|
39
40
|
|
|
40
41
|
/**
|
|
41
42
|
* HTTP 适配:DSH webServer 原生 (req, res) ↔ v2 纯函数 handleHttp({status, body})。
|
|
@@ -58,7 +59,8 @@ export async function adaptHttpHandler(req, res, env, cfg) {
|
|
|
58
59
|
);
|
|
59
60
|
if (!httpResult) return undefined;
|
|
60
61
|
try {
|
|
61
|
-
|
|
62
|
+
// handler 可通过 result.headers 附加响应头(当前用于旧审计路径的 Deprecation / Link)
|
|
63
|
+
res.writeHead(httpResult.status, { 'Content-Type': 'application/json; charset=utf-8', ...(httpResult.headers || {}) });
|
|
62
64
|
res.end(JSON.stringify(httpResult.body, null, 2));
|
|
63
65
|
} catch { /* 响应已开始或连接已断:忽略 */ }
|
|
64
66
|
return httpResult;
|
|
@@ -86,6 +88,37 @@ function buildCtx(req, method, env, cfg, query, body, path) {
|
|
|
86
88
|
return { req, method, env, cfg, query, body, path };
|
|
87
89
|
}
|
|
88
90
|
|
|
91
|
+
/** 审计侧 HTTP 前缀(与 git 侧 `/api/git-push` 物理分开;git 侧 25 条路径一个字未改)。 */
|
|
92
|
+
export const AUDIT_API_PREFIX = '/api/git-audit';
|
|
93
|
+
|
|
94
|
+
/** 旧前缀下的审计路径:保留一版转发,响应带 Deprecation 头(指向新路径)。 */
|
|
95
|
+
const DEPRECATED_AUDIT_PATHS = new Map([
|
|
96
|
+
['/api/git-push/audit', `${AUDIT_API_PREFIX}/audit`],
|
|
97
|
+
['/api/git-push/rule-slots', `${AUDIT_API_PREFIX}/rule-slots`],
|
|
98
|
+
['/api/git-push/rule-detail', `${AUDIT_API_PREFIX}/rule-detail`],
|
|
99
|
+
['/api/git-push/toggle-rule', `${AUDIT_API_PREFIX}/toggle-rule`],
|
|
100
|
+
['/api/git-push/exempt-hint', `${AUDIT_API_PREFIX}/exempt-hint`],
|
|
101
|
+
]);
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* 给「旧路径转发」的响应补上废弃标记。
|
|
105
|
+
* 为什么用响应头而不是错误:旧路径仍然**能用**(兼容一版),只是要在自动化能看见的地方留痕,
|
|
106
|
+
* 将来移除时才有人能拿出「谁还在调」的证据。`Link: rel="successor-version"` 是 RFC 5829 的标准写法。
|
|
107
|
+
* @param {object} result handler 返回值 { status, body, headers? }
|
|
108
|
+
* @param {string} successorPath 新路径
|
|
109
|
+
* @returns {object}
|
|
110
|
+
*/
|
|
111
|
+
function withDeprecation(result, successorPath) {
|
|
112
|
+
return {
|
|
113
|
+
...result,
|
|
114
|
+
headers: {
|
|
115
|
+
...(result?.headers || {}),
|
|
116
|
+
Deprecation: 'true',
|
|
117
|
+
Link: `<${successorPath}>; rel="successor-version"`,
|
|
118
|
+
},
|
|
119
|
+
};
|
|
120
|
+
}
|
|
121
|
+
|
|
89
122
|
/**
|
|
90
123
|
* HTTP 端点分发(鉴权前置:Origin/CSRF → 413 → 写确认 → switch 路由)。
|
|
91
124
|
* 各端点实现已拆到 lib/app/handlers/ 模块(meta/repos/repo-actions/clone/account/settings)。
|
|
@@ -119,7 +152,8 @@ export async function handleHttp(req = {}, env = {}, cfg = defaultConfig()) {
|
|
|
119
152
|
const path = String(req.url || '/').split('?')[0];
|
|
120
153
|
const query = Object.fromEntries(new URLSearchParams(String(req.url || '/').split('?')[1] || ''));
|
|
121
154
|
const body = readBody(req);
|
|
122
|
-
|
|
155
|
+
// 只列真实存在的写确认端点:`rebuild` / `rollback` 曾在此白名单里但路由已无对应 case(死条目,2026-11-14 清理)
|
|
156
|
+
const writeConfirmOps = ['/api/git-push/repo-push', '/api/git-push/repo-commit', '/api/git-push/repo-clone', '/api/git-push/repo-visibility'];
|
|
123
157
|
if (writeConfirmOps.includes(path)) {
|
|
124
158
|
const confirm = checkWriteConfirm(body);
|
|
125
159
|
if (!confirm.ok) return { status: confirm.status, body: { ok: false, ...confirm } };
|
|
@@ -144,18 +178,26 @@ export async function handleHttp(req = {}, env = {}, cfg = defaultConfig()) {
|
|
|
144
178
|
case '/api/git-push/clone-progress': return handleCloneProgress(ctx);
|
|
145
179
|
case '/api/git-push/tools': return handleTools(ctx);
|
|
146
180
|
case '/api/git-push/tool-probes': return handleToolProbes(ctx);
|
|
147
|
-
|
|
148
|
-
case '/api/git-
|
|
149
|
-
case '/api/git-
|
|
150
|
-
case '/api/git-
|
|
181
|
+
// ── 审计侧(新前缀):规则包 / 审计结果聚合 / 规则启停 / 豁免提示 ──
|
|
182
|
+
case '/api/git-audit/rule-slots': return handleRuleSlots(ctx);
|
|
183
|
+
case '/api/git-audit/rule-detail': return handleRuleDetail(ctx);
|
|
184
|
+
case '/api/git-audit/audit': return await handleAudit(ctx);
|
|
185
|
+
case '/api/git-audit/toggle-rule': return handleToggleRule(ctx);
|
|
151
186
|
// 豁免标记查询(只读):供外部工具推导「该写哪个 dsh-skip-*」,避免复制标记注册表
|
|
152
|
-
case '/api/git-
|
|
187
|
+
case '/api/git-audit/exempt-hint': return handleExemptHint(ctx);
|
|
188
|
+
// ── 旧前缀(兼容一版):转发到同一 handler + Deprecation 头 ──
|
|
189
|
+
case '/api/git-push/rule-slots': return withDeprecation(handleRuleSlots(ctx), `${AUDIT_API_PREFIX}/rule-slots`);
|
|
190
|
+
case '/api/git-push/rule-detail': return withDeprecation(handleRuleDetail(ctx), `${AUDIT_API_PREFIX}/rule-detail`);
|
|
191
|
+
case '/api/git-push/audit': return withDeprecation(await handleAudit(ctx), `${AUDIT_API_PREFIX}/audit`);
|
|
192
|
+
case '/api/git-push/toggle-rule': return withDeprecation(handleToggleRule(ctx), `${AUDIT_API_PREFIX}/toggle-rule`);
|
|
193
|
+
case '/api/git-push/exempt-hint': return withDeprecation(handleExemptHint(ctx), `${AUDIT_API_PREFIX}/exempt-hint`);
|
|
153
194
|
case '/api/git-push/account-status': return handleAccountStatus(ctx);
|
|
154
195
|
case '/api/git-push/npm-account': return await handleNpmAccount(ctx);
|
|
155
196
|
case '/api/git-push/npm-check': return await handleNpmCheck(ctx);
|
|
156
197
|
case '/api/git-push/npm-owned': return await handleNpmOwned(ctx);
|
|
157
198
|
case '/api/git-push/npm-packages': return handleNpmPackages(ctx);
|
|
158
199
|
case '/api/git-push/npm-install': return handleNpmInstall(ctx);
|
|
200
|
+
case '/api/git-push/npm-install-progress': return handleNpmInstallProgress(ctx);
|
|
159
201
|
case '/api/git-push/npm-publish': return await handleNpmPublish(ctx);
|
|
160
202
|
case '/api/git-push/account-check': return await handleAccountCheck(ctx);
|
|
161
203
|
case '/api/git-push/api-quota': return await handleApiQuota(ctx);
|
package/lib/app/inject-text.js
CHANGED
|
@@ -106,7 +106,7 @@ export function buildRequirementsInjectionText() {
|
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
108
|
* 审计输出公共函数:只输出「级别数量 + 评分 + API 查询用法」——
|
|
109
|
-
* 审计结果改由聚合 API 查询(/api/git-
|
|
109
|
+
* 审计结果改由聚合 API 查询(/api/git-audit/audit —— 审计侧独立前缀),不再内联输出审计内容。
|
|
110
110
|
* code_audit 工具 / git_commit_push 提交后统一调用,避免各处输出漂移。
|
|
111
111
|
* @param {string} repo 仓库路径
|
|
112
112
|
* @param {object} [opts] { scope?: 'full'|'diff', summary?, quality? }
|
|
@@ -139,7 +139,8 @@ export function buildAuditApiGuide(repo = '', opts = {}) {
|
|
|
139
139
|
const scope = (opts.scope || 'full') === 'full' ? 'full' : 'diff';
|
|
140
140
|
// 参数自动填充:repo 实际路径(encode)、scope 实际值、groupBy 默认 rule、severity 默认全级别
|
|
141
141
|
const qs = `repo=${encodeURIComponent(repo || '')}&scope=${scope}&groupBy=${opts.groupBy || 'rule'}`;
|
|
142
|
-
|
|
142
|
+
// 审计侧已分到独立前缀(/api/git-audit):这里的 URL 是给用户/AI 直接复制去 curl 的,必须同步
|
|
143
|
+
const base = `http://${detectHostIp()}:30800/api/git-audit/audit`;
|
|
143
144
|
const L = [];
|
|
144
145
|
L.push(`审计:${repo || ''}(${scope === 'full' ? '全量' : '变动'})`);
|
|
145
146
|
L.push(`评分 ${quality.score ?? '?'}/${quality.level ?? '?'} · ${s.blocker ?? 0} 拦截 / ${s.warning ?? 0} 警告 / ${s.notice ?? 0} 提示`);
|
package/lib/app/tool-call.js
CHANGED
|
@@ -730,8 +730,13 @@ export async function callTool(toolName, args = {}, env = {}, cfg = defaultConfi
|
|
|
730
730
|
const endpoints = [...new Set(src.match(/case '\/api\/git-push\/[A-Za-z0-9/_-]+'/g) || [])]
|
|
731
731
|
.map((s) => s.replace("case '/api/git-push/", '').replace(/'$/, ''))
|
|
732
732
|
.sort();
|
|
733
|
-
|
|
734
|
-
|
|
733
|
+
// path 三种写法都认(审计侧搬到 /api/git-audit 后必须兼容旧写法,AI 面契约不能断):
|
|
734
|
+
// ① 短名 `rule-slots` → 走旧前缀 /api/git-push/rule-slots(旧路径转发,带 Deprecation 头)
|
|
735
|
+
// ② 前缀相对 `git-audit/rule-slots` → /api/git-audit/rule-slots(推荐写法)
|
|
736
|
+
// ③ 完整路径 `/api/git-audit/rule-slots` → 原样
|
|
737
|
+
const rawPath = String(args.path || '').trim();
|
|
738
|
+
const ep = rawPath.replace(/^\/+/, '').replace(/^api\//, '');
|
|
739
|
+
if (!ep) return { ok: true, count: endpoints.length, endpoints, note: '传 path 调用具体接口(如 path=status;审计接口推荐 path=git-audit/audit)' };
|
|
735
740
|
const method = String(args.method || 'GET').toUpperCase();
|
|
736
741
|
let query = {};
|
|
737
742
|
let body;
|
|
@@ -745,7 +750,8 @@ export async function callTool(toolName, args = {}, env = {}, cfg = defaultConfi
|
|
|
745
750
|
const bodyText = body === undefined ? '' : JSON.stringify(body);
|
|
746
751
|
const out = await handleHttp({
|
|
747
752
|
method,
|
|
748
|
-
|
|
753
|
+
// 已带前缀(git-audit/… 或 git-push/…)就用它;短名默认走 git-push(旧前缀,仍可用)
|
|
754
|
+
url: `/api/${/^(git-audit|git-push)\//.test(ep) ? ep : `git-push/${ep}`}${qs ? '?' + qs : ''}`,
|
|
749
755
|
origin: 'http://localhost', // 内部调用 = 本机同源(写类接口的 CSRF 门禁据此放行)
|
|
750
756
|
headers: { host: 'localhost', 'content-length': String(bodyText.length) },
|
|
751
757
|
body: bodyText,
|
package/lib/app/tools.js
CHANGED
|
@@ -6,12 +6,17 @@
|
|
|
6
6
|
* CLI 命令 / 宿主工具 schema / 帮助文档自动对齐(方案 B,免维护)。
|
|
7
7
|
*/
|
|
8
8
|
|
|
9
|
-
import { TOOL_REGISTRY } from './command-registry.js';
|
|
9
|
+
import { TOOL_REGISTRY, resolveEntryParams } from './command-registry.js';
|
|
10
10
|
|
|
11
|
-
/**
|
|
12
|
-
|
|
11
|
+
/**
|
|
12
|
+
* 注册表 params({flag,type,desc,...})→ 宿主工具 parameters 对象格式。
|
|
13
|
+
* @param {Array|Function} params 数组,或 (cfg) => 数组 的函数形态(参数按配置动态组装)
|
|
14
|
+
* @param {object} [cfg] 函数形态时传入
|
|
15
|
+
*/
|
|
16
|
+
function paramsToParameters(params = [], cfg) {
|
|
17
|
+
const list = typeof params === 'function' ? (params(cfg || {}) || []) : (params || []);
|
|
13
18
|
const out = {};
|
|
14
|
-
for (const p of
|
|
19
|
+
for (const p of list) {
|
|
15
20
|
// 参数类型 → JSON schema:**只产出宿主认的标量类型**(boolean / string / array)——
|
|
16
21
|
// 实测宿主校验不认 anyOf、也不认 JSON Schema 的「类型数组」写法(都按 string 处理 ✗,
|
|
17
22
|
// 报 invalid arguments: "x" must be a string)⇒ 复杂形态一律拆成独立参数 ✓
|
|
@@ -25,10 +30,12 @@ function paramsToParameters(params = []) {
|
|
|
25
30
|
}
|
|
26
31
|
|
|
27
32
|
/** 工具清单(名 + 说明 + 参数 spec——由注册表生成,单源;lib/plugin/normalizeParameters 转 DSH 形状注册)。 */
|
|
28
|
-
export function listTools() {
|
|
33
|
+
export function listTools(cfg, hasBuiltinEngine) {
|
|
29
34
|
return TOOL_REGISTRY.map((t) => ({
|
|
30
35
|
name: t.name,
|
|
31
36
|
description: t.description,
|
|
32
|
-
|
|
37
|
+
// 用 resolveEntryParams:函数形态的 params 按当前 cfg 求值 ⇒ 未启用的预处理参数不出现在签名里
|
|
38
|
+
// hasBuiltinEngine 只为测试注入(生产不传 ⇒ 真实文件存在性判断);必须透传,否则「不可用态」测不出来
|
|
39
|
+
parameters: paramsToParameters(resolveEntryParams(t, cfg, hasBuiltinEngine), cfg),
|
|
33
40
|
}));
|
|
34
41
|
}
|
package/lib/cli/shared.mjs
CHANGED
|
@@ -15,7 +15,7 @@ import { readFileSync, realpathSync } from 'node:fs';
|
|
|
15
15
|
import { fileURLToPath } from 'node:url';
|
|
16
16
|
|
|
17
17
|
import { VERSION } from '../self/index.js';
|
|
18
|
-
import { registryByCli, parseRegistryArgs } from '../app/command-registry.js';
|
|
18
|
+
import { registryByCli, parseRegistryArgs, resolveEntryParams } from '../app/command-registry.js';
|
|
19
19
|
import { callTool } from '../app/tool-call.js';
|
|
20
20
|
import { readSettings, applySettingsToCfg } from '../app/settings-bridge.js';
|
|
21
21
|
import { defaultConfig } from '../client/index.js';
|
|
@@ -347,14 +347,17 @@ export async function runCli({
|
|
|
347
347
|
passthroughGit = null, getConfig = () => undefined,
|
|
348
348
|
} = {}) {
|
|
349
349
|
const plan = resolveDispatch({ cliName, argv, commands });
|
|
350
|
-
|
|
350
|
+
// helpText 允许是函数:git 侧 HELP 里与「审计预处理」绑定的参数要按当前配置决定出不出现
|
|
351
|
+
if (plan.kind === 'help') { console.log(typeof helpText === 'function' ? helpText() : helpText); return; }
|
|
351
352
|
if (plan.kind === 'version') { printVersion(cliName); return; }
|
|
352
353
|
if (plan.kind === 'cross') { console.error(plan.hint); process.exitCode = 1; return 1; }
|
|
353
354
|
if (plan.kind === 'unknown') { console.error(plan.error); process.exitCode = 1; return 1; }
|
|
354
355
|
if (plan.kind === 'command') return await plan.handler(argv.slice(1));
|
|
355
356
|
if (plan.kind === 'registry') {
|
|
356
|
-
|
|
357
|
-
const
|
|
357
|
+
// 函数形态的 params 按当前插件配置求值(未启用的预处理参数不参与解析 ⇒ 传了报未知参数)
|
|
358
|
+
const entryParams = resolveEntryParams(plan.entry, cliPluginConfig());
|
|
359
|
+
const { argv: normalizedArgv, negated } = normalizeRegistryArgv(argv.slice(1), entryParams);
|
|
360
|
+
const { args, error } = parseRegistryArgs(normalizedArgv, entryParams);
|
|
358
361
|
// 参数错统一 exit 2(与 parseVia 一致、符合「用法错误」惯例);
|
|
359
362
|
// 其余失败(执行/网络/跨侧指引)保持 1,两者语义不同。
|
|
360
363
|
if (error) { console.error(error); process.exitCode = 2; return 2; }
|
|
@@ -363,7 +363,7 @@
|
|
|
363
363
|
this.slotError = '';
|
|
364
364
|
this.publish();
|
|
365
365
|
try {
|
|
366
|
-
const slotsRes = await dshgp_getJson('/api/git-
|
|
366
|
+
const slotsRes = await dshgp_getJson('/api/git-audit/rule-slots');
|
|
367
367
|
if (slotsRes && slotsRes.ok && slotsRes.slots) {
|
|
368
368
|
const meta = slotsRes.slots.meta || {};
|
|
369
369
|
// 用后端返回的生效顺序;private 恒末尾
|
|
@@ -1088,7 +1088,7 @@
|
|
|
1088
1088
|
this.setStatus(!nowDisabled ? '✅ 已禁用 ' + slot + '(该槽位规则不再加载)' : '✅ 已启用 ' + slot);
|
|
1089
1089
|
this.publish();
|
|
1090
1090
|
try {
|
|
1091
|
-
const toggleRes = await dshgp_postJson('/api/git-
|
|
1091
|
+
const toggleRes = await dshgp_postJson('/api/git-audit/toggle-rule', { slot, disabled: !nowDisabled });
|
|
1092
1092
|
if (toggleRes && toggleRes.ok) {
|
|
1093
1093
|
void this.loadSlots(); // 后台重载对账(yml 解析结果)
|
|
1094
1094
|
} else {
|
package/lib/client.js
CHANGED
|
@@ -1828,7 +1828,7 @@ window.__ModuleLoader__.load({
|
|
|
1828
1828
|
this.slotError = '';
|
|
1829
1829
|
this.publish();
|
|
1830
1830
|
try {
|
|
1831
|
-
const slotsRes = await dshgp_getJson('/api/git-
|
|
1831
|
+
const slotsRes = await dshgp_getJson('/api/git-audit/rule-slots');
|
|
1832
1832
|
if (slotsRes && slotsRes.ok && slotsRes.slots) {
|
|
1833
1833
|
const meta = slotsRes.slots.meta || {};
|
|
1834
1834
|
// 用后端返回的生效顺序;private 恒末尾
|
|
@@ -2553,7 +2553,7 @@ window.__ModuleLoader__.load({
|
|
|
2553
2553
|
this.setStatus(!nowDisabled ? '✅ 已禁用 ' + slot + '(该槽位规则不再加载)' : '✅ 已启用 ' + slot);
|
|
2554
2554
|
this.publish();
|
|
2555
2555
|
try {
|
|
2556
|
-
const toggleRes = await dshgp_postJson('/api/git-
|
|
2556
|
+
const toggleRes = await dshgp_postJson('/api/git-audit/toggle-rule', { slot, disabled: !nowDisabled });
|
|
2557
2557
|
if (toggleRes && toggleRes.ok) {
|
|
2558
2558
|
void this.loadSlots(); // 后台重载对账(yml 解析结果)
|
|
2559
2559
|
} else {
|
package/lib/commit-push.js
CHANGED
|
@@ -8,7 +8,10 @@
|
|
|
8
8
|
* 自动推送带审计门禁(blocker 拦截 + 敏感扫描 + .gitignore),不再裸 commit+push
|
|
9
9
|
* 返回结构含 audit 摘要,调用方(工具/外部插件)可据此判断「被阻断」。
|
|
10
10
|
*/
|
|
11
|
-
|
|
11
|
+
// 审计的结果文案改由「预处理能力」渲染(lib/preprocess/):git 侧只留兜底逻辑与中性默认文案。
|
|
12
|
+
// 为什么 git 侧不再自己生成这份指引:那是**审计措辞**(查询用哪个 API、明细去哪看),
|
|
13
|
+
// 属于审计预处理自己的语义,搬进 lib/preprocess/audit.js 的 renderResult 里。
|
|
14
|
+
import { renderPreprocessResult } from './preprocess/index.js';
|
|
12
15
|
|
|
13
16
|
// 审计内核(auditWithScope / scoreQuality)不再在本文件直接 import —— 提交门禁改为
|
|
14
17
|
// 调「可配置的审计引擎子进程」(lib/commit-push/pre-commit-engine.js),这是解耦点:
|
|
@@ -22,6 +25,33 @@ import { MAX_MSG_PREVIEW } from './app/constants.js';
|
|
|
22
25
|
import { isSampleExemptDir } from './exempt/index.js';
|
|
23
26
|
import { resolveRepoVisibility } from './git/index.js';
|
|
24
27
|
|
|
28
|
+
/**
|
|
29
|
+
* 预处理渲染的**兜底文案**(刻意留在 git 侧)。
|
|
30
|
+
*
|
|
31
|
+
* 为什么在 git 侧而不是预处理里:预处理可能不可用、没实现 `renderResult`、甚至渲染时抛错,
|
|
32
|
+
* 这时代码仍在 git 侧往下走 —— 兜底是 git 侧的安全网,不能依赖被兜底对象自己提供。
|
|
33
|
+
* 为什么措辞中性(写「提交前检查」而不是「审计」):具体措辞属预处理的语义,
|
|
34
|
+
* 已搬进 lib/preprocess/audit.js;这里只保证「有 blocker 时能说清是哪几处」。
|
|
35
|
+
* @param {object} ctx 与 renderPreprocessResult 同一个 ctx
|
|
36
|
+
* @returns {{error?: string, apiGuide: string, notes: {exempt: string, privateExempt: string}}}
|
|
37
|
+
*/
|
|
38
|
+
export function defaultPreprocessRender(ctx = {}) {
|
|
39
|
+
const blocked = Array.isArray(ctx.blocked) ? ctx.blocked : [];
|
|
40
|
+
const list = blocked.map((finding) => {
|
|
41
|
+
const where = finding.file ? ` ${finding.file}` + (finding.line ? `:${finding.line}` : '') : '';
|
|
42
|
+
const why = finding.rule || finding.message || '';
|
|
43
|
+
return where + (why ? `(${why})` : '');
|
|
44
|
+
});
|
|
45
|
+
return {
|
|
46
|
+
error: blocked.length ? `提交前检查拦截:${blocked.length} 项 → ${list.join(';')}` : undefined,
|
|
47
|
+
apiGuide: '',
|
|
48
|
+
notes: {
|
|
49
|
+
exempt: '本次提交的临时豁免(不落盘、不影响后续提交)',
|
|
50
|
+
privateExempt: '私有库:检查结果只报告不拦截',
|
|
51
|
+
},
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
|
|
25
55
|
/**
|
|
26
56
|
* 同步执行审计门禁(不跑 git)。供 git_commit_push 后台化方案复用:审计同步即时
|
|
27
57
|
* 拦截,通过后再把 commit+push 丢后台。返回 { ok, blocked?, error?, audit }。
|
|
@@ -79,9 +109,6 @@ export async function runAudit({ repoPath = '', audit, rulesetDir, slots, cfg: e
|
|
|
79
109
|
blocked: engineRes.engine?.exitCode === 1,
|
|
80
110
|
},
|
|
81
111
|
};
|
|
82
|
-
// 审计输出改为「级别数量 + 评分 + API 查询用法」——审计明细由聚合 API
|
|
83
|
-
// (/api/git-push/audit)查询,不再内联 findings 全文;blocked 摘要保留(拦截必需)。
|
|
84
|
-
auditOut.apiGuide = buildAuditApiGuide(repoPath, { scope: engineAudit.scope, summary: engineAudit.summary, quality: auditOut.quality });
|
|
85
112
|
// 本次提交的按文件临时豁免(auditExemptPaths):列入的文件 finding 一律不参与拦截判定(含 blocker),
|
|
86
113
|
// 仅本次有效、不落盘、不改 .auditignore;评分仍用全量 findings(豁免不影响打分基数)。
|
|
87
114
|
// 语义按需求方定稿:豁免即豁免,不设「只允许 warning/notice」的限制,也不按规则类别过滤。
|
|
@@ -100,9 +127,30 @@ export async function runAudit({ repoPath = '', audit, rulesetDir, slots, cfg: e
|
|
|
100
127
|
count: exemptFindings.length,
|
|
101
128
|
rules: [...new Set(exemptFindings.map((f) => f.rule).filter(Boolean))],
|
|
102
129
|
...(exemptReason ? { reason: String(exemptReason) } : {}),
|
|
103
|
-
note
|
|
130
|
+
// note 由预处理渲染填(见下方 renderPreprocessResult);这里不写死措辞
|
|
104
131
|
};
|
|
105
132
|
}
|
|
133
|
+
// ── 结果文案:交给「可用预处理」渲染,git 侧只保留兜底 ──
|
|
134
|
+
// 数据契约(ctx):repoPath + audit{summary,quality,findings,scope,files} + blocked + exempt
|
|
135
|
+
// 兜底:预处理不可用 / 没实现 renderResult / 渲染抛错 时用中性默认(defaultRenderResult),
|
|
136
|
+
// 保证「预处理不给也不崩」——但默认文案刻意不含审计措辞(那属预处理语义)。
|
|
137
|
+
const renderCtx = {
|
|
138
|
+
repoPath,
|
|
139
|
+
audit: {
|
|
140
|
+
summary: engineAudit.summary,
|
|
141
|
+
quality: auditOut.quality,
|
|
142
|
+
findings,
|
|
143
|
+
scope: engineAudit.scope,
|
|
144
|
+
files: engineAudit.files,
|
|
145
|
+
},
|
|
146
|
+
blocked: auditOut.blocked,
|
|
147
|
+
...(auditOut.exempt ? { exempt: auditOut.exempt } : {}),
|
|
148
|
+
};
|
|
149
|
+
const fallbackRender = defaultPreprocessRender(renderCtx);
|
|
150
|
+
const rendered = renderPreprocessResult(renderCtx, cfg);
|
|
151
|
+
auditOut.apiGuide = rendered?.apiGuide ?? fallbackRender.apiGuide;
|
|
152
|
+
if (auditOut.exempt) auditOut.exempt.note = rendered?.notes?.exempt ?? fallbackRender.notes.exempt;
|
|
153
|
+
|
|
106
154
|
if (blocked.length > 0) {
|
|
107
155
|
// 【修复】私有库豁免(README「④ 私有库豁免」):远端可见性 = private → 审计只报告不拦截。
|
|
108
156
|
// 修复背景:私有库被拦的回归——
|
|
@@ -124,19 +172,16 @@ export async function runAudit({ repoPath = '', audit, rulesetDir, slots, cfg: e
|
|
|
124
172
|
auditOut.privateExempt = {
|
|
125
173
|
visibility,
|
|
126
174
|
blockedCount: blocked.length,
|
|
127
|
-
note:
|
|
175
|
+
note: rendered?.notes?.privateExempt ?? fallbackRender.notes.privateExempt,
|
|
128
176
|
};
|
|
129
177
|
return { ok: true, audit: auditOut };
|
|
130
178
|
}
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
const why = f.rule || f.message || '';
|
|
134
|
-
return where + (why ? `(${why})` : '');
|
|
135
|
-
});
|
|
179
|
+
// 拦截文案由预处理渲染(含「几个 blocker + 逐条位置原因」);
|
|
180
|
+
// `blocked: true` 这个**布尔**留在 git 侧——它决定 job 状态分叉(被拦截 ≠ 执行失败)。
|
|
136
181
|
return {
|
|
137
182
|
ok: false,
|
|
138
183
|
blocked: true,
|
|
139
|
-
error:
|
|
184
|
+
error: rendered?.error ?? fallbackRender.error ?? `提交前检查拦截:${blocked.length} 项`,
|
|
140
185
|
audit: auditOut,
|
|
141
186
|
};
|
|
142
187
|
}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 预处理能力 · 审计(提交前审计)
|
|
3
|
+
*
|
|
4
|
+
* 「预处理」是一类**由外部能力贡献给 git 侧**的东西(提交前检查、结果文案、工具参数),
|
|
5
|
+
* git 侧只认契约、不认实现。本文件是审计这一个预处理的**全部贡献面**,三项能力同处一处:
|
|
6
|
+
*
|
|
7
|
+
* params : 它给 git 侧工具贡献的参数(不可用时不出现)
|
|
8
|
+
* enabled : 可用性判据(**功能在不在**,不是「默认跑不跑」——后者是 cfg.auditEnabled)
|
|
9
|
+
* renderResult : 它自己的结果文案(拦截原因 / 查询指引 / 回显 note)
|
|
10
|
+
*
|
|
11
|
+
* 为什么文案要由审计方渲染(而不是 git 侧硬编码):文案是**审计语义**的一部分
|
|
12
|
+
* (「几个 blocker」「查询用哪个 API」「私有库只报告不拦截」),git 侧一旦写死,
|
|
13
|
+
* 将来审计拆成独立项目、换引擎、甚至换语言,git 侧都得跟着改文案。
|
|
14
|
+
*
|
|
15
|
+
* 但有三样**刻意留在 git 侧**,不要搬进来(见 lib/preprocess/index.js 的注释与 SPEC §十四):
|
|
16
|
+
* ① `blocked` 布尔(job 状态分叉「被拦截 ≠ 执行失败」);
|
|
17
|
+
* ② 引擎 spawn 失败的文案(审计引擎不知道自己没被找到);
|
|
18
|
+
* ③ 兜底默认文案(预处理不给 renderResult 时不能崩)。
|
|
19
|
+
*/
|
|
20
|
+
import { existsSync } from 'node:fs';
|
|
21
|
+
import { join } from 'node:path';
|
|
22
|
+
|
|
23
|
+
import { PLUGIN_ROOT } from '../core/config.js';
|
|
24
|
+
import { buildAuditApiGuide } from '../app/inject-text.js';
|
|
25
|
+
|
|
26
|
+
/** 预处理 id(与 cfg / 日志 / 未来多预处理并存时的标识)。 */
|
|
27
|
+
export const AUDIT_PREPROCESS_ID = 'audit';
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* 审计预处理是否**可用**(可用才让它的参数进入工具签名)。
|
|
31
|
+
*
|
|
32
|
+
* 判据刻意不看 `cfg.auditEnabled`:后者只是「默认跑不跑」的开关(缺省 false),
|
|
33
|
+
* 而「工具签名里该不该出现 audit 参数」取决于**审计这个预处理动作在不在**。
|
|
34
|
+
* 用户关掉 auditEnabled 之后仍可能想临时传 `--audit` 跑一次,此时参数必须还在。
|
|
35
|
+
* @param {object} [cfg] 插件配置(`preCommit.command` 配了自定义引擎即视为可用)
|
|
36
|
+
* @param {boolean} [hasBuiltinEngine] 仅供测试注入「内置引擎是否存在」
|
|
37
|
+
* @returns {boolean}
|
|
38
|
+
*/
|
|
39
|
+
export function auditPreprocessAvailable(cfg = {}, hasBuiltinEngine) {
|
|
40
|
+
if (cfg && cfg.preCommit && cfg.preCommit.command) return true; // 自定义引擎
|
|
41
|
+
const builtin = typeof hasBuiltinEngine === 'boolean'
|
|
42
|
+
? hasBuiltinEngine
|
|
43
|
+
: existsSync(join(PLUGIN_ROOT, 'scripts', 'audit-gate.mjs'));
|
|
44
|
+
return builtin;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/** 审计专属参数——由审计预处理贡献给 git 侧工具;不可用时不出现在签名里。 */
|
|
48
|
+
export const AUDIT_COMMIT_PARAMS = [
|
|
49
|
+
{ flag: 'audit', type: 'boolean', desc: '提交前审计(默认取配置)' },
|
|
50
|
+
{ flag: 'auditExemptPaths', type: 'array', desc: '本次提交按文件临时豁免审计(数组,相对仓库根):所列文件的 finding 不参与拦截判定(含 blocker);仅本次有效,不落盘、不改 .auditignore' },
|
|
51
|
+
{ flag: 'auditExemptReason', type: 'string', desc: '豁免理由(可选,仅回显,不作拦截条件)' },
|
|
52
|
+
];
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* 把 blocked 列表格式化成可读的「位置(原因)」串。
|
|
56
|
+
* 与历史文案逐字一致(` file:line(rule)`)——这是拦截信息的唯一可读面,改动要慎重。
|
|
57
|
+
* @param {Array<{file?:string,line?:number,rule?:string,message?:string}>} blocked
|
|
58
|
+
* @returns {string[]}
|
|
59
|
+
*/
|
|
60
|
+
function formatBlocked(blocked = []) {
|
|
61
|
+
return blocked.map((finding) => {
|
|
62
|
+
const where = finding.file ? ` ${finding.file}` + (finding.line ? `:${finding.line}` : '') : '';
|
|
63
|
+
const why = finding.rule || finding.message || '';
|
|
64
|
+
return where + (why ? `(${why})` : '');
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* 渲染审计结果文案(预处理的第三项能力)。
|
|
70
|
+
*
|
|
71
|
+
* `ctx` 由 git 侧传入,含 `{ repoPath, audit:{summary,quality,findings,scope,files}, blocked, exempt?, privateExempt? }`
|
|
72
|
+
* —— 这是**数据契约**:预处理只读这些字段,不查仓库、不碰网络、不读配置。
|
|
73
|
+
* 返回的三项都可选:不提供即由 git 侧的兜底补上(保证预处理缺项时不崩)。
|
|
74
|
+
* @param {object} ctx
|
|
75
|
+
* @returns {{error?: string, apiGuide?: string, notes?: {exempt?: string, privateExempt?: string}}}
|
|
76
|
+
*/
|
|
77
|
+
export function auditRenderResult(ctx = {}) {
|
|
78
|
+
const blocked = Array.isArray(ctx.blocked) ? ctx.blocked : [];
|
|
79
|
+
const audit = ctx.audit || {};
|
|
80
|
+
return {
|
|
81
|
+
// 拦截文案:只在真有 blocker 时给(放行时不该出现「拦截」字样)
|
|
82
|
+
error: blocked.length ? `审计拦截:${blocked.length} 个 blocker → ${formatBlocked(blocked).join(';')}` : undefined,
|
|
83
|
+
// 查询指引:明细走聚合 API(不内联 findings 全文)
|
|
84
|
+
apiGuide: buildAuditApiGuide(ctx.repoPath || '', { scope: audit.scope, summary: audit.summary, quality: audit.quality }),
|
|
85
|
+
notes: {
|
|
86
|
+
exempt: '本次提交临时豁免(不落盘、不影响后续提交);评分仍按全量 findings 计算',
|
|
87
|
+
privateExempt: 'private-repo-report-only(私有库豁免:审计只报告不拦截,明细仍见 blocked)',
|
|
88
|
+
},
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/** 审计预处理的注册形态(三项能力同处一处,供 lib/preprocess/index.js 汇总)。 */
|
|
93
|
+
export const auditPreprocess = {
|
|
94
|
+
id: AUDIT_PREPROCESS_ID,
|
|
95
|
+
params: AUDIT_COMMIT_PARAMS,
|
|
96
|
+
enabled: auditPreprocessAvailable,
|
|
97
|
+
renderResult: auditRenderResult,
|
|
98
|
+
};
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 预处理能力汇总层(git 侧只与这一层打交道)
|
|
3
|
+
*
|
|
4
|
+
* 「预处理」= 提交前要跑的外部能力(当前只有审计;将来可能还有 lint / 类型检查 / 安全扫描)。
|
|
5
|
+
* 每个预处理贡献三项能力(见 ./audit.js 头部注释):`params` / `enabled` / `renderResult`。
|
|
6
|
+
* git 侧不 import 任何具体预处理的实现,只调用本层的三个函数 —— 这样加/去掉一个预处理时,
|
|
7
|
+
* git 侧只需改配置或注册表,不用改代码路径。
|
|
8
|
+
*
|
|
9
|
+
* ── 三样刻意留在 git 侧,**不要**搬进预处理(搬了就会出真问题)──
|
|
10
|
+
* ① **`blocked` 布尔**:`lib/app/tool-call.js` 的 `pushJobOutcome` 用它决定
|
|
11
|
+
* 「未推送(被拦截)」还是「未完成:<原因>」——这是「被拦截 ≠ 执行失败」的语义分叉,
|
|
12
|
+
* 属 job 状态机,与审计判定无关。预处理只给文案,不决定 job 状态。
|
|
13
|
+
* ② **引擎 spawn 失败文案**:`lib/commit-push/pre-commit-engine.js` 里的
|
|
14
|
+
* 「找不到引擎命令 / 引擎不可用」。引擎自己没被找到时根本不会执行,
|
|
15
|
+
* 它无法生成「我没被找到」这句话 —— 只有拉起它的 git 侧知道。
|
|
16
|
+
* ③ **兜底默认文案**:预处理可能不可用、可能没实现 renderResult、可能抛错,
|
|
17
|
+
* git 侧必须有一份中性兜底(`lib/commit-push.js` 的 `defaultPreprocessRender`),
|
|
18
|
+
* 保证**不崩、不静默丢信息**。本层只负责「合并谁的渲染结果」,不提供兜底文案。
|
|
19
|
+
*/
|
|
20
|
+
|
|
21
|
+
import { auditPreprocess, auditPreprocessAvailable, AUDIT_COMMIT_PARAMS } from './audit.js';
|
|
22
|
+
|
|
23
|
+
/** 已注册的预处理(当前只有审计;新增时在这里追加,git 侧零改动)。 */
|
|
24
|
+
export const PREPROCESSORS = [auditPreprocess];
|
|
25
|
+
|
|
26
|
+
// 供 command-registry 等历史调用方按原路径继续引用(参数与可用性判据的公开面不变)
|
|
27
|
+
export { auditPreprocess, auditPreprocessAvailable, AUDIT_COMMIT_PARAMS };
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* 汇总所有**可用**预处理贡献的参数。
|
|
31
|
+
* @param {object} [cfg] 插件配置
|
|
32
|
+
* @param {boolean} [hasBuiltinEngine] 仅供测试注入
|
|
33
|
+
* @param {Array} [preprocessors] 预处理列表(测试可注入)
|
|
34
|
+
* @returns {Array} 参数 schema 数组
|
|
35
|
+
*/
|
|
36
|
+
export function preprocessParams(cfg = {}, hasBuiltinEngine, preprocessors = PREPROCESSORS) {
|
|
37
|
+
const out = [];
|
|
38
|
+
for (const pp of preprocessors) {
|
|
39
|
+
const enabled = typeof pp.enabled === 'function' ? pp.enabled(cfg, hasBuiltinEngine) : true;
|
|
40
|
+
if (!enabled) continue;
|
|
41
|
+
if (Array.isArray(pp.params)) out.push(...pp.params);
|
|
42
|
+
}
|
|
43
|
+
return out;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* 让**可用**的预处理渲染自己的结果文案。
|
|
48
|
+
*
|
|
49
|
+
* 合并策略:按注册顺序取第一个提供 `renderResult` 的预处理的结果;
|
|
50
|
+
* 多项都提供时逐字段后者覆盖前者(`error` / `apiGuide` / `notes` 各自独立)。
|
|
51
|
+
* 为什么不是"第一个非空就停":`notes` 可能只有某一个预处理提供,逐字段合并更不容易丢信息。
|
|
52
|
+
* 失败策略:任何预处理抛错都**吞掉并继续**——渲染文案失败绝不能把提交门禁带崩
|
|
53
|
+
* (判定已经做完了,这里只是措辞)。
|
|
54
|
+
* @param {object} ctx 数据契约见 lib/preprocess/audit.js 的 auditRenderResult
|
|
55
|
+
* @param {object} [cfg] 插件配置
|
|
56
|
+
* @param {Array} [preprocessors] 预处理列表(测试可注入,传 [] 可验证兜底)
|
|
57
|
+
* @returns {{error?: string, apiGuide?: string, notes?: object}|undefined}
|
|
58
|
+
*/
|
|
59
|
+
export function renderPreprocessResult(ctx = {}, cfg = {}, preprocessors = PREPROCESSORS) {
|
|
60
|
+
let merged;
|
|
61
|
+
for (const pp of preprocessors) {
|
|
62
|
+
const enabled = typeof pp.enabled === 'function' ? pp.enabled(cfg) : true;
|
|
63
|
+
if (!enabled) continue;
|
|
64
|
+
if (typeof pp.renderResult !== 'function') continue;
|
|
65
|
+
let partial;
|
|
66
|
+
try {
|
|
67
|
+
partial = pp.renderResult(ctx);
|
|
68
|
+
} catch {
|
|
69
|
+
continue; // 渲染失败不阻断:留给兜底文案
|
|
70
|
+
}
|
|
71
|
+
if (!partial || typeof partial !== 'object') continue;
|
|
72
|
+
merged = merged || {};
|
|
73
|
+
if (partial.error !== undefined) merged.error = partial.error;
|
|
74
|
+
if (partial.apiGuide !== undefined) merged.apiGuide = partial.apiGuide;
|
|
75
|
+
if (partial.notes && typeof partial.notes === 'object') merged.notes = { ...(merged.notes || {}), ...partial.notes };
|
|
76
|
+
}
|
|
77
|
+
return merged;
|
|
78
|
+
}
|
package/lib/self/index.js
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
|
|
12
|
-
export const VERSION = '2.20.
|
|
12
|
+
export const VERSION = '2.20.19'; // 2.20.17:修桌面端(dsh-app://)所有写接口 403 NO_ORIGIN + 本地列表超时改预算传播 + 放行判据加固。① 桌面壳 forwardWebRequest 转发 /api/* 时显式剥离 Origin,checkOrigin 对无 Origin 的写请求一律拒,导致设置页所有保存/开关/按钮失效且不留日志 → 无 Origin 时要求「Content-Type=application/json + 本机来源」同时成立才放行;② 本机判定以 TCP 对端地址(socket.remoteAddress,内核给出不可伪造)为准,Host 仅在拿不到 socket 时兜底——只信 Host 会被 `Host: 127.0.0.1` 伪造绕过;isLoopbackHost 补裸 IPv6 与 ::ffff: 映射形态;③ 恢复 403 拒绝日志 http-rejects.log(query 凭据键打码);④ settings-set 凭据类回显改「(已保存)」;⑤ 前端保存先 await 写入结果再提示;⑥ clone-progress 改 GET 轮询;⑦ 本地列表 SSH 探测改为预算传播(每步 timeoutMs = min(单步上限, 剩余预算)),扫描长轮询 60s→20s、前端单请求 25s,轮次耗尽不再误报「扫描完成」。历史:2.20.15:
|
|
13
13
|
// 实测后果:该目录有 package.json ⇒ npm 去打包整棵 DSH 树、输出 2.1MB > spawnSync 默认 maxBuffer 1MB ⇒ ENOBUFS(npm_publish 的体检与真发全部失败);
|
|
14
14
|
// 该目录没有 package.json 时报 ENOENT。现 publish 的两个调用点显式传 cwd=目标包目录,并给 runNpm 加 16MB maxBuffer。
|
|
15
15
|
// 2.8.3:文案修正——「零改动 / 无新提交」明确为**正常成功路径**(注入用法、工具描述、README、skill 同批改),并修 job 输出自相矛盾(cleanSkipCommit 路径补 committed:false,不再显示「已提交,未推送」)
|
package/package.json
CHANGED
|
@@ -324,6 +324,11 @@ pnpm add github:EIGHTfs/dsh-git-push#<commit>
|
|
|
324
324
|
| 函数/复杂度被报为 blocker | 规则 `severity` 是上限,检查器不越级;报 blocker 说明 yml 里写的就是 error/blocker |
|
|
325
325
|
| 克隆大文件反复失败 | 失败项的分片必须保留(`.dsh-parts`)才能跨轮 Range 续传;同轮清理分片会让大文件永远从 0 重来 |
|
|
326
326
|
| **桌面端(`dsh-app://`)设置页保存全部失效、GET 正常** | 桌面壳 `forwardWebRequest` 转发 `/api/*` 时**显式剥离 Origin**(`headers.delete('origin')`,只补 cookie),插件写请求鉴权对无 Origin 一律 403。2.20.17 起放行「无 Origin + `Content-Type: application/json` + **本机来源**」,本机判定以 TCP 对端地址(`req.socket.remoteAddress`)为准、`Host` 只做兜底——`Host` 可被客户端伪造(`Host: 127.0.0.1`),且实测某些转发链路会丢 Host;仍不通就看 `<DSH_HOME>/git-push/http-rejects.log`(2.20.17 恢复,记 method/url/origin/host/code);**排查前先完全退出应用重开**——见下一行 |
|
|
327
|
+
| **`npm publish` 回了成功,但 registry 上查不到新版本** | **不是失败**,是 registry 处理延迟(延迟窗口内 404 / 旧版本号 / `409 Cannot publish over previously staged version` 三者都**不是失败证据**)。判读依据与完整处置见通用 skill `npm-publish-checklist`(该坑已在那里记录两次,本行只做指向,避免两处真相)。**误判代价:多发一个版本号**(本插件 2.20.17→2.20.18 就是这么来的) |
|
|
328
|
+
| **批量改测试路径 / 合并测试文件后,用例数变少却全绿** | 四类「静默少注册」形态,全是「删了不报错、只会消失」:① `require2()` 等 `createRequire` 自定义 require 没跟着改深度 → 模块加载**中途抛错**,该行之后所有 `test()` 从未注册 ② `const HERE = dirname(...)` 这类**先取常量再 join** 的间接写法漏改 ③ `if (existsSync(p)) test(...)` 条件不成立 → 静默少一条(`readdirSync` 会抛错,`existsSync` 不会)④ 文件名不合 `test-*.mjs` 直接**不被扫描器收集**。⇒ 判据:**逐文件比 `test(` 静态计数**(不是看总数"差不多"),并让结构门禁拦「顶层存在非 `test-` 前缀的 `.mjs`」 |
|
|
329
|
+
| **用 `describe()` 包整个原文件体来合并测试** | 会改语义(实测 54 失败 / 少 17 条):`describe` 回调是 async 作用域,顶层 `test()` / `const` / `await` 全挪进回调后求值时机变了。⇒ 正确做法:**原样平铺**(`test()` 仍在模块顶层)+ 每个原文件体包一层 `{}` **块级作用域**(只隔同名声明,不改注册时机)。前置检查五项:顶层 `await` / `process.env`·`exitCode` 赋值 / `before`·`after` 钩子 / 顶层 `export`(包里直接 SyntaxError)/ 顶层声明同名 |
|
|
330
|
+
| **同一批测试里某文件单独跑过、夹在批次中间就红** | `run-tests` 每批 40 个文件跑在**同一进程**,某测试改了 `process.env` 又没还原会污染后续。⇒ spawn 子进程前**显式剔除**可疑变量(如 `for (const k of ['X','Y']) delete env[k]`),别靠调顺序或加大间隔 |
|
|
331
|
+
| **清理部署副本时删掉 `tools/` 导致某功能静默失效** | `tools/`(如 `tools/ruff`)是**部署方提供的运行必需二进制**,但不在 `files` 白名单里,所以会出现在 `sync_plugin` 的 `stale` 列表。代码是**自探测**设计(候选路径 → PATH 兜底),删了不报错、只是静默降级成「无该能力」。⇒ 清 stale 前先查该路径是否被代码引用(`grep PLUGIN_ROOT.*tools`),并把 `tools/` 列入保护名单 |
|
|
327
332
|
| **补丁改了不生效,误判「补丁无效」** | DSH 宿主的 HMR `profileRoots` 只收集**符号链接**形式的插件包;**复制安装(真实目录)** 的插件在插件页开关切换只重启 fiber,**ESM 缓存仍是旧代码**。⇒ 验证服务端补丁必须**完全退出应用重开**,否则会把「缓存没刷新」误判成「改错了」(外部报告实测踩到,2026-11-13 记入) |
|
|
328
333
|
| 建了远端但推送报「远端查不到分支 master(API 404 / ls-remote 无该分支)」 | `git_remote_create` 旧版把 origin 写成 **REST API 端点**(`https://api.github.com/repos/<o>/<r>` ✗ 那不是 git remote)⇒ `git push/fetch origin` 必然失败。2026-10-09 已修(`lib/git/remote.js`):origin 统一写 `https://github.com/<o>/<r>`,并**自愈**——仓库已存在但 origin 仍是 API 形态时 `set-url` 改回;返回体新增 `originAction`(`add`/`repair`/`keep`)。旧仓库手工修:`git remote set-url origin ssh://git@ssh.github.com:443/<o>/<r>.git` 再 `git push -u origin master`(凭据用插件 `id_rsa` + `-p 443`)。⚠️ `lib/git/clone.js` 仍写 API 形态 origin(设计如此,插件自身推送不受影响,但 `git push origin` 会失败) |
|
|
329
334
|
|