什么是 @commitlint/to-lines？
@commitlint/to-lines 是一个用于将 git commit message 转换为数组的 npm 包。它会将 commit message 中的每一行作为一个字符串，存储在一个数组中。
此外，@commitlint/to-lines 还具有过滤功能，可以通过配置来忽略空行或注释等。
安装
要安装 @commitlint/to-lines，您需要在控制台中运行以下命令：
npm install --save-dev @commitlint/to-lines
使用
使用 @commitlint/to-lines 非常容易。只需要导入该包并传入 commit message 就可以了。以下是一个示例：
-- -------------------- ---- ------- ----- ------- - -------------------------------- ----- ------- - ---- --- ------- ---- -- --- ----------- -- --- --- ---------- ----- ----- - ----------------- -------------------展开代码
该示例将输出以下内容：
[ 'Add new feature', '', 'This is the description of the new feature.' ]
过滤
您可以在传递 commit message 给 @commitlint/to-lines 时，同时传递一个配置对象。配置对象可以用来过滤不需要的行。例如，如果您想忽略注释行，可以这样写：
-- -------------------- ---- ------- ----- ------- - -------------------------------- ----- ------- - ---- --- ------- ---- -- --- ----------- -- --- --- -------- - ---- -- - --------- ----- ------- - - ------------ --- -- ----- ----- - ---------------- --------- -------------------展开代码
输出：
[ 'Add new feature', '', 'This is the description of the new feature.' ]
以上代码中的 commentChar 属性用于指定注释行的注释字符。
同样的，如果您想忽略空行，可以传递 ignoreEmpty: true 选项。
总结
@commitlint/to-lines 是一个非常有用的 npm 包，可以将 git commit message 转换为数组。在使用它时，您可以选择性地忽略不需要的行，例如注释或空行。它可以帮助您更好地解析 commit message，并帮助您的团队遵循更好的编码规范。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/199044
