什么是 @commitlint/is-ignored
@commitlint/is-ignored 是一个 npm 包，用于检查 Git 提交是否被忽略。它通过解析 .gitignore 文件和 .git/info/exclude 文件来判断一个提交是否应该被忽略。
为什么要使用 @commitlint/is-ignored
当开发人员在提交代码时，通常会忽略某些文件或目录，如日志、缓存或编译输出等。但是，如果在提交时不进行验证，这些文件或目录可能会被包含在提交中，从而增加存储和维护成本。使用 @commitlint/is-ignored 可以帮助开发人员自动验证提交中是否包含了被忽略的文件或目录，从而减少代码仓库的体积和冗余。
如何使用 @commitlint/is-ignored
下面我们将介绍如何在项目中使用 @commitlint/is-ignored。
安装
npm install @commitlint/is-ignored --save-dev
使用
在 Git 钩子中使用 @commitlint/is-ignored，可以在提交代码前自动验证是否包含被忽略的文件或目录。
// package.json { "scripts": { "precommit": "commitlint --edit $1 && node ./scripts/pre-commit.js" } }
-- -------------------- ---- ------- -- ----------------------- ----- - ------------ - - -------------- ----- - --------- - - --------------------------------- ----- ------------- - ----------------------------- ----- --------- - --------------------------- ---------------- ----- ------- - ------------------------- -- ------------------ -- ----------------------- --- ---- - ------------------ --- ------ -- ------ ------- -------- --------- ---------------- -展开代码
在上面的示例中，我们在 precommit Git 钩子中运行 commitlint 来验证提交消息格式，并在 node ./scripts/pre-commit.js 前添加了一个 && 符号，以执行我们自定义的提交前验证脚本。验证脚本中，我们先读取了 commit-msg 文件，然后使用 isIgnored 函数来获取被忽略的文件或目录列表，并遍历这个列表，检查是否存在于提交信息中。
配置
你可以在项目根目录下创建一个 .commitlintrc.js 文件来配置 @commitlint/is-ignored。
-- -------------------- ---- ------- -- ---------------- -------------- - - ------------- - ----------- - ----- ------- -- - -- ---------- --------- -- ---------------- - ------ ----- - - - - -展开代码
在上面的示例中，我们配置了 warn 参数，禁止 @commitlint/is-ignored 发出 "Nothing specified in " 的警告信息。
总结
使用 @commitlint/is-ignored 可以有效地帮助开发人员验证提交中是否包含被忽略的文件或目录，从而减少代码仓库的体积和冗余。本文介绍了如何使用 @commitlint/is-ignored，并展示了一个 Node.js 的示例代码。如果你想要更深入地了解如何使用 @commitlint/is-ignored，请参考官方文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/110697
