reuse 是一项用于指导 UI 开发中代码复用的技能,核心是为“构建新东西”设定明确的优先顺序:项目自身的部件排在第一位,其次是维护良好的库或平台特性,自定义代码排在最后。
主要能力
技能将违反复用原则的情况视为“发现(finding)”,并给出成对的规则编号与正反示例。它把“复制项目已有的组件、样式或图标”判定为发现;而“向共享包添加原语后再使用”不算发现。若项目没有共享包,则以项目已依赖的库为判断依据。技能还划定了边界:裁减无人要求的内容属于“restraint”,照搬外部应用属于“match”,不在本技能范围内。
具体规则包括:
- reuse-house-component-first:写 UI 前先搜索共享组件包、图标集和设计令牌,并说明找到了什么。例如在项目已有 Input 组件旁手写原生 <input> 即属违规。
- reuse-no-local-restyle:已发布的组件保持出厂形态,使用其变体和 data-* 属性,不用本地 className 重新样式化。
- reuse-one-standard:每类事物只保留一种样式,例如一个菜单、一个表格、一个对话框外壳;出现第二种下拉样式即违规。
- reuse-fix-in-the-primitive:当修复适用于所有实例时,应改在共享组件内部,而不是逐个调用点打补丁。
- reuse-sweep-siblings:修复后要搜索所有同类位置,移除其本地修复并列出相关文件,只改被引用行不算完成。
- reuse-library-before-custom:项目自身没有时,优先使用维护良好的库或平台特性,例如用 Intl 格式化日期数字、用原生上下文菜单处理右键。
- reuse-no-stale-dependency:使用前检查库是否仍在维护;若已停止维护,应移植其模式而非安装依赖。
- reuse-read-the-docs:使用原语前先读文档,使用当前 API,避免猜测属性。
- reuse-icon-set-native-size:使用项目图标集,并按其绘制尺寸使用;生成 SVG 或将 18px 图标缩放到 12px 即违规。图标集缺失的字形由 icons 绘制并加入共享图标包后使用,不算发现。
使用方式
技能采用“成对”呈现:每个检查都给出违规写法与替代写法并列的示例,便于对照执行。报告时,每条发现对应一个根本原因,格式为“file:line - [规则编号] 问题描述”,随后附“规则 | 数量 | 严重程度”汇总。严重程度分三级:HIGH 表示重复了已有共享组件,或手写了原语已覆盖的控件;MEDIUM 表示本地重设样式、使用图标集之外的图标,或在单一调用点应用了本应在共享处完成的修复;LOW 表示选用库时未检查其维护状态。只要仍有 HIGH 即阻断,否则批准;未读过的文件不得批准,未执行的检查须标记为“未验证”。
适用场景
适用于前端 UI 开发与代码评审,尤其是存在共享组件包、设计令牌和图标集的项目,帮助减少重复实现、统一交互样式、提高修复的覆盖面。
限制
该技能仅覆盖复用顺序与相关检查,不涉及具体框架、组件库或安装方式;资料未提供具体安装命令、依赖清单、支持的平台或收费信息,暂未提供。