SuperAPI AI 工具集

dx-audit

通用与其它

查看项目

更新于 10-16 06:46

技能介绍

用途:对开发者实际接触的公开面做有边界的审查,包括公开 API、面向开发者的错误、CLI 命令、导出类型、安装与首次运行行为以及配置;仅在用户明确要求时才做修复。它不负责仓库整体质量清扫、终端用户 UI、智能体信任审查、公开站点或文档评分、文档行文或 README、仓库架构,也不用于新建 CLI。

模式:Targeted(默认,针对指定或改动的公开面,只读输出发现报告)、Fix(用户说 fix/improve/simplify/implement 时,在范围内做局部修改并验证)、Exhaustive(用户明确要求整个包或全部公开面时,按面分区列出所有实质发现)。开始前先写一行范围回执,例如 Scope: <mode>; surfaces: <commands/exports/config>; prefixes: <err-, cli->; excludes: <UI, docs, architecture, private internals>。

流程:先锁定公开面并写范围回执;再收集本地证据并运行安全探测;然后按面选择规则前缀并打开候选规则;接着按根因排序;最后报告,或在被要求时修复,并在同一范围上验证。

规则前缀与优先级:api-(公开 API 与 SDK,CRITICAL,7 条)、err-(开发者错误,CRITICAL,5 条)、cli-(面向人与智能体的 CLI 体验,HIGH,13 条)、types-(导出类型易用性,HIGH,5 条)、onboard-(安装与首次运行,HIGH,5 条)、config-(配置易用性,MEDIUM,3 条)。适用性优先于优先级,例如仅 CLI 的审查不会加载 api-。

安全探测:CLI 可运行 --help、--version、一条成功路径、一条无效输入路径,以及用 | cat 管道运行同一命令观察非 TTY 行为;不要为测试 DX 触发真实变更,有 --dry-run 时使用它。包可在构建后运行 npx publint 和 npx @arethetypeswrong/cli --pack .,但打包可能触发生命周期脚本,需先检查脚本或使用一次性检出。

限制与注意:npx <pkg> 和全局安装探测的是注册表副本而非工作树,应构建后调用本地入口(如 node ./dist/cli.js)。管道下 process.stdout.isTTY 为 undefined 而非 false,写成 isTTY === false 的守卫不会在管道时关闭颜色或加载动画。console.log 后立即 process.exit(1) 在管道下可能截断输出,应改用 process.exitCode = 1 并自然返回。exports 映射看似正确仍可能解析错误,需用 publint 和 attw 验证。审查请求默认只读;修复请求只授权回执范围内的局部改动。资料未提供具体收费、价格或平台信息。