dsh-git-push 2.20.11 → 2.20.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -6
- package/cli-audit.mjs +141 -0
- package/cli-tool.mjs +86 -0
- package/cli.mjs +114 -335
- package/lib/app/command-registry.js +3 -2
- package/lib/app/constants.js +9 -0
- package/lib/app/handlers/clone.js +12 -3
- package/lib/app/handlers/http-constants.js +11 -2
- package/lib/app/handlers/npm.js +4 -2
- package/lib/app/handlers/repos.js +10 -1
- package/lib/app/handlers/settings.js +9 -1
- package/lib/app/http-handlers.js +24 -3
- package/lib/app/schema-audit.js +42 -0
- package/lib/app/schema.js +19 -19
- package/lib/app/settings-bridge.js +51 -0
- package/lib/app/tool-call.js +7 -5
- package/lib/audit-rules/audit-rules-paths.yml +7 -1
- package/lib/audit-ui-sdk/contract.js +117 -0
- package/lib/audit-ui-sdk/index.js +17 -0
- package/lib/checks/regex.js +6 -1
- package/lib/cli/commands-audit.mjs +12 -17
- package/lib/cli/commands-tool.mjs +93 -0
- package/lib/cli/commands-vcs.mjs +2 -1
- package/lib/cli/shared.mjs +448 -0
- package/lib/client-parts/{account.js → git/account.js} +1 -1
- package/lib/client-parts/{actions.js → git/actions.js} +26 -11
- package/lib/client-parts/{apply.js → git/apply.js} +1 -1
- package/lib/client-parts/{browser.js → git/browser.js} +1 -1
- package/lib/client-parts/{const.js → git/const.js} +6 -1
- package/lib/client-parts/{controller.js → git/controller.js} +23 -11
- package/lib/client-parts/{icons.js → git/icons.js} +1 -1
- package/lib/client-parts/{loader.js → git/loader.js} +1 -1
- package/lib/client-parts/{npm.js → git/npm.js} +1 -1
- package/lib/client-parts/{page.js → git/page.js} +11 -21
- package/lib/client-parts/{repo.js → git/repo.js} +1 -1
- package/lib/client-parts/{settings.js → git/settings.js} +1 -1
- package/lib/client-parts/{utils.js → git/utils.js} +1 -1
- package/lib/client.js +75 -354
- package/lib/commit-push/pre-commit-engine.js +388 -0
- package/lib/commit-push.js +42 -20
- package/lib/git/transport.js +31 -10
- package/lib/http/index.js +82 -10
- package/lib/npm/npmrc.js +22 -5
- package/lib/self/index.js +1 -1
- package/package.json +6 -2
- package/scripts/audit-gate.mjs +235 -0
- package/scripts/build-client.mjs +15 -8
- package/scripts/check.mjs +12 -3
- package/scripts/scan-file-io.mjs +5 -1
- package/scripts/scan-version.mjs +10 -7
- package/skills/dev/dsh-git-push.md +62 -0
- package/skills/guide/guide-audit.md +11 -11
- package/skills/guide/guide-cli-scripts.md +3 -3
- package/skills/guide/guide-commit-push.md +2 -2
- package/skills/guide/guide-inject-ui.md +0 -16
- package/assets/start.sh +0 -396
- package/scripts/scan-hardcoded-paths.mjs +0 -125
- /package/lib/client-parts/{audit.js → audit/audit.js} +0 -0
|
@@ -18,6 +18,9 @@ export function handleSettingsGet(ctx) {
|
|
|
18
18
|
return { status: 200, body: { ok: true, settings: redactConfig(snap || {}) } };
|
|
19
19
|
}
|
|
20
20
|
|
|
21
|
+
/** 凭据类设置键:写成功后的回显值必须脱敏(明文只留在 config.json 0600 与凭据文件)。 */
|
|
22
|
+
const SENSITIVE_SETTING_KEYS = new Set(['githubToken', 'sshPub', 'npmToken']);
|
|
23
|
+
|
|
21
24
|
/** POST /api/git-push/settings-set —— 写单个设置键(白名单防越权)。 */
|
|
22
25
|
export async function handleSettingsSet(ctx) {
|
|
23
26
|
const { body, env, cfg } = ctx;
|
|
@@ -58,5 +61,10 @@ export async function handleSettingsSet(ctx) {
|
|
|
58
61
|
} catch (e) {
|
|
59
62
|
log?.warn?.(`settings-set cfg 同步跳过:${e?.message || e}`);
|
|
60
63
|
}
|
|
61
|
-
|
|
64
|
+
// 回显脱敏:凭据类键**不回传明文**(与 README「接口不回传明文」一致)。
|
|
65
|
+
// 写成功与否由 ok 字段表达;前端 save() 只看 ok,不依赖回显值回填输入框。
|
|
66
|
+
const echoValue = SENSITIVE_SETTING_KEYS.has(key)
|
|
67
|
+
? (String(body.value ?? '').trim() ? '(已保存)' : '(空)')
|
|
68
|
+
: body.value;
|
|
69
|
+
return { status: 200, body: { ok: true, key, value: echoValue, note: '设置已写入插件私有配置(config.json)' } };
|
|
62
70
|
}
|
package/lib/app/http-handlers.js
CHANGED
|
@@ -33,6 +33,7 @@ import {
|
|
|
33
33
|
import {
|
|
34
34
|
handleNpmAccount, handleNpmCheck, handleNpmOwned, handleNpmPackages, handleNpmInstall, handleNpmPublish,
|
|
35
35
|
} from './handlers/npm.js';
|
|
36
|
+
import { appendHttpRejectLog } from './settings-bridge.js';
|
|
36
37
|
/** 规则槽位清单对外导出(实现迁至 handlers/meta.js)。 */
|
|
37
38
|
export { listRuleSlots } from './handlers/meta.js';
|
|
38
39
|
|
|
@@ -47,7 +48,11 @@ export async function adaptHttpHandler(req, res, env, cfg) {
|
|
|
47
48
|
body = await new Promise((resolve) => readJsonBody(req, resolve));
|
|
48
49
|
}
|
|
49
50
|
const httpResult = await handleHttp(
|
|
50
|
-
{
|
|
51
|
+
{
|
|
52
|
+
method: req?.method, url: req?.url, origin: req?.headers?.origin, headers: req?.headers, body,
|
|
53
|
+
// TCP 对端地址:无 Origin 判据以它定论(Host 头可伪造、且转发链路可能丢 Host)
|
|
54
|
+
remoteAddress: req?.socket?.remoteAddress || '',
|
|
55
|
+
},
|
|
51
56
|
env,
|
|
52
57
|
cfg,
|
|
53
58
|
);
|
|
@@ -91,8 +96,24 @@ function buildCtx(req, method, env, cfg, query, body, path) {
|
|
|
91
96
|
*/
|
|
92
97
|
export async function handleHttp(req = {}, env = {}, cfg = defaultConfig()) {
|
|
93
98
|
const method = String(req.method || 'GET').toUpperCase();
|
|
94
|
-
|
|
95
|
-
|
|
99
|
+
// content-type 一并传入:桌面端(dsh-app://)转发**显式剥离 Origin**(桌面壳
|
|
100
|
+
// forwardWebRequest 里 headers.delete('origin')),只补 cookie。若不把 Content-Type
|
|
101
|
+
// 传进来,设置页的所有保存/开关/按钮在桌面版恒 403,而 GET 免校验照常——
|
|
102
|
+
// 表现为「页面能打开、保存永不生效」,且拒绝发生在 handler 之前连日志都不留。
|
|
103
|
+
// 放行判据见 checkOrigin:无 Origin 时要求 JSON CT + 回环 Host 同时成立。
|
|
104
|
+
// remoteAddress 一并传入:无 Origin 时的「是否本机」判定**以 TCP 对端地址为准**
|
|
105
|
+
// —— Host 头可被客户端伪造(`Host: 127.0.0.1`),socket 地址不可伪造。
|
|
106
|
+
const remoteAddress = req.remoteAddress || req.socket?.remoteAddress || '';
|
|
107
|
+
const originCheck = checkOrigin(method, req.origin, undefined, req.headers?.host, req.headers?.['content-type'], remoteAddress);
|
|
108
|
+
if (!originCheck.ok) {
|
|
109
|
+
// 拒绝留痕:403 发生在任何 handler 之前,不写这条日志就完全静默——
|
|
110
|
+
// 用户只看到「保存失败」,排查者也没有任何线索(外部 issue 正是这么卡住的)。
|
|
111
|
+
appendHttpRejectLog({
|
|
112
|
+
method, url: req.url, origin: req.origin, host: req.headers?.host,
|
|
113
|
+
code: originCheck.code, status: originCheck.status,
|
|
114
|
+
}, env);
|
|
115
|
+
return { status: originCheck.status, body: { ok: false, ...originCheck } };
|
|
116
|
+
}
|
|
96
117
|
const sizeCheck = checkBodySize(Number(req.headers?.['content-length']) || 0);
|
|
97
118
|
if (!sizeCheck.ok) return { status: sizeCheck.status, body: { ok: false, ...sizeCheck } };
|
|
98
119
|
const path = String(req.url || '/').split('?')[0];
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 插件入口层 · 配置 schema(审计侧)
|
|
3
|
+
*
|
|
4
|
+
* 为什么单独成文件(2026-11-08 UI 与审计解耦 · 文件隔离阶段):
|
|
5
|
+
* 审计与 git 侧计划重构成两个独立项目,本阶段先把**文件边界**划清——
|
|
6
|
+
* 审计相关设置键集中在本文件,git / 发布侧的键留在 `schema.js`。
|
|
7
|
+
* 行为完全不变:`schema.js` 用 `...auditConfigShape(Schema)` 展开合并,
|
|
8
|
+
* 产出的仍是同一个 Config 对象(同一批键、同一批默认值)。
|
|
9
|
+
*
|
|
10
|
+
* 边界判据:键的语义属于「静态检查 / 规则 / 评分 / 措辞」即归审计侧;
|
|
11
|
+
* 属于「扫描仓库 / 克隆 / 推送 / 凭据 / 注入」留在 schema.js。
|
|
12
|
+
* `injectRequirements` 归审计侧:它是「提交前审计」的子开关(注入开发者要求清单)。
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
/** 全量审计文件数上限默认值(0=不限)。 */
|
|
16
|
+
const DEFAULT_MAX_SCAN_FILES = 3000;
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* 审计侧配置键形状。
|
|
20
|
+
* @param {object} Schema schemastery(或 makeFallbackSchema 兜底实现)
|
|
21
|
+
* @returns {object} 键名 → schema 字段
|
|
22
|
+
*/
|
|
23
|
+
export function auditConfigShape(Schema) {
|
|
24
|
+
return {
|
|
25
|
+
auditEnabled: Schema.boolean().default(false).description('提交前审计(默认关)'),
|
|
26
|
+
// 提交前审计的子开关:开启后在系统提示词注入「开发者特殊要求」清单全文,AI 常驻可见、
|
|
27
|
+
// 不必等门禁拦截才去读清单(省一次失败的工具往返)。auditEnabled 关闭时本项不生效。
|
|
28
|
+
maxScanFiles: Schema.number().default(DEFAULT_MAX_SCAN_FILES).description('全量审计文件数上限(0=不限);超限按变动文件优先截断,防止弱机扫大仓卡死'),
|
|
29
|
+
injectRequirements: Schema.boolean().default(false).description('注入开发者要求清单到系统提示词(可直接勾选;父开关「提交前审计」关闭时置灰且不注入,勾选保留;默认关)'),
|
|
30
|
+
auditScanScope: Schema.string().default('diff').description('diff | full'),
|
|
31
|
+
auditRuleOrder: Schema.array(Schema.string()).default([]).description('规则槽位加载顺序(后加载覆盖先加载;空=默认偏好顺序;private 恒末尾强制)'),
|
|
32
|
+
auditDisabledSlots: Schema.array(Schema.string()).default([]).description('UI 禁用的规则槽位(设置页单击切换;nodejs/private 安全红线不可禁用)'),
|
|
33
|
+
weightOverrides: Schema.string().default('').description('权重覆盖 JSON(如 {"安全性":100},空=默认权重表)'),
|
|
34
|
+
linkCheckEnabled: Schema.boolean().default(false).description('链接检查(默认关,需网络)'),
|
|
35
|
+
commentWordingEnabled: Schema.boolean().default(true).description('提交信息措辞检查'),
|
|
36
|
+
commentWordingCustom: Schema.string().default('').description('自定义措辞规则'),
|
|
37
|
+
commentWordingRulesFile: Schema.string().default('').description('措辞规则文件路径'),
|
|
38
|
+
commentWordingRulesUrl: Schema.string().default('').description('措辞规则 URL'),
|
|
39
|
+
auditRuleWeights: Schema.dict(Schema.any()).default({}).description('规则权重({ blacklist: { pattern: weight } })'),
|
|
40
|
+
qualityWeights: Schema.dict(Schema.number()).default({}).description('质量维度权重覆盖({ 维度名: weight })'),
|
|
41
|
+
};
|
|
42
|
+
}
|
package/lib/app/schema.js
CHANGED
|
@@ -9,6 +9,11 @@
|
|
|
9
9
|
|
|
10
10
|
import { createRequire } from 'node:module';
|
|
11
11
|
|
|
12
|
+
// 审计侧设置键单独成文件(文件隔离阶段;展开合并后仍是同一个 Config 对象)
|
|
13
|
+
import { auditConfigShape } from './schema-audit.js';
|
|
14
|
+
// 引擎默认超时取单一来源(与运行期兜底共用),避免 schema 默认值漂移
|
|
15
|
+
import { PRE_COMMIT_TIMEOUT_MS_DEFAULT } from './constants.js';
|
|
16
|
+
|
|
12
17
|
/**
|
|
13
18
|
* schemastery 条件加载(peerDependency 由 DSH 宿主提供):
|
|
14
19
|
* - DSH 插件运行期:宿主 node_modules 提供 → 用真实 Schema(Standard Schema v1)
|
|
@@ -17,9 +22,6 @@ import { createRequire } from 'node:module';
|
|
|
17
22
|
*/
|
|
18
23
|
const require2 = createRequire(import.meta.url);
|
|
19
24
|
|
|
20
|
-
/* ───────── 配置默认值常量 ───────── */
|
|
21
|
-
const DEFAULT_MAX_SCAN_FILES = 3000; // 全量审计文件数上限默认值
|
|
22
|
-
|
|
23
25
|
let Schema = null;
|
|
24
26
|
|
|
25
27
|
try {
|
|
@@ -52,6 +54,10 @@ function makeFallbackSchema() {
|
|
|
52
54
|
type: 'object',
|
|
53
55
|
refs: Object.entries(shape).map(([k, s]) => ({ key: k, meta: s?.meta || {} })),
|
|
54
56
|
});
|
|
57
|
+
// 嵌套对象也要能链 .description():真实 schemastery 的 object 支持链式描述,
|
|
58
|
+
// 兜底实现缺这一条时,任何「嵌套对象 + 描述」的 schema 定义(如 preCommit)都会在
|
|
59
|
+
// 缺依赖环境里抛 TypeError: fn.description is not a function —— 整个插件直接起不来。
|
|
60
|
+
fn.description = (d) => { fn.meta = { ...(fn.meta || {}), description: d }; return fn; };
|
|
55
61
|
// 【修复 】fallback schema 必须带 ~standard 标记,否则 DSH cordis 的
|
|
56
62
|
// resolveConfig 读 Config['~standard'].validate 时 undefined 崩溃
|
|
57
63
|
// ("Cannot read properties of undefined (reading 'validate')")。
|
|
@@ -81,18 +87,18 @@ export const Config = Schema.object({
|
|
|
81
87
|
workspaceRoot: Schema.string().default('').description('扫描根目录(空=DSH workspaceRoot)'),
|
|
82
88
|
extraRepos: Schema.array(Schema.string()).default([]).description('额外仓库路径(数组)'),
|
|
83
89
|
extraReposFile: Schema.string().default('').description('额外仓库清单文件(每行一个绝对路径,# 注释;运行时实时读取)'),
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
// 不必等门禁拦截才去读清单(省一次失败的工具往返)。auditEnabled 关闭时本项不生效。
|
|
87
|
-
maxScanFiles: Schema.number().default(DEFAULT_MAX_SCAN_FILES).description('全量审计文件数上限(0=不限);超限按变动文件优先截断,防止弱机扫大仓卡死'),
|
|
88
|
-
injectRequirements: Schema.boolean().default(false).description('注入开发者要求清单到系统提示词(可直接勾选;父开关「提交前审计」关闭时置灰且不注入,勾选保留;默认关)'),
|
|
89
|
-
auditScanScope: Schema.string().default('diff').description('diff | full'),
|
|
90
|
+
// —— 审计侧设置键(集中在 lib/app/schema-audit.js,此处展开合并)——
|
|
91
|
+
...auditConfigShape(Schema),
|
|
90
92
|
maxCloneFileMB: Schema.number().default(10).description('clone 单文件体积上限(MB),0=不限'),
|
|
91
93
|
cloneConcurrency: Schema.number().default(6).description('clone 并发下载数'),
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
94
|
+
// —— 提交前预处理引擎(可替换审计引擎,解耦方案 §2.1)——
|
|
95
|
+
// 三项刻意都是「空 = 内置」而不是「空 = 关闭」:门禁不能因为漏配字段就悄悄不审计。
|
|
96
|
+
// 注意本项是**高级文件配置**,不进 UI 设置项;解析顺序见 pre-commit-engine.js 的 resolvePreCommitConfig。
|
|
97
|
+
preCommit: Schema.object({
|
|
98
|
+
command: Schema.string().default('').description('审计引擎命令(空=内置 node;走 PATH 自探测,找不到会显式报错而不是静默降级)'),
|
|
99
|
+
args: Schema.array(Schema.string()).default([]).description('引擎参数(空=内置 scripts/audit-gate.mjs);相对路径按插件根解析'),
|
|
100
|
+
timeoutMs: Schema.number().default(PRE_COMMIT_TIMEOUT_MS_DEFAULT).description('引擎超时毫秒(超时按执行失败处理,fail-closed)'),
|
|
101
|
+
}).description('提交前预处理引擎(空=内置;换引擎只改这里)'),
|
|
96
102
|
pushMethod: Schema.string().default('ssh').description('推送通道:ssh(默认,推本地 HEAD、远端 sha 与本地一致)| api(Git Data API 重建提交)| auto(有私钥走 ssh,否则 api)'),
|
|
97
103
|
// 推送门禁(类似会话指挥家写操作拦截)——开启后 AI 推送必须带 pushConfirmed:true
|
|
98
104
|
// (已显式放行 pushConfirmed:true),否则 git_commit_push 拦截推送步骤(commit 可做,push 被挡)。
|
|
@@ -111,12 +117,6 @@ export const Config = Schema.object({
|
|
|
111
117
|
sshPub: Schema.string().description('SSH 公钥整行(存同级仓 *.pub)'),
|
|
112
118
|
npmToken: Schema.string().role('secret').description('npm token(存插件配置目录 0600;明文不下发浏览器;与 githubToken 同文件,写入走原子读改写)'),
|
|
113
119
|
npmRegistry: Schema.string().default('https://registry.npmjs.org/').description('npm registry 地址(默认官方源;用私有源时改这里)'),
|
|
114
|
-
commentWordingEnabled: Schema.boolean().default(true).description('提交信息措辞检查'),
|
|
115
|
-
commentWordingCustom: Schema.string().default('').description('自定义措辞规则'),
|
|
116
|
-
commentWordingRulesFile: Schema.string().default('').description('措辞规则文件路径'),
|
|
117
|
-
commentWordingRulesUrl: Schema.string().default('').description('措辞规则 URL'),
|
|
118
|
-
auditRuleWeights: Schema.dict(Schema.any()).default({}).description('规则权重({ blacklist: { pattern: weight } })'),
|
|
119
|
-
qualityWeights: Schema.dict(Schema.number()).default({}).description('质量维度权重覆盖({ 维度名: weight })'),
|
|
120
120
|
// 注入总开关(侧边栏可勾)。拆分两通道:
|
|
121
121
|
// systemPrompt 注入三段(功能用法/skill 入口/要求清单);环境信息(工作区目录 + 工具
|
|
122
122
|
// 安装路径)改走上下文注入(agent/pre-step 首次注入)。工具探测清单 = lib/tool-probes.json
|
|
@@ -139,6 +139,57 @@ export function appendSettingsLog(entry, env = {}) {
|
|
|
139
139
|
}
|
|
140
140
|
}
|
|
141
141
|
|
|
142
|
+
/**
|
|
143
|
+
* HTTP 拒绝日志文件(与 settings-ui.log 同级,0600)。
|
|
144
|
+
* 用途:写请求被鉴权前置拒掉时留痕——这类拒绝发生在 handler 之前,
|
|
145
|
+
* settings-ui.log 里本来一条都不会有,用户只看到「保存失败」而查不到原因。
|
|
146
|
+
* @param {{workspaceRoot?:string}} [env]
|
|
147
|
+
*/
|
|
148
|
+
export function httpRejectLogFilePath({ workspaceRoot = '' } = {}) {
|
|
149
|
+
return join(settingsLogFilePath({ workspaceRoot }), '..', 'http-rejects.log');
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* 追加一条 HTTP 拒绝日志(失败静默,绝不阻断请求处理)。
|
|
154
|
+
*
|
|
155
|
+
* 打码口径:query 里凡键名疑似凭据(token / secret / password / key / auth)一律替换为
|
|
156
|
+
* `(已省略)`——拒绝日志是给用户/排查者看的,不能反过来成为泄漏通道。
|
|
157
|
+
* @param {{method?:string, url?:string, origin?:string, host?:string, code?:string, status?:number}} entry
|
|
158
|
+
* @param {{workspaceRoot?:string}} [env]
|
|
159
|
+
*/
|
|
160
|
+
export function appendHttpRejectLog(entry = {}, env = {}) {
|
|
161
|
+
try {
|
|
162
|
+
const file = httpRejectLogFilePath(env);
|
|
163
|
+
mkdirSync(join(file, '..'), { recursive: true, mode: 0o700 });
|
|
164
|
+
const SECRET_KEY_RE = /(token|secret|passwd|password|key|auth|cookie)/i;
|
|
165
|
+
const rawUrl = String(entry.url || '');
|
|
166
|
+
const [pathOnly, queryText = ''] = rawUrl.split('?');
|
|
167
|
+
let query = '';
|
|
168
|
+
if (queryText) {
|
|
169
|
+
const pairs = queryText.split('&').map((pair) => {
|
|
170
|
+
const eq = pair.indexOf('=');
|
|
171
|
+
const rawKey = eq >= 0 ? pair.slice(0, eq) : pair;
|
|
172
|
+
const decodedKey = (() => { try { return decodeURIComponent(rawKey); } catch { return rawKey; } })();
|
|
173
|
+
return SECRET_KEY_RE.test(decodedKey) ? `${rawKey}=(已省略)` : pair;
|
|
174
|
+
});
|
|
175
|
+
query = `?${pairs.join('&')}`;
|
|
176
|
+
}
|
|
177
|
+
const line = JSON.stringify({
|
|
178
|
+
ts: new Date().toISOString(),
|
|
179
|
+
method: String(entry.method || ''),
|
|
180
|
+
url: pathOnly + query,
|
|
181
|
+
origin: String(entry.origin || '(无)'),
|
|
182
|
+
host: String(entry.host || '(无)'),
|
|
183
|
+
code: String(entry.code || ''),
|
|
184
|
+
status: Number(entry.status) || 0,
|
|
185
|
+
});
|
|
186
|
+
appendFileSync(file, line + '\n', { mode: 0o600 });
|
|
187
|
+
return true;
|
|
188
|
+
} catch {
|
|
189
|
+
return false; // 日志失败绝不阻断请求处理
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
|
|
142
193
|
/**
|
|
143
194
|
* 读当前设置快照(config.json;文件不存在/坏 JSON 返回 null,不抛)。
|
|
144
195
|
* @param {{workspaceRoot?:string}} [env]
|
package/lib/app/tool-call.js
CHANGED
|
@@ -294,7 +294,7 @@ async function callNpmPublishJob(args = {}, jobs, exec, log, env = {}, cfg = {})
|
|
|
294
294
|
const { publishPackage } = await import('../npm/publish.js');
|
|
295
295
|
const doPublish = () => publishPackage({
|
|
296
296
|
dir: String(args.dir || env.workspaceRoot || ''),
|
|
297
|
-
registry: cfg?.npmRegistry ||
|
|
297
|
+
registry: cfg?.npmRegistry || undefined,
|
|
298
298
|
workspaceRoot: env.workspaceRoot || '',
|
|
299
299
|
dryRun,
|
|
300
300
|
tag: args.tag || 'latest',
|
|
@@ -541,9 +541,10 @@ async function runStandardAuditTool(args, env, cfg, log, weights) {
|
|
|
541
541
|
// 缓存按规则包命中数供给 HTTP /rule-slots(侧边栏规则包列表显示实际命中数)
|
|
542
542
|
if (auditResult.slotStats) setLastSlotHitStats(auditResult.slotStats, repo);
|
|
543
543
|
log?.info?.(`code_audit ${repo} → ${quality.emptyResult ? '未评分(0 文件)' : quality.score + '/' + quality.level}(blocker ${summary.blocker} / warning ${summary.warning} / notice ${summary.notice})`);
|
|
544
|
-
//
|
|
545
|
-
//
|
|
546
|
-
|
|
544
|
+
// 默认**返回全量审计结果**(findings + yaml):调用方(AI/脚本)拿到的就该是能直接读的问题明细,
|
|
545
|
+
// 而不是只有分数再自己去查聚合 API —— 多一跳就多一次漏看的可能。
|
|
546
|
+
// 需要精简(大仓库结果过大、或只要结论)时显式传 includeFindings=false / summaryOnly=true。
|
|
547
|
+
const withFindings = args.includeFindings !== false && args.summaryOnly !== true;
|
|
547
548
|
const out = { ok: true, scope: auditResult.scope, files: auditResult.files, summary, quality, exemptStats, blocked, groupByTypes: GROUP_BY_KEYS, apiGuide, slotStats: auditResult.slotStats };
|
|
548
549
|
if (analysisCoverage) {
|
|
549
550
|
out.analysisCoverage = analysisCoverage;
|
|
@@ -612,7 +613,8 @@ export async function callTool(toolName, args = {}, env = {}, cfg = defaultConfi
|
|
|
612
613
|
name: String(args.name || args.pkg || ''),
|
|
613
614
|
version: String(args.version || ''),
|
|
614
615
|
wholePackage: args.wholePackage === true,
|
|
615
|
-
registry
|
|
616
|
+
// 同 handlers/npm.js:空串会让 npmrc 写出 `registry=`,npm 解析空 URL 直接崩
|
|
617
|
+
registry: cfg?.npmRegistry || undefined,
|
|
616
618
|
workspaceRoot: env.workspaceRoot || '',
|
|
617
619
|
dryRun,
|
|
618
620
|
confirm: args.confirm === true,
|
|
@@ -22,7 +22,13 @@ rules:
|
|
|
22
22
|
- id: paths/hardcoded-absolute-path
|
|
23
23
|
name: "硬编码绝对路径(换机即失效)"
|
|
24
24
|
category: "paths"
|
|
25
|
-
|
|
25
|
+
# blocker:写死本机数据/资源目录会直接导致换机、换挂载点后功能失效(真实故障形态)。
|
|
26
|
+
# 为不误伤正确写法,精筛排除了两类(见 lib/checks/hardcoded-path.js::isReasonableAbsolutePath):
|
|
27
|
+
# ① 临时目录 /tmp /var/tmp /dev/shm(跨机语义一致)
|
|
28
|
+
# ② 系统工具目录 /usr/bin /usr/local/bin /var/packages…(多候选探测是 tool-self-detection
|
|
29
|
+
# 要求的正确做法,把它当硬编码拦等于逼项目只能依赖 PATH)
|
|
30
|
+
# 文档类文件仍降级为 warning(示例路径属说明内容,见 lib/checks/regex.js 的文档降级)。
|
|
31
|
+
severity: "blocker"
|
|
26
32
|
description: "字符串里写死本机绝对路径(/volume1、/home、/Users、C:\\、\\\\server\\share、file://),换机/迁移/换挂载点后失效;应改为相对路径(基准 = 文件所在目录)、path.join 或配置项传入"
|
|
27
33
|
patterns:
|
|
28
34
|
- "/(volume[0-9]+|home|Users|var|usr|opt|tmp|mnt|srv|etc|root|Applications|Volumes)/[^\\s\"'`),;]+"
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* contract.js —— 审计 UI 契约:什么算一个可插拔的审计面板、缺什么算构建失败。
|
|
3
|
+
*
|
|
4
|
+
* 为什么契约单独成文件、并且只有常量 + 校验函数(照 dsh-model-team 的 ui/theme-sdk 范式):
|
|
5
|
+
* 面板实现是「别人写的代码」,它只应该依赖这一层。契约一旦散落到 SDK 各处,
|
|
6
|
+
* 作者就得靠读实现来猜哪些能用 —— 那等于没有契约。
|
|
7
|
+
* 校验发生在**构建期**(将来接回 UI 时由构建脚本调 defineAuditPanel),运行期不再重复校验:
|
|
8
|
+
* 坏实现应该在打包时被挡住,而不是等宿主里白屏才被发现。
|
|
9
|
+
*
|
|
10
|
+
* 校验项刻意只覆盖「构建期一定能判」的部分(形状与版本),**不猜作者意图**:
|
|
11
|
+
* 猜意图的校验(例如「Panel 是否真的渲染了 summary」「styles 里有没有外链 CSS」)
|
|
12
|
+
* 会在真实实现上误报,最后逼人把校验关掉 —— 那比没有校验更糟。
|
|
13
|
+
*
|
|
14
|
+
* 本文件零依赖(不 import 任何模块):它既要能进构建脚本,也要能进浏览器产物,
|
|
15
|
+
* 任何 Node 专有 API 都会让它两边都用不了。test/test-audit-ui-contract.mjs 钉住这条。
|
|
16
|
+
*
|
|
17
|
+
* 契约形状(与 docs/SPEC.md 第十一节同源):
|
|
18
|
+
* defineAuditPanel({ meta: { id, name, contractVersion }, Panel, styles?, setup? })
|
|
19
|
+
* Panel(props) 收到的 props 分三组,键名见下方三个常量:
|
|
20
|
+
* data —— 执行侧/宿主给的面板只读数据(summary / quality / findings / ruleSlots)
|
|
21
|
+
* actions —— 面板可以调的动作(reload / toggleRule / editWeight / toggleDisabled)
|
|
22
|
+
* state —— 宿主状态快照(loading / error / auditEnabled / auditScanScope)
|
|
23
|
+
* 数据只读、状态只读、要改状态走 actions —— 面板不自己保存这些状态。
|
|
24
|
+
*/
|
|
25
|
+
|
|
26
|
+
/** 契约版本:SDK 的破坏性改动就 +1,构建期用它拒掉按旧契约写的实现。 */
|
|
27
|
+
export const AUDIT_UI_CONTRACT_VERSION = 1;
|
|
28
|
+
|
|
29
|
+
/** meta.id 的合法形状:小写字母开头 + [a-z0-9-],2~32 字符。
|
|
30
|
+
* 用做样式命名空间(写进 [data-audit-panel="id"]),所以必须是能当 CSS 属性值的形状。 */
|
|
31
|
+
export const AUDIT_PANEL_ID_PATTERN = /^[a-z][a-z0-9-]{1,31}$/;
|
|
32
|
+
|
|
33
|
+
/** 面板拿到的只读数据键(与引擎返回字段同名,不再做二次改名);导出成常量而非只写注释,
|
|
34
|
+
* 宿主与实现都从这里取键名,改名只改一处。 */
|
|
35
|
+
export const AUDIT_PANEL_DATA_KEYS = Object.freeze(['summary', 'quality', 'findings', 'ruleSlots']);
|
|
36
|
+
|
|
37
|
+
/** 面板可以调的动作(实现只读地拿到这些函数;要不要用是实现的自由)。 */
|
|
38
|
+
export const AUDIT_PANEL_ACTION_KEYS = Object.freeze(['reload', 'toggleRule', 'editWeight', 'toggleDisabled']);
|
|
39
|
+
|
|
40
|
+
/** 面板能看到的宿主状态(只读快照;面板自己不应保存这些状态)。 */
|
|
41
|
+
export const AUDIT_PANEL_STATE_KEYS = Object.freeze(['loading', 'error', 'auditEnabled', 'auditScanScope']);
|
|
42
|
+
|
|
43
|
+
/** meta 只认这三个字段:未登记的键不会带进产物(契约面就是这三个,不是"随便加")。 */
|
|
44
|
+
const META_KEYS = Object.freeze(['id', 'name', 'contractVersion']);
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* 校验 meta 三个字段。
|
|
48
|
+
* 每一项单独报错并带上字段名与要求 —— 契约可用性的一半在错误信息:
|
|
49
|
+
* 只说「meta 非法」会让人回去翻文档,说清「要求 /^[a-z][a-z0-9-]{1,31}$/」才修得动。
|
|
50
|
+
* @param {object} meta 面板定义的 meta
|
|
51
|
+
*/
|
|
52
|
+
function assertMetaShape(meta) {
|
|
53
|
+
if (!meta || typeof meta !== 'object') {
|
|
54
|
+
throw new Error('[audit-ui] 缺少 meta(要求 { id, name, contractVersion })');
|
|
55
|
+
}
|
|
56
|
+
if (typeof meta.id !== 'string' || !AUDIT_PANEL_ID_PATTERN.test(meta.id)) {
|
|
57
|
+
throw new Error(`[audit-ui] meta.id 非法:${JSON.stringify(meta.id)}(要求 ${String(AUDIT_PANEL_ID_PATTERN)};小写字母开头、只含 [a-z0-9-]、2~32 字符)`);
|
|
58
|
+
}
|
|
59
|
+
if (typeof meta.name !== 'string' || meta.name.trim() === '') {
|
|
60
|
+
throw new Error(`[audit-ui] meta.name 必须是非空字符串(收到 ${JSON.stringify(meta.name)})`);
|
|
61
|
+
}
|
|
62
|
+
if (meta.contractVersion !== AUDIT_UI_CONTRACT_VERSION) {
|
|
63
|
+
throw new Error(`[audit-ui] meta.contractVersion 不匹配:面板写的是 ${JSON.stringify(meta.contractVersion)},当前 SDK 是 ${AUDIT_UI_CONTRACT_VERSION}(按旧契约写的实现要跟着改)`);
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* 校验必填项:Panel 必须是函数。
|
|
69
|
+
* 只判「是不是函数」——判不了「它渲染得对不对」,后者要跑起来才知道,属于运行期的事。
|
|
70
|
+
* @param {object} definition 面板定义
|
|
71
|
+
*/
|
|
72
|
+
function assertRequiredParts(definition) {
|
|
73
|
+
if (typeof definition.Panel !== 'function') {
|
|
74
|
+
throw new Error(`[audit-ui] Panel 必须是函数组件(收到 ${typeof definition.Panel})`);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* 校验可选项:出现即必须是约定类型(缺省 = 不启用该能力)。
|
|
80
|
+
* @param {object} definition 面板定义
|
|
81
|
+
*/
|
|
82
|
+
function assertOptionalParts(definition) {
|
|
83
|
+
if (definition.styles !== undefined && typeof definition.styles !== 'string') {
|
|
84
|
+
throw new Error(`[audit-ui] styles 若存在必须是字符串(收到 ${typeof definition.styles};自带 CSS 文本,不要引外部 CSS 文件)`);
|
|
85
|
+
}
|
|
86
|
+
if (definition.setup !== undefined && typeof definition.setup !== 'function') {
|
|
87
|
+
throw new Error(`[audit-ui] setup 若存在必须是函数(收到 ${typeof definition.setup};返回值可作为卸载清理函数)`);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* 声明并校验一个审计面板(构建期调用)。
|
|
93
|
+
*
|
|
94
|
+
* 返回值是**冻结的新对象**(只含契约内的字段):
|
|
95
|
+
* · 运行期有人往面板对象上挂字段 → 严格模式下直接抛错,而不是静默生效后被别处读到;
|
|
96
|
+
* · 未登记的字段不会被带进产物 —— 「契约面有哪几个字段」是确定的,不随作者顺手加键而膨胀。
|
|
97
|
+
*
|
|
98
|
+
* @param {object} definition { meta, Panel, styles?, setup? }
|
|
99
|
+
* @returns {{meta: object, Panel: Function, styles?: string, setup?: Function}} 冻结后的面板定义
|
|
100
|
+
*/
|
|
101
|
+
export function defineAuditPanel(definition) {
|
|
102
|
+
if (!definition || typeof definition !== 'object' || Array.isArray(definition)) {
|
|
103
|
+
throw new Error('[audit-ui] defineAuditPanel 需要一个对象参数(形如 { meta, Panel, styles?, setup? })');
|
|
104
|
+
}
|
|
105
|
+
assertMetaShape(definition.meta);
|
|
106
|
+
assertRequiredParts(definition);
|
|
107
|
+
assertOptionalParts(definition);
|
|
108
|
+
// meta 只保留契约字段:多写的键不进产物,避免「产物里有、契约里没有」的暗面
|
|
109
|
+
const meta = {};
|
|
110
|
+
for (const key of META_KEYS) meta[key] = definition.meta[key];
|
|
111
|
+
return Object.freeze({
|
|
112
|
+
meta: Object.freeze(meta),
|
|
113
|
+
Panel: definition.Panel,
|
|
114
|
+
styles: definition.styles,
|
|
115
|
+
setup: definition.setup,
|
|
116
|
+
});
|
|
117
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* index.js —— 审计 UI SDK 的唯一导出面:面板实现只允许从这里 import。
|
|
3
|
+
*
|
|
4
|
+
* 为什么「只留一个入口」:分组导出看着只是方便,实际是**什么算稳定契约**的边界——
|
|
5
|
+
* 实现若绕过它去 import contract.js 的内部细节,SDK 一旦重构就会伤到别人。
|
|
6
|
+
* 所以本文件只 re-export 承诺面,一个多余符号都不加;想加符号先问「它算契约吗」。
|
|
7
|
+
* 契约形状(meta/Panel/styles/setup 与 props 三组键)的权威说明在 ./contract.js 头部。
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
export {
|
|
11
|
+
AUDIT_UI_CONTRACT_VERSION,
|
|
12
|
+
AUDIT_PANEL_ID_PATTERN,
|
|
13
|
+
AUDIT_PANEL_DATA_KEYS,
|
|
14
|
+
AUDIT_PANEL_ACTION_KEYS,
|
|
15
|
+
AUDIT_PANEL_STATE_KEYS,
|
|
16
|
+
defineAuditPanel,
|
|
17
|
+
} from './contract.js';
|
package/lib/checks/regex.js
CHANGED
|
@@ -192,9 +192,14 @@ export function checkRegexRules({ file, text, rules, source = '新增行', repoP
|
|
|
192
192
|
// 使「展示口径」与「计分口径」一致:info 即不计分)。
|
|
193
193
|
const ioSev = rule.astConfirmKind === 'io-risk' && ioHit
|
|
194
194
|
&& (ioHit.risk === 'low' || ioHit.risk === 'safe') ? 'info' : null;
|
|
195
|
+
// 文档类文件降级:文档里写路径示例是**说明内容**,不是可执行代码里的坏路径。
|
|
196
|
+
// 规则本体是 blocker(拦真代码里的硬编码),文档统一降 warning 保留可见性。
|
|
197
|
+
const docDowngrade = rule.astConfirmKind === 'hardcoded-abs-path'
|
|
198
|
+
&& (/\.(md|markdown|mdx|txt|rst|adoc)$/i.test(String(file || ''))
|
|
199
|
+
|| /(^|\/)docs?\//i.test(String(file || ''))) ? 'warning' : null;
|
|
195
200
|
findings.push(makeFinding({
|
|
196
201
|
file, line: i + 1, rule: rule.id, kind: rule.kind,
|
|
197
|
-
severity: ioSev || (rule.level === 'blocker' ? 'blocker' : rule.severity),
|
|
202
|
+
severity: ioSev || docDowngrade || (rule.level === 'blocker' ? 'blocker' : rule.severity),
|
|
198
203
|
// I/O 分级 > 子模式专属 > 规则级
|
|
199
204
|
message: ioMsg || hcMsg || subs?.[j]?.message || rule.message || rule.name,
|
|
200
205
|
dimensions: rule.dimensions,
|
|
@@ -8,11 +8,10 @@
|
|
|
8
8
|
* 保持薄引用:审计逻辑在 lib/audit/*(与插件 code_audit 同源)。
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
|
+
import { cliPluginConfig } from './shared.mjs';
|
|
11
12
|
import { auditWithScope, auditFull } from '../audit/index.js';
|
|
12
13
|
import { formatAnalysisCoverageLine } from '../audit/analysis-coverage.js';
|
|
13
14
|
import { scoreQuality } from '../score/index.js';
|
|
14
|
-
import { readSettings, applySettingsToCfg } from '../app/settings-bridge.js';
|
|
15
|
-
import { defaultConfig } from '../client/index.js';
|
|
16
15
|
import { access } from 'node:fs/promises';
|
|
17
16
|
import { join } from 'node:path';
|
|
18
17
|
import { probeRepoOwnership } from '../app/repo-ownership.js';
|
|
@@ -20,21 +19,9 @@ import { probeRepoOwnership } from '../app/repo-ownership.js';
|
|
|
20
19
|
/** 审计 full 扫描 findings 打印条数上限(防刷屏)。 */
|
|
21
20
|
const AUDIT_PRINT_LIMIT = 20;
|
|
22
21
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
* 绝不能把它的返回值当 cfg 用——那会让 auditLevel/maxScanFiles/weightOverrides 等全变
|
|
27
|
-
* undefined,CLI 结果与插件不一致。 */
|
|
28
|
-
export function cliPluginConfig() {
|
|
29
|
-
const cfg = defaultConfig();
|
|
30
|
-
try {
|
|
31
|
-
const saved = readSettings({});
|
|
32
|
-
applySettingsToCfg(cfg, saved || {}); // 原地改 cfg,忽略返回值
|
|
33
|
-
} catch {
|
|
34
|
-
/* 配置缺失/损坏 → 保留 defaultConfig(与插件首启一致) */
|
|
35
|
-
}
|
|
36
|
-
return cfg;
|
|
37
|
-
}
|
|
22
|
+
// cliPluginConfig 已挪到 lib/cli/shared.mjs(三入口共用;git 侧读配置不必 import 审计实现)。
|
|
23
|
+
// 这里保留同名导出,外部按老路径 import 不受影响。
|
|
24
|
+
export { cliPluginConfig };
|
|
38
25
|
|
|
39
26
|
/**
|
|
40
27
|
* 构造与插件 code_audit **完全相同**的审计参数(保证 CLI 与插件结果一致)。
|
|
@@ -136,6 +123,14 @@ function printAuditResult(root, auditResult, opts, weights, quality) {
|
|
|
136
123
|
* (实测「CLI 全量扫描分更低、文件更多」:跑了已禁用规则包 + 默认权重 + 不同文件上限)。
|
|
137
124
|
* 现在 CLI 读**同一份** config.json($DSH_HOME/git-push/config.json),用与插件 code_audit
|
|
138
125
|
* 完全相同的 auditOpts 与入口(auditFull),保证功能与结果一致。 */
|
|
126
|
+
/**
|
|
127
|
+
* ⚠️ **当前 CLI 不可达**(2026-11-13 核实):`scan` 命令由注册表 `git_scan` 接管
|
|
128
|
+
* (输出 `count: N` 的仓库扫描),本函数不挂在任何 COMMANDS 表里。
|
|
129
|
+
* 保留原因:它调的是 `auditWithScope(root,{scope:'full',depth})`,是「按审计口径扫描」的
|
|
130
|
+
* 另一种语义,将来若要提供 `scan --audit` 之类可复用。**注意它没传**
|
|
131
|
+
* `maxScanFiles / disabledSlots / rulesetDir` —— 若接回 CLI,需先补这三个,
|
|
132
|
+
* 否则会与插件侧的扫描口径不一致。
|
|
133
|
+
*/
|
|
139
134
|
export async function cmdScan(root, flags) {
|
|
140
135
|
const depth = flags.depth ?? 3;
|
|
141
136
|
const scanResult = await auditWithScope(root, { scope: 'full', depth });
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
// CLI 工具链域命令实现(tool-sluice 独占)
|
|
2
|
+
//
|
|
3
|
+
// 为什么单独成文件:这三个命令是「对项目自身/脚手架的检查与模板输出」,与 git 操作、
|
|
4
|
+
// 审计执行都无关;放在入口文件里会让 tool-sluice 的入口从薄壳变成半个实现。
|
|
5
|
+
//
|
|
6
|
+
// self-check 的职责(拆分后比原来更重要):三个入口各有一份 HELP + KNOWN_FLAGS,
|
|
7
|
+
// 任何一份写歪都会让用户按 HELP 抄命令失败。它逐个入口比对「HELP 里写的 flag」与
|
|
8
|
+
// 「该入口 parseArgv 认的 flag」,并核对每个入口的 HELP 是否列出自己全部命令。
|
|
9
|
+
|
|
10
|
+
import { VERSION, helpSync, readmeTemplate, yamlTemplate } from '../self/index.js';
|
|
11
|
+
import { readFileSync } from 'node:fs';
|
|
12
|
+
|
|
13
|
+
import { CLI_ENTRIES, allCommands, parseEntrySourceMeta, readEntrySource } from './shared.mjs';
|
|
14
|
+
|
|
15
|
+
/** 入口文件清单(bin → 源文件)。自检逐个核对。 */
|
|
16
|
+
export const ENTRY_FILES = [
|
|
17
|
+
{ cliName: 'git-sluice', file: 'cli.mjs' },
|
|
18
|
+
{ cliName: 'audit-sluice', file: 'cli-audit.mjs' },
|
|
19
|
+
{ cliName: 'tool-sluice', file: 'cli-tool.mjs' },
|
|
20
|
+
];
|
|
21
|
+
|
|
22
|
+
/** 读 package.json(失败返回 null)。 */
|
|
23
|
+
export function readPkgJson() {
|
|
24
|
+
try {
|
|
25
|
+
return JSON.parse(readFileSync(new URL('../../package.json', import.meta.url), 'utf8'));
|
|
26
|
+
} catch { return null; }
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/** 子命令:yaml-template — 输出规则 yml 模板。 */
|
|
30
|
+
export function cmdYamlTemplate() {
|
|
31
|
+
console.log(yamlTemplate());
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** 子命令:readme-template — 输出 README 模板。 */
|
|
35
|
+
export function cmdReadmeTemplate() {
|
|
36
|
+
console.log(readmeTemplate().template);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* 逐个入口核对「HELP ↔ parseArgv」与「HELP 是否列出本侧全部命令」。
|
|
41
|
+
* @returns {{failures: string[], lines: string[]}}
|
|
42
|
+
*/
|
|
43
|
+
export function checkEntries() {
|
|
44
|
+
const failures = [];
|
|
45
|
+
const lines = [];
|
|
46
|
+
for (const { cliName, file } of ENTRY_FILES) {
|
|
47
|
+
let meta;
|
|
48
|
+
try {
|
|
49
|
+
meta = parseEntrySourceMeta(readEntrySource(file));
|
|
50
|
+
} catch (e) {
|
|
51
|
+
failures.push(`${file}: 读取失败(${e.message})`);
|
|
52
|
+
continue;
|
|
53
|
+
}
|
|
54
|
+
if (!meta.help) { failures.push(`${file}: 未找到 HELP 常量`); continue; }
|
|
55
|
+
const sync = helpSync(meta.help, meta.flags);
|
|
56
|
+
if (!sync.ok) {
|
|
57
|
+
failures.push(`${file}: HELP 与 KNOWN_FLAGS 不一致`);
|
|
58
|
+
for (const missingFlag of sync.missingInHelp) failures.push(` ${file}: KNOWN_FLAGS 有但 HELP 没写 ${missingFlag}`);
|
|
59
|
+
for (const extraFlag of sync.missingInParse) failures.push(` ${file}: HELP 写了但 KNOWN_FLAGS 没有 ${extraFlag}`);
|
|
60
|
+
continue;
|
|
61
|
+
}
|
|
62
|
+
// HELP 必须列出本侧每个命令的用法行(`<cli> <cmd>` 形式);缺了说明「加了命令忘了文档」
|
|
63
|
+
const missingCommands = (CLI_ENTRIES[cliName]?.commands || []).filter((cmd) => !meta.help.includes(`${cliName} ${cmd}`));
|
|
64
|
+
if (missingCommands.length) {
|
|
65
|
+
failures.push(`${file}: HELP 缺命令用法行 ${missingCommands.join(' ')}`);
|
|
66
|
+
} else {
|
|
67
|
+
lines.push(` ✓ ${file}: HELP↔KNOWN_FLAGS 一致(${meta.flags.length} 个 flag)· 本侧 ${(CLI_ENTRIES[cliName]?.commands || []).length} 个命令都有用法行`);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
return { failures, lines };
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/** 子命令:self-check — 版本一致性 + 三入口 HELP↔parseArgv 机器比对 + 命令覆盖。 */
|
|
74
|
+
export function cmdSelfCheck() {
|
|
75
|
+
const failures = [];
|
|
76
|
+
console.log('自身自检:');
|
|
77
|
+
console.log(` version: v${VERSION}`);
|
|
78
|
+
const pkg = readPkgJson();
|
|
79
|
+
if (pkg && pkg.version && pkg.version !== VERSION) {
|
|
80
|
+
failures.push(`version: lib/self=${VERSION} vs package.json=${pkg.version}`);
|
|
81
|
+
console.error(` ✗ version: lib/self=${VERSION} vs package.json=${pkg.version}`);
|
|
82
|
+
} else {
|
|
83
|
+
console.log(` ✓ version: lib/self = package.json = ${VERSION}`);
|
|
84
|
+
}
|
|
85
|
+
const { failures: entryFailures, lines } = checkEntries();
|
|
86
|
+
for (const reportLine of lines) console.log(reportLine);
|
|
87
|
+
// 一次性并入(不在循环里逐条 push:既少一层循环,也让「失败清单来自一处」更好读)
|
|
88
|
+
failures.push(...entryFailures);
|
|
89
|
+
for (const failure of entryFailures) console.error(` ✗ ${failure}`);
|
|
90
|
+
if (!entryFailures.length) console.log(` ✓ 命令覆盖:三入口共 ${allCommands().length} 个命令都有用法行`);
|
|
91
|
+
process.exitCode = failures.length > 0 ? 1 : 0;
|
|
92
|
+
return failures.length > 0 ? 1 : 0;
|
|
93
|
+
}
|
package/lib/cli/commands-vcs.mjs
CHANGED
|
@@ -20,7 +20,8 @@ import { DEFAULT_MAX_FILE_MB } from '../git/clone-download.js';
|
|
|
20
20
|
import { resolveToken } from '../git/credentials.js';
|
|
21
21
|
import { access } from 'node:fs/promises';
|
|
22
22
|
import { join } from 'node:path';
|
|
23
|
-
|
|
23
|
+
// cliPluginConfig 从公共层取(git 侧实现不该为了读配置去 import 审计实现)
|
|
24
|
+
import { cliPluginConfig } from './shared.mjs';
|
|
24
25
|
|
|
25
26
|
/** git-sluice repos 子命令默认列出上限。 */
|
|
26
27
|
const REPOS_DEFAULT_MAX = 200;
|