verify-ui.mjs 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. #!/usr/bin/env node
  2. /**
  3. * verify:ui —— FR-12 / FR-13 / FR-15 的静态断言
  4. *
  5. * 依据《设计令牌.md》v3.0 §十二。测量口径(评审 G3 要求):
  6. * · **口径 A(强制)**:业务目录 `src/app/{core,components,desktop,mobile,pages}` 的 .ts/.scss/.html
  7. * · **口径 B(豁免)**:`src/app/ui/**`(底座生成物,禁改)
  8. *
  9. * 用法:node scripts/verify-ui.mjs
  10. * 退出码 0 = 全部通过;非 0 = 有断言失败。
  11. */
  12. import { readdirSync, readFileSync, statSync } from 'node:fs';
  13. import { join, relative } from 'node:path';
  14. const ROOT = process.cwd();
  15. const SRC = join(ROOT, 'src');
  16. /** 业务目录(口径 A) */
  17. const BIZ_DIRS = ['app/core', 'app/components', 'app/desktop', 'app/mobile', 'app/pages', 'environments'];
  18. /** 全局样式文件(单独检查行数) */
  19. const GLOBAL_STYLES = ['styles.scss', 'app/core/styles/_base.scss', 'app/core/styles/_palette.scss'];
  20. /** 覆盖块行数预算(评审 G5 / AC-12.4) */
  21. const BUDGET_LINES = 300;
  22. const results = [];
  23. const fail = (name, detail, hits = []) => results.push({ name, ok: false, detail, hits });
  24. const pass = (name, detail) => results.push({ name, ok: true, detail });
  25. function walk(dir, out = []) {
  26. let entries;
  27. try {
  28. entries = readdirSync(dir);
  29. } catch {
  30. return out;
  31. }
  32. for (const e of entries) {
  33. const p = join(dir, e);
  34. const st = statSync(p);
  35. if (st.isDirectory()) walk(p, out);
  36. else out.push(p);
  37. }
  38. return out;
  39. }
  40. const bizFiles = BIZ_DIRS.flatMap((d) => walk(join(SRC, d))).filter((f) =>
  41. /\.(ts|scss|html)$/.test(f),
  42. );
  43. /** 逐行扫描,返回命中 {file, line, text} */
  44. function scan(files, regex) {
  45. const hits = [];
  46. for (const f of files) {
  47. const lines = readFileSync(f, 'utf-8').split('\n');
  48. lines.forEach((text, i) => {
  49. if (regex.test(text)) hits.push({ file: relative(ROOT, f), line: i + 1, text: text.trim() });
  50. });
  51. }
  52. return hits;
  53. }
  54. /** 从样式/模板中提取所有「代码实参」,用于去重档位统计 */
  55. function extractCssValues(files, propRegex) {
  56. const values = new Set();
  57. for (const f of files) {
  58. const src = readFileSync(f, 'utf-8');
  59. let m;
  60. const re = new RegExp(propRegex.source, 'g');
  61. while ((m = re.exec(src)) !== null) values.add(m[1].trim());
  62. }
  63. return [...values];
  64. }
  65. /* ------------------------------------------------------------------ */
  66. /* AC-12.1 硬编码色值 → 0 处 */
  67. /* ------------------------------------------------------------------ */
  68. {
  69. // 允许在「注释行」与「令牌定义文件」中出现色值(令牌定义是取值的唯一真源)
  70. const ALLOW_FILES = GLOBAL_STYLES.map((f) => 'src/' + f);
  71. const files = bizFiles.filter((f) => !ALLOW_FILES.includes(relative(ROOT, f).replace(/\\/g, '/')));
  72. const hits = scan(files, /#[0-9a-fA-F]{3,8}\b|\brgba?\(|\bhsla?\(/).filter(
  73. // 排除注释行与文档说明中的示例
  74. (h) => !/^\s*(\/\/|\*|\/\*)/.test(h.text),
  75. );
  76. if (hits.length === 0) pass('AC-12.1 硬编码色值', '业务目录 0 处');
  77. else fail('AC-12.1 硬编码色值', `业务目录 ${hits.length} 处(目标 0)`, hits.slice(0, 20));
  78. }
  79. /* ------------------------------------------------------------------ */
  80. /* AC-12.2 自有前缀 / 双轨语义色 → 0 处 */
  81. /* ------------------------------------------------------------------ */
  82. {
  83. const hits = scan(bizFiles, /--(?:fx|wecom|dk)-|--ok\b|--crit\b|--warn-(?:ink|bg)\s*:/).filter(
  84. (h) => !/^\s*(\/\/|\*|\/\*)/.test(h.text),
  85. );
  86. if (hits.length === 0) pass('AC-12.2 令牌前缀单轨', '0 处自有前缀 / 双轨语义色');
  87. else fail('AC-12.2 令牌前缀单轨', `${hits.length} 处(目标 0)`, hits.slice(0, 20));
  88. }
  89. /* ------------------------------------------------------------------ */
  90. /* AC-12.3a 字号档位 ≤8 */
  91. /* ------------------------------------------------------------------ */
  92. {
  93. const styles = bizFiles.filter((f) => /\.(scss|ts)$/.test(f));
  94. // 只统计「字面量 px/数值」形式;var(--fs-*) 是令牌引用,不参与档位统计
  95. const literal = extractCssValues(
  96. styles,
  97. /font-size:\s*(?!var\(|inherit|1em)([0-9.]+(?:px|rem))/,
  98. );
  99. const token = new Set();
  100. for (const f of styles) {
  101. const src = readFileSync(f, 'utf-8');
  102. for (const m of src.matchAll(/var\((--fs-[0-9]+)\)/g)) token.add(m[1]);
  103. }
  104. if (literal.length === 0 && token.size <= 8) {
  105. pass('AC-12.3a 字号 ≤8 档', `字面量 0 个;令牌 ${token.size} 档(${[...token].join(', ')})`);
  106. } else {
  107. fail(
  108. 'AC-12.3a 字号 ≤8 档',
  109. `字面量 ${literal.length} 个 / 令牌 ${token.size} 档(目标 ≤8)`,
  110. literal.map((v) => ({ file: '(字面量)', line: 0, text: v })),
  111. );
  112. }
  113. }
  114. /* ------------------------------------------------------------------ */
  115. /* AC-12.3b 圆角档位 ≤4 */
  116. /* ------------------------------------------------------------------ */
  117. {
  118. const styles = bizFiles.filter((f) => /\.(scss|ts)$/.test(f));
  119. const token = new Set();
  120. for (const f of styles) {
  121. const src = readFileSync(f, 'utf-8');
  122. for (const m of src.matchAll(/var\((--r-[a-z]+)\)/g)) token.add(m[1]);
  123. }
  124. if (token.size <= 4) pass('AC-12.3b 圆角 ≤4 档', `令牌 ${token.size} 档(${[...token].join(', ')})`);
  125. else fail('AC-12.3b 圆角 ≤4 档', `令牌 ${token.size} 档(目标 ≤4)`);
  126. }
  127. /* ------------------------------------------------------------------ */
  128. /* AC-12.4 覆盖块行数 ≤300 */
  129. /* ------------------------------------------------------------------ */
  130. {
  131. let total = 0;
  132. const parts = [];
  133. for (const f of GLOBAL_STYLES) {
  134. try {
  135. const n = readFileSync(join(SRC, f), 'utf-8').split('\n').length;
  136. total += n;
  137. parts.push(`${f}=${n}`);
  138. } catch {
  139. /* 缺失则跳过 */
  140. }
  141. }
  142. if (total <= BUDGET_LINES) pass('AC-12.4 覆盖块行数', `${total} ≤ ${BUDGET_LINES}(${parts.join(' + ')})`);
  143. else fail('AC-12.4 覆盖块行数', `${total} 行 > ${BUDGET_LINES}(${parts.join(' + ')})`);
  144. }
  145. /* ------------------------------------------------------------------ */
  146. /* AC-12.5 单例服务:ThemeService / PaletteService 各一处 */
  147. /* ------------------------------------------------------------------ */
  148. {
  149. const hits = scan(bizFiles, /new\s+(?:ThemeService|PaletteService)\s*\(/);
  150. if (hits.length === 0) pass('AC-12.5 服务单例', '无手工 new,均走 DI');
  151. else fail('AC-12.5 服务单例', `${hits.length} 处手工实例化(应走 DI)`, hits);
  152. }
  153. /* ------------------------------------------------------------------ */
  154. /* AC-12.6 ui-kit 组件引用去重 ≥30 */
  155. /* ------------------------------------------------------------------ */
  156. {
  157. // 用 fs 递归统计(避免 Windows 下 grep 不可用)
  158. const bizRoot = join(SRC, 'app');
  159. const scanDirs = ['desktop', 'mobile', 'components', 'pages', 'core'].map((d) => join(bizRoot, d));
  160. const selectors = new Set();
  161. for (const d of scanDirs) {
  162. for (const f of walk(d)) {
  163. if (!/\.(ts|html)$/.test(f)) continue;
  164. const src = readFileSync(f, 'utf-8');
  165. for (const m of src.matchAll(/<(ui-[a-z-]+)/g)) selectors.add(m[1]);
  166. }
  167. }
  168. const count = selectors.size;
  169. if (count >= 30) pass('AC-12.6 ui-kit 覆盖率', `${count} 个不同组件(门槛 30):${[...selectors].sort().join(', ')}`);
  170. else
  171. fail(
  172. 'AC-12.6 ui-kit 覆盖率',
  173. `${count} 个(门槛 30)`,
  174. [{ file: '(统计)', line: 0, text: [...selectors].sort().join(', ') }],
  175. );
  176. }
  177. /* ------------------------------------------------------------------ */
  178. /* AC-13.3 触达区 ≥44px */
  179. /* ------------------------------------------------------------------ */
  180. {
  181. const styles = bizFiles.filter((f) => /\.(scss|ts)$/.test(f));
  182. // 只检查交互元素的高度声明是否 < 44px(图标按钮/筛选 chip 等)
  183. const hits = [];
  184. for (const f of styles) {
  185. const src = readFileSync(f, 'utf-8');
  186. // 形如 height: 28px / min-height: 30px 且未走 --touch-min 的交互控件
  187. for (const m of src.matchAll(/(?:^|\s)(?:min-)?height:\s*([0-9]+)px/g)) {
  188. const n = Number(m[1]);
  189. if (n > 0 && n < 44) {
  190. const line = src.slice(0, m.index).split('\n').length;
  191. hits.push({ file: relative(ROOT, f), line, text: m[0].trim() });
  192. }
  193. }
  194. }
  195. // 视觉高 < 44 是允许的(用 ::after 撑开触达区);此处只报告供人工核对
  196. pass(
  197. 'AC-13.3 触达区(提示)',
  198. `视觉高 <44px 的声明 ${hits.length} 处 —— 需人工确认均有 ::after 撑开触达区(筛选 chip/徽标属此列)`,
  199. );
  200. }
  201. /* ------------------------------------------------------------------ */
  202. /* AC-15.1 调试残留 → 0 处 */
  203. /* ------------------------------------------------------------------ */
  204. {
  205. const hits = scan(bizFiles, /\bconsole\.(log|debug)\s*\(/);
  206. if (hits.length === 0) pass('AC-15.1 无 console 残留', '0 处');
  207. else fail('AC-15.1 无 console 残留', `${hits.length} 处`, hits.slice(0, 20));
  208. }
  209. /* ------------------------------------------------------------------ */
  210. /* 全局 outline: none → 0 处 */
  211. /* ------------------------------------------------------------------ */
  212. {
  213. const hits = scan(bizFiles, /outline:\s*none/).filter((h) => !/focus-visible/.test(h.text));
  214. if (hits.length === 0) pass('全局 outline:none', '0 处');
  215. else fail('全局 outline:none', `${hits.length} 处(禁止全局移除焦点环)`, hits);
  216. }
  217. /* ------------------------------------------------------------------ */
  218. /* 裸断点(未走 mixin)→ 0 处 */
  219. /* ------------------------------------------------------------------ */
  220. {
  221. const styles = bizFiles.filter((f) => /\.(scss|ts)$/.test(f));
  222. const hits = scan(styles, /@media[^{]*\d+px/).filter(
  223. (h) => !/_breakpoints\.scss$/.test(h.file) && !/prefers-reduced-motion/.test(h.text),
  224. );
  225. if (hits.length === 0) pass('断点令牌化', '无裸断点');
  226. else
  227. fail(
  228. '断点令牌化',
  229. `${hits.length} 处裸断点(应用 _breakpoints.scss 的 mixin)`,
  230. hits.slice(0, 20),
  231. );
  232. }
  233. /* ------------------------------------------------------------------ */
  234. /* 输出 */
  235. /* ------------------------------------------------------------------ */
  236. const failed = results.filter((r) => !r.ok);
  237. console.log('\n[verify:ui] Fmode v2 · UI 规范断言');
  238. console.log(`口径:业务目录 ${bizFiles.length} 个文件;底座 src/app/ui/** 豁免\n`);
  239. for (const r of results) {
  240. const mark = r.ok ? '\x1b[32m✓\x1b[0m' : '\x1b[31m✗\x1b[0m';
  241. console.log(`${mark} ${r.name}`);
  242. console.log(` ${r.detail}`);
  243. for (const h of r.hits ?? []) {
  244. console.log(` · ${h.file}:${h.line} ${h.text}`);
  245. }
  246. }
  247. console.log('');
  248. if (failed.length === 0) {
  249. console.log(`\x1b[32m[verify:ui] ✓ ${results.length} 项断言全部通过\x1b[0m\n`);
  250. process.exit(0);
  251. } else {
  252. console.log(`\x1b[31m[verify:ui] ✗ ${failed.length}/${results.length} 项未通过\x1b[0m\n`);
  253. process.exit(1);
  254. }