用途
web-design-guidelines 用于审查文件是否符合 Web Interface Guidelines(Web 界面指南)。它面向 UI 代码审查场景,帮助检查界面实现与指南规则的一致性。
主要能力
- 在每次审查前从源地址获取最新的指南规则,确保使用最新版本。
- 读取用户指定的文件或文件模式。
- 将文件内容与获取到的指南中的所有规则进行对照检查。
- 以简洁的 file:line 格式输出发现的问题。
使用方式
当用户提供文件或模式参数时:
-
从以下源地址获取指南:
https://raw.githubusercontent.com/vercel-labs/web-interface-guidelines/main/command.md
-
读取指定的文件。
-
应用获取到的指南中的所有规则。
-
使用指南中指定的格式输出发现的问题。
如果未指定文件,则询问用户需要审查哪些文件。
获取指南时使用 WebFetch 检索最新规则。获取到的内容包含所有规则以及输出格式说明。
适用场景
适用于被要求执行以下操作的场景:
- “review my UI”(审查我的 UI)
- “check accessibility”(检查无障碍)
- “audit design”(审计设计)
- “review UX”(审查 UX)
- “check my site”(检查我的网站)
限制
- 审查依赖从上述源地址获取的指南内容;若无法获取,则无法按最新规则执行。
- 需要用户提供文件或文件模式;未提供时需先询问。
- 关于收费、价格、平台支持范围等信息,资料中暂未提供。