介绍
npm 是前端领域中管理包和依赖的利器，derek 是一款用于检查提交信息是否满足规范的 npm 包，其具有灵活性和易扩展性，被广泛应用于开源社区及企业内部项目中。
本文将为大家详细介绍 derek 的使用方法，希望能够帮助大家规范提交信息并提高代码质量。
安装
derek 可以通过 npm 进行安装，打开命令行界面，输入以下命令：
--- ------- ----- --
使用
配置文件
derek 在使用前需要有校验规则，这些规则需要通过配置文件来定义。可以在项目的根目录下新建一个 .derekrc 文件，并添加以下内容：
-
------------------ -
------------------- -
---------- ----------- -- -----
----------- -
------------ --
-
--
----------------------- -
---------- ------------------
----------- -
----------------- ----
-
--
------------------ -
---------- ----------- --- -----
----------- -
------------ ---
-
-
-
-上述配置文件中定义了三条规则：
title-min-length：提交信息标题不能少于 10 个字符title-capitalization：提交信息标题首字符应为大写字母body-max-length：提交信息正文不能超过 100 个字符
您可以按照上述样式自定义规则，也可以从社区已有的规则库中引用。
规范提交信息
在过去的项目中，我们可能会看到这样的提交信息：
--- - ---
这个提交信息不仅含义模糊，还缺少关键信息。我们需要一种工具来规范提交信息。
derek 可以检查您的提交信息是否符合校验规则，通过以下命令来提交代码：
--- ------ -- ---- ------- --
这时，derek 会自动检测您的提交信息，如果符合规则，会返回 PASSED，否则会给出错误信息。
扩展规则
如果您需要自定义规则，可以在 .derekrc 文件中新增规则即可。derek 支持多种规则类型，包括正则表达式、字符串匹配、最大长度等。
例如，我们需要加入一个规则：不允许提交信息开头带有冒号：
-
------------------ -
------------------- -
---------- ----------- -- -----
----------- -
------------ --
-
--
----------------------- -
---------- ------------------
----------- -
----------------- ----
-
--
------------------ -
---------- ----------- --- -----
----------- -
------------ ---
-
--
------------------- -
---------- ----------------
----------- -
-------------- -
-------- -------
-
-
-
-
-总结
derek 是一款方便易用的 npm 包，可以帮助我们规范提交信息，确保代码质量。在使用 derek 前，需要定义校验规则，并在提交代码时完成校验。希望该教程能够帮助大家更好地使用 derek。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60065f8c238a385564ab6e8c