SuperAPI AI 工具集

coding-standards

编程与开发

查看项目

更新于 10-16 01:12

技能介绍

用途:为代码的编写、编辑和评审提供统一规范。规则分两组:通用规则(references/common/,约束函数、类、模块内部写法,不分语言)与按框架划分的规则(references/<framework>/,约束目录布局与框架模式)。每次任务都同时应用通用规则和且仅一个框架规则。

主要能力:通过信号自动识别框架(依据文件类型、配置文件、package.json 依赖等),按文件而非按仓库判断,适配 monorepo;解析并记录项目结构,写入 .coding-standards-structure 文件,避免重复询问;根据任务规模选择编排器管线(多文件、新功能、diff/PR 评审、--thorough、/coding-standards 命令)或单代理内联执行(单文件小改、单函数重构、规则问答);用任务列表跟踪整个流程;识别默认排除项、生成标记(@generated、DO NOT EDIT 等)及 .coding-standards-ignore 中的文件,并拒绝修改工具生成的代码。

必要用法:首次会话可运行只读检查 python3 <skill-dir>/bootstrap.py --verify,退出码 0 表示钩子已就绪;未安装时需先征得用户同意再执行 python3 <skill-dir>/bootstrap.py --auto-install,如启用注释评判需加 --with-comment-judge。安装会写入 .claude/settings.json 钩子、添加 /coding-standards 斜杠命令、安装 tree-sitter Python 包、追加允许规则并在项目根生成忽略模板。安装后需重启会话钩子才生效;重启前写时拦截不生效,应手动运行 python3 <skill-dir>/hooks/review-files.py <file> … 作为补偿检查。

适用场景:遵循规范的编码、重构、代码评审、PR 评审,以及查询规范含义(如 FN-005)和查看规则索引。

限制:Angular、Svelte/SvelteKit、Astro、Remix、Unity、Godot、Ruby/Rails、Rust、Swift、Flutter、Android 原生等已识别但无结构参考,不回落 vanilla-js,仅应用通用规则;无法确定框架时应询问一次而非猜测。收费、价格等细节资料未提供。