Skip to content

armgit / cindy

Public Imported from GitHub
0

Consider it done. The open-source AI agent that works out of the box · 想到,就能做到。开源、开箱即用的 AI Agent。

fix(design): 已删除的设计文档连完整路径写法一并拒绝,并补测试

kirozeng9478db1878c8
diff --git a/package.json b/package.json
index 5ffc07a4f7..c8b191a199 100644
--- a/package.json
+++ b/package.json
@@ -136,7 +136,7 @@
"licenses:generate": "node scripts/generate-third-party-notices.mjs",
"lint": "pnpm -r lint",
"format": "pnpm -r format",
- "test:runner": "node --test scripts/__tests__/repo-worktrees.test.mjs scripts/__tests__/test-workspaces.test.mjs scripts/__tests__/remote-bundle-inputs.test.mjs scripts/__tests__/test-related.test.mjs scripts/__tests__/desktop-worker-benchmark.test.mjs scripts/__tests__/dev-docs-contract.test.mjs scripts/__tests__/restart-desktop-remote.test.mjs scripts/__tests__/dev-migration-policy.test.mjs scripts/__tests__/ensure-deps.test.mjs scripts/__tests__/client-endpoint-build-env.test.mjs scripts/__tests__/log-upload-build-env.test.mjs scripts/__tests__/desktop-dev-region.test.mjs scripts/__tests__/desktop-dev-node-options.test.mjs scripts/__tests__/endpoint-consistency.test.mjs scripts/__tests__/endpoint-local-file.test.mjs scripts/__tests__/ensure-agent-binaries.test.mjs scripts/__tests__/ensure-android-platform-tools.test.mjs scripts/__tests__/fetch-with-timeout.test.mjs scripts/__tests__/agent-binary-cdn-fallback.test.mjs scripts/__tests__/ensure-binary-fallback.test.mjs scripts/__tests__/verify-sha256.test.mjs scripts/__tests__/codex-package-update-layout.test.mjs scripts/__tests__/pi-update-layout.test.mjs scripts/__tests__/migration-freeze.test.mjs scripts/__tests__/third-party-notices.test.mjs scripts/__tests__/brand-identity-sync.test.mjs scripts/__tests__/check-dco.test.mjs scripts/__tests__/package-args.test.mjs scripts/__tests__/notarize-mac-app.test.mjs scripts/__tests__/glossary-rules.test.mjs scripts/__tests__/design-inventory.test.mjs scripts/__tests__/hardcoded-color-audit.test.mjs scripts/__tests__/check-test-hygiene.test.mjs && node apps/desktop/scripts/check-windows-atomic-rename.mjs",
+ "test:runner": "node --test scripts/__tests__/repo-worktrees.test.mjs scripts/__tests__/test-workspaces.test.mjs scripts/__tests__/remote-bundle-inputs.test.mjs scripts/__tests__/test-related.test.mjs scripts/__tests__/desktop-worker-benchmark.test.mjs scripts/__tests__/dev-docs-contract.test.mjs scripts/__tests__/restart-desktop-remote.test.mjs scripts/__tests__/dev-migration-policy.test.mjs scripts/__tests__/ensure-deps.test.mjs scripts/__tests__/client-endpoint-build-env.test.mjs scripts/__tests__/log-upload-build-env.test.mjs scripts/__tests__/desktop-dev-region.test.mjs scripts/__tests__/desktop-dev-node-options.test.mjs scripts/__tests__/endpoint-consistency.test.mjs scripts/__tests__/endpoint-local-file.test.mjs scripts/__tests__/ensure-agent-binaries.test.mjs scripts/__tests__/ensure-android-platform-tools.test.mjs scripts/__tests__/fetch-with-timeout.test.mjs scripts/__tests__/agent-binary-cdn-fallback.test.mjs scripts/__tests__/ensure-binary-fallback.test.mjs scripts/__tests__/verify-sha256.test.mjs scripts/__tests__/codex-package-update-layout.test.mjs scripts/__tests__/pi-update-layout.test.mjs scripts/__tests__/migration-freeze.test.mjs scripts/__tests__/third-party-notices.test.mjs scripts/__tests__/brand-identity-sync.test.mjs scripts/__tests__/check-dco.test.mjs scripts/__tests__/package-args.test.mjs scripts/__tests__/notarize-mac-app.test.mjs scripts/__tests__/glossary-rules.test.mjs scripts/__tests__/design-inventory.test.mjs scripts/__tests__/hardcoded-color-audit.test.mjs scripts/__tests__/check-test-hygiene.test.mjs scripts/__tests__/check-pr-design-basis.test.mjs && node apps/desktop/scripts/check-windows-atomic-rename.mjs",
"test:workspaces": "node scripts/test-workspaces.mjs",
"test:unit": "pnpm test:runner && node scripts/test-workspaces.mjs --tier unit",
"test:unit:related": "node scripts/test-workspaces.mjs --tier unit --related",
diff --git a/scripts/__tests__/check-pr-design-basis.test.mjs b/scripts/__tests__/check-pr-design-basis.test.mjs
new file mode 100644
index 0000000000..dc3f32e1f2
--- /dev/null
+++ b/scripts/__tests__/check-pr-design-basis.test.mjs
@@ -0,0 +1,25 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+
+import { validateDesignBasis } from "../check-pr-design-basis.mjs";
+
+const UI_FILES = ["apps/desktop/src/renderer/components/login/LoginControls.tsx"];
+const body = (basis) => `### UI 变化\n\n- 引用的设计规范:${basis}\n\n## 怎么验证的\n`;
+const passes = (basis) => validateDesignBasis(body(basis), UI_FILES).length === 0;
+
+test("现行设计文档的引用仍算有设计依据", () => {
+ assert.equal(passes("DESIGN.md §16.1 登录调色板:文字走墨水阶梯"), true);
+ assert.equal(passes("docs/design-rules/token-decision-table.md §3 色值决策"), true);
+ assert.equal(passes("docs/design-rules/cindy-design-system.md 索引"), true);
+});
+
+test("只引用已删除的 figma-component-spec,不论哪种写法都不算设计依据", () => {
+ assert.equal(passes("figma-component-spec §4 组件逐参数规格"), false);
+ assert.equal(passes("docs/design-rules/figma-component-spec.md §4"), false);
+ assert.equal(passes("[规格](docs/design-rules/figma-component-spec.md)"), false);
+ assert.equal(passes("Figma-Component-Spec §12"), false);
+});
+
+test("同时引用现行文档时,顺带提到已删除文档不影响通过", () => {
+ assert.equal(passes("DESIGN.md §16.5;旧 figma-component-spec §11 已迁入"), true);
+});
diff --git a/scripts/check-pr-design-basis.mjs b/scripts/check-pr-design-basis.mjs
index 7ad107f146..fa956601c7 100644
--- a/scripts/check-pr-design-basis.mjs
+++ b/scripts/check-pr-design-basis.mjs
@@ -34,6 +34,9 @@ const FIELD_LABEL = '引用的设计规范';
// 设计规范文档引用特征:docs/design-rules/ 目录或其下具体文档名。
const DESIGN_DOC_PATTERN =
/(docs\/design-rules\/|DESIGN\.md|cindy-design-system|token-decision-table)/i;
+// 已删除的设计文档:连同它所在的整段写法(裸文件名、完整路径、Markdown 链接)一起先剔除再判断,
+// 否则 `docs/design-rules/figma-component-spec.md §4` 仍会因目录前缀被当作有效依据。
+const REMOVED_DESIGN_DOC_PATTERN = /\S*figma-component-spec\S*/gi;
// 「不涉及」豁免在去掉该词与标点后至少要剩这么多字符,才算附了理由
// (放到 4 是为了让「纯逻辑重构」「无 UI 变化」这类最短合理理由能过)。
const MIN_EXEMPT_REASON_CHARS = 4;
@@ -87,7 +90,7 @@ export function validateDesignBasis(body, uiFiles) {
return errors;
}
- if (DESIGN_DOC_PATTERN.test(content)) return errors;
+ if (DESIGN_DOC_PATTERN.test(content.replace(REMOVED_DESIGN_DOC_PATTERN, ' '))) return errors;
if (content.includes('不涉及')) {
const reason = content.replace(/不涉及/g, '').replace(/[\s、,,。.::;;!!??()()-]/g, '');