18.8K ·GitHub
这是干什么用的?
commitlint 用于检查你的提交信息是否符合约定式提交格式,并按照可配置的规则集对它们进行校验。
commitlint 用于检查你的提交信息是否符合约定式提交格式,并按照可配置的规则集对它们进行校验。它是命令行工具,还是我在代码里调用的库?主要是一个命令行工具 @commitlint/cli,用来对提交信息进行校验。它也提供 JavaScript 编程接口,包含 lint、load、read 和 format 方法,方便集成到其他工具里。
主要是一个命令行工具 @commitlint/cli,用来对提交信息进行校验。它也提供 JavaScript 编程接口,包含 lint、load、read 和 format 方法,方便集成到其他工具里。怎么把它加到我的项目里?把 @commitlint/cli 安装为开发依赖,添加一个包含规则的 commitlint.config.js 或 .commitlintrc 文件,然后用 husky 在每次提交时执行校验,或者放在 CI 构建中运行。
把 @commitlint/cli 安装为开发依赖,添加一个包含规则的 commitlint.config.js 或 .commitlintrc 文件,然后用 husky 在每次提交时执行校验,或者放在 CI 构建中运行。我的电脑上需要装些什么才能运行?需要 Node.js LTS >= 22.12.0 和 git >= 2.13.2,也就是说要求比较新的 Node 版本。
需要 Node.js LTS >= 22.12.0 和 git >= 2.13.2,也就是说要求比较新的 Node 版本。配置好之后,我可以一直用旧版本吗?不太可靠——这个项目没有赞助方,无法保证为旧版本及时发布补丁,所以遇到安全修复时,你可能得自己提交一个 PR。
不太可靠——这个项目没有赞助方,无法保证为旧版本及时发布补丁,所以遇到安全修复时,你可能得自己提交一个 PR。这是小众的实验项目,还是经过大量实战检验的工具?经过大量实战检验:README 称 commitlint 已经很稳定,在各种项目中作为开发工具使用,在 GitHub 上约有 18.7k 颗星。
经过大量实战检验:README 称 commitlint 已经很稳定,在各种项目中作为开发工具使用,在 GitHub 上约有 18.7k 颗星。默认配置识别哪些提交类型?commitlint-config-conventional 基于 Angular 约定,内置了 build、chore、ci、docs、feat、fix、perf、refactor、revert、style 和 test 这些类型,并且可以通过你自己的配置进行修改。
commitlint-config-conventional 基于 Angular 约定,内置了 build、chore、ci、docs、feat、fix、perf、refactor、revert、style 和 test 这些类型,并且可以通过你自己的配置进行修改。使用约定式提交信息到底有什么好处?README 列出了三点好处:做一个合格的 commitizen、通过 npm 共享配置,以及利用 conventional-changelog,它能根据约定式提交历史自动生成变更日志。
README 列出了三点好处:做一个合格的 commitizen、通过 npm 共享配置,以及利用 conventional-changelog,它能根据约定式提交历史自动生成变更日志。有现成的规则集吗,还是必须自己写配置?有——共享配置包括 @commitlint/config-angular、config-conventional,以及针对 Lerna、Nx、workspaces 和 Patternplate 的作用域检查预设;社区配置则遵循 commitlint-config- 这样的命名模式。
有——共享配置包括 @commitlint/config-angular、config-conventional,以及针对 Lerna、Nx、workspaces 和 Patternplate 的作用域检查预设;社区配置则遵循 commitlint-config- 这样的命名模式。它和 commitizen 配合得好吗?配合得很好,它有 commitizen 适配器和交互式提问包 @commitlint/prompt-cli——commitlint 仓库自己就用它作为提交脚本。
配合得很好,它有 commitizen 适配器和交互式提问包 @commitlint/prompt-cli——commitlint 仓库自己就用它作为提交脚本。What are similar projects?husky, react-doctor, stylelint, knip, super-linter, rust-clippy, changesets, openqodex
husky, react-doctor, stylelint, knip, super-linter, rust-clippy, changesets, openqodexWhich topics is it in?commit, lint, linter, version-control, code-quality, best-practices, monorepo, ci, git, devops, npm, automation
commit, lint, linter, version-control, code-quality, best-practices, monorepo, ci, git, devops, npm, automation