Skip to main content
L

dsh-design-audit-to-code

liuhange789/dsh-design-audit-to-code

Design audit that returns the fix, not advice: Babel parses the pasted JSX/TSX into a real AST, hardcoded hex colours in colour properties and JSX colour props are rewritten to `var(--color-*)` tokens by hue family and lightness band, and the result comes back as a unified diff — edits are spliced into the original source by node offsets, so quotes, indentation and the rest of the file stay untouched. Deprecated components are flagged but never renamed, because an unverified rename compiles and then breaks props; semi-transparent colours are reported without a rewrite. Nothing is written to disk, and nothing is done with regex.

Install

dsh plugin --profile web add github:liuhange789/dsh-design-audit-to-code

README

dsh-design-audit-to-code

粘一段组件代码,拿回一份能直接应用的 unified diff。 Paste a component, get back a unified diff you can apply.

硬编码颜色不是“建议改一下”,而是改好给你看:#ff0000 → var(--color-danger),引号、缩进、其余代码一字不动。审计走 Babel AST,不走正则,所以字符串里的 #abcdef、注释里的色值都不会被误改。

Install

npm install @liuhange/dsh-design-audit-to-code
{
  "dsh": {
    "profile": {
      "bundles": [
        "@deepseek-ai/dsh-base",
        "@deepseek-ai/dsh-headless",
        "@liuhange/dsh-design-audit-to-code"
      ]
    }
  },
  "dependencies": {
    "@liuhange/dsh-design-audit-to-code": "0.1.0"
  }
}

Restart the profile. One tool appears: audit_ui_code.

Quick start

你:审计这个按钮组件,硬编码颜色换成设计 token
模型:audit_ui_code  code="<Button.tsx 的全部源码>"  filename="Button.tsx"

### 发现 4 个规范问题(3 处可安全自动修复)
- 🛠️ **Line 5** `'#ff0000'` → `'var(--color-danger)'`:硬编码颜色,改用设计 token
- 🛠️ **Line 6** `'#00aa55'` → `'var(--color-success)'`:硬编码颜色,改用设计 token
- 🛠️ **Line 10** `'#0b6bcb'` → `'var(--color-info)'`:硬编码颜色,改用设计 token
- ⚠️ **Line 18** `LegacyButton` → `Button`:废弃组件

以上 1 项只报告不自动改:重命名组件前需核对新组件的 props。

### 自动修复(Unified Diff)
```diff
--- Button.tsx
+++ Button.tsx
@@ -3,4 +3,4 @@
-    color: '#ff0000',
+    color: 'var(--color-danger)',

把 diff 交给 `git apply`,或让模型按 diff 直接改文件。工具本身**不落盘**——diff 就是产物。

## Command

### `audit_ui_code`

| 参数 | 必填 | 说明 |
| --- | --- | --- |
| `code` | 是 | 组件源码(JSX / TSX),从 `import` 到 `export` 完整粘贴 |
| `filename` | 否 | 文件名,用于 diff 头与报错定位,默认 `Component.tsx` |
| `framework` | 否 | 目前只支持 `react`(JSX/TSX 语法),默认 `react` |

返回:`filename`、`issueCount`、`fixedCount`、`changed`、`issues`(`line` / `column` / `rule` / `message` / `original` / `replacement` / `fixed`)、`diff`、`elapsedMs`。

返回 `diff` 为空字符串表示没有可安全自动修复的问题(可能仍有只报告项,看 `issueCount`)。`column` 为 1-based。

## 检查规则

### 1. 硬编码颜色 → 设计 token(自动修复)

命中位置:

- JSX 属性:`color`、`backgroundColor`、`borderColor`、`outlineColor`、`fill`、`stroke` 等颜色类属性上的字符串字面量,含 `color="#ff0000"` 与 `color={'#ff0000'}` 两种写法
- 对象属性(内联样式 / 主题对象):`color`、`backgroundColor`、`background`、`borderColor`、`borderTopColor`、`borderRightColor`、`borderBottomColor`、`borderLeftColor`、`outlineColor`、`caretColor`、`textDecorationColor`、`fill`、`stroke`、`stopColor`、`floodColor`

只处理 `#rgb` / `#rgba` / `#rrggbb` / `#rrggbbaa` 字面量。全透明(alpha = 0)跳过;半透明(0 < alpha < 1)只报告不改,因为单一 `var(--color-*)` 承载不了透明度。

映射算法(HSL):

| 维度 | 规则 |
| --- | --- |
| 色相 → 语义族 | 低饱和(< 0.12)→ `neutral`;否则 hue 分段 → `danger` / `warning` / `success` / `info` / `accent` |
| 明度 → 档位 | 400–600 → `var(--color-<family>)`;其余 → `var(--color-<family>-<shade>)` |
| 换色方式 | 只替换字面量本身,保留原引号与缩进;不重新格式化代码 |

如果你的设计系统 token 不叫 `--color-*`,把 diff 里的名字批量替换即可——映射表本身是显式的,不做隐式猜测。

### 2. 废弃组件(只报告,不改名)

| 废弃组件 | 建议替代 |
| --- | --- |
| `LegacyButton` | `Button` |
| `OldModal` | `Modal` |
| `DeprecatedInput` | `Input` |
| `OldTable` | `Table` |

**为什么不自动改名**:`<LegacyButton variant="ghost" />` 改成 `<Button />` 能编译,但 props 语义可能不同(`variant` 值域、事件签名、受控与否)。自动重命名会把编译错误换成运行时错误,所以这里只标注行号,由你确认。

## Runtime contract

- **AST 而非正则**:`@babel/parser` + `@babel/traverse` 解析;字符串、注释、模板文本里的相似文本不会被误改。
- **最小 diff**:按节点 `start/end` 做源码区间替换,不重新生成代码,因此不会出现引号风格翻转、尾部分号漂移这类噪声。
- **不落盘**:只返回 diff 与问题清单,写入与否由调用方决定。
- **纯静态**:不执行代码、不加载组件、不引浏览器内核。
- **速度**:常规组件解析 + 审计 < 200ms(见返回的 `elapsedMs`)。
- 解析失败时返回可读的错误(含行/列与原文片段),不会静默通过。

## Known limits

- 只识别**字面量**颜色:`theme.colors.danger`、`` `${brand}` ``、`rgb()`/`hsl()` 字符串不在本次规则内(无需求时不臆造映射)。
- 只覆盖 `.tsx` / `.jsx` 源码字符串;`.css` / `.scss` / `.less` 与 `<style>` 标签内的样式不走这条工具。
- 不做跨文件组件名解析:同名组件来自哪个文件、是否真的废弃,需在仓库级 lint 里核对。
- 不修改非颜色属性(间距、字号、圆角、阴影结构等)——这些规则的“正确值”依赖你的设计系统,硬编码一张表只会制造错误修复。

## Development

```bash
npm install
npm run typecheck   # strict, no any
npm test            # build + real plugin load + real calls

License

MIT

Related plugins