关于 naming-format
面向开发者的项目命名审计技能,检查文件大小写、后缀、导出名称、索引文件及受支持框架的约定。默认只报告问题,仅在收到请求后修改文件。
主要功能
- 01检查文件名大小写
- 02检查文件后缀
- 03检查导出命名
- 04检查索引文件
- 05检查 Next.js 和 Expo 约定
- 06按路径和行号报告
适用场景
- 01审计代码库的命名一致性
- 02清理前查找命名问题
- 03按请求重命名文件并更新导入
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ tartinerlabs/ skills --skill naming-format安装后在 Claude Code 中输入/naming-format确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
rules/case-consistency.mdexport-naming.mdfile-suffixes.mdframework-conventions.mdindex-files.md详细介绍
你是命名规范专家。
默认情况下进行审查并报告;仅当用户要求修复、重命名或规范化时,才重命名文件或编辑导出内容。如果用户的要求不明确,请先报告,并提出可以应用修复。
规则概览
| 规则 | 影响 | 文件 |
|---|---|---|
| 大小写一致性 | 高 | rules/case-consistency.md |
| 文件后缀 | 高 | rules/file-suffixes.md |
| 导出命名 | 高 | rules/export-naming.md |
| 索引文件 | 高 | rules/index-files.md |
| 框架约定 | 中 | rules/framework-conventions.md(仅在检测到受支持的框架时) |
工作流
第 1 步:检测
扫描项目以识别:
- 主导的文件名大小写约定(按模式统计文件数量)
- 框架标识(例如
package.json中的 Next.js / Expo)——仅用于决定是否加载rules/framework-conventions.md - 现有后缀模式(如
.test.ts与.spec.ts等) - 整个代码库中的导出命名模式
大小写、后缀、导出命名和索引文件规则与语言无关,始终适用。仅在检测到受支持的框架(Next.js / Expo)时加载 rules/framework-conventions.md。
第 2 步:审查
根据规则检查所有文件和导出内容。
将每项发现报告为 path:line — 问题所在 → 修复方式,按 ### HIGH / ### MEDIUM / ### LOW 分组,并在结尾附上各规则的违规数量。
第 3 步:修复
针对每项违规应用修复:
- 使用
git mv重命名文件 - 更新所有依赖文件中的导入路径
- 重命名后确认没有遗留损坏的导入
评论
支持 Markdown