关于 commitlint
面向 AI Agent 的 commitlint 文档参考技能,按任务组织内容,帮助定位所需指南。涵盖 commitlint v21.2.3 的设置、配置、规则、API、概念、故障排查和示例。
主要功能
- 01按任务映射文档类别
- 02安装与 CI 设置指南
- 03CLI 选项、配置和规则
- 04Node.js API 与 Conventional Commits 参考
- 05故障排查与迁移指南
适用场景
- 01查找仓库的 commitlint 设置步骤
- 02查询规则设置或 CLI 选项
- 03了解 Node.js lint API 用法
- 04排查错误或规划升级
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ fandhe-ai/ agent-reference-skills --skill commitlint安装后在 Claude Code 中输入/commitlint确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/api/format.mdlint.mdload.mdread.mdREADME.mdreferences/concepts/commit-conventions.mdREADME.mdshareable-config.mdreferences/guides/ai-agents.mdci-setup.mdgetting-started.mdlocal-setup.mdREADME.mduse-prompt.mdreferences/reference/cli.mdcommunity-projects.mdconfiguration.mdexamples.mdplugins.mdprompt.mdREADME.mdrules-configuration.mdrules.mdreferences/support/README.mdreleases.mdtroubleshooting.mdupgrade.mdsamples/ci-github-actions.mdconfiguration-formats.mdcustom-rules.md详细介绍
commitlint 参考
涵盖 commitlint 官方文档中所有 API 和指南的技能。 根据用户的任务读取合适的 README.md,并从中查找对应的文件。
适用于 commitlint v21.2.3(Node.js >= 22.12.0 / git >= 2.13.2;v21.0.0 将最低 Node 版本提高至 v22,并更改了输入显示格式)。
目录结构
skills/commitlint/
SKILL.md
references/
guides/
README.md
ai-agents.md
ci-setup.md
getting-started.md
local-setup.md
use-prompt.md
reference/
README.md
cli.md
community-projects.md
configuration.md
examples.md
plugins.md
prompt.md
rules.md
rules-configuration.md
api/
README.md
format.md
lint.md
load.md
read.md
concepts/
README.md
commit-conventions.md
shareable-config.md
support/
README.md
releases.md
troubleshooting.md
upgrade.md
samples/
README.md
getting-started.md
local-setup-husky.md
custom-rules.md
shareable-config.md
ci-github-actions.md
configuration-formats.md
validate-issue-reference.md
scripts/
README.md
install.md
setup.md
cli.md
validate.md
prompt.md
探索步骤
根据任务查找对应类别,再通过该类别的 README.md 找到目标页面:
- 在下方的映射表中查找与任务对应的类别
- 参阅该类别的
references/{category}/README.md,找到目标页面 - Read 对应的
.md文件,查看详细信息
任务 → 类别映射
| 任务 | 类别 | 参考 README |
|---|---|---|
| 安装、初始设置、Husky 集成、Git 钩子设置 | guides | references/guides/README.md |
| 在 CI 环境(如 GitHub Actions)中配置 commitlint | guides | references/guides/README.md |
| 与 AI Agent(Claude Code、Copilot、Cursor)集成 | guides | references/guides/README.md |
| 交互式编写提交消息(prompt-cli) | guides | references/guides/README.md |
| CLI 选项、配置文件格式、所有选项 | reference | references/reference/README.md |
| 规则列表、规则配置(Level / Applicable / Value) | reference | references/reference/README.md |
| 创建和注册插件 | reference | references/reference/README.md |
| cz-commitlint 提示词配置 | reference | references/reference/README.md |
| @commitlint/lint、load、read、format 的 Node.js API | api | references/api/README.md |
| lint 结果的格式化和输出 | api | references/api/README.md |
| Conventional Commits 格式、作用域的处理 | concepts | references/concepts/README.md |
| 创建和分发共享配置(shareable config) | concepts | references/concepts/README.md |
| 错误解决、常见问题排查 | support | references/support/README.md |
| 版本升级、从 validate-commit-msg 迁移 | support | references/support/README.md |
| 查看典型用法和配置示例 | samples | samples/README.md |
| 了解安装、CLI 命令、验证命令 | scripts | scripts/README.md |
评论
支持 Markdown