简介
@commitlint/parse 是一款用于解析 Git 提交信息（commit message）的 npm 包。Git 提交信息是开发者在提交代码时填写的一段文本，通常包含了本次代码变更的种类、原因、具体变更内容等信息。
使用 @commitlint/parse 可以对 Git 提交信息进行语义分析，检查其中是否包含不规范、无意义或者不符合格式要求的内容。这可以提高代码提交的一致性和可读性，让代码版本控制更加规范、清晰。
安装
在终端输入以下命令即可使用 npm 安装 @commitlint/parse：
npm install @commitlint/parse --save-dev
使用
使用 @commitlint/parse 主要有两种情况：
- 读取 Git 提交信息并进行语义分析
- 另写一段文本并进行语义分析
读取 Git 提交信息并进行语义分析
使用 @commitlint/parse 可以轻松读取 Git 提交信息，并进行语义分析。
首先，需要在 Git 仓库中获取最新的提交信息，并将信息传递给 @commitlint/parse 进行处理。
const parse = require('@commitlint/parse').default;
const { promisify } = require('util');
const exec = promisify(require('child_process').exec);
(async () => {
const message = await exec('git log -1 --pretty=%B');
const parsed = parse(message.stdout);
})();上述代码中，通过 child_process 的 exec() 函数读取 Git 提交信息，最后将信息传递给 parse() 函数进行语义分析。parse() 函数返回一个对象，包含以下属性：
type：表示提交信息的类型，例如feat、fix等scope：表示本次提交的变更范围subject：表示本次提交的主题内容body：表示本次提交的详细内容footer：表示本次提交的尾注信息
console.log(parsed); // { type: 'feat', scope: null, subject: 'add feature A', body: 'This feature can improve user experience.', footer: null }另写一段文本并进行语义分析
@commitlint/parse 也可以对另写一段文本进行语义分析，检查文本是否符合指定的 Git 提交信息格式规范。
const parse = require('@commitlint/parse').default;
const message = 'feat: add feature A\n\nThis feature can improve user experience.';
const parsed = parse(message);
console.log(parsed); // { type: 'feat', scope: null, subject: 'add feature A', body: 'This feature can improve user experience.', footer: null }自定义配置
默认情况下，@commitlint/parse 会使用 conventional commit 规范 进行语义分析。如果需要更改默认配置，可以使用 @commitlint/config-conventional 模块，也可以自行编写配置文件。
使用 @commitlint/config-conventional 模块可以快速配置常用的 commit message 规范，例如 Angular 规范、ESLint 规范等。
接下来，我们使用 @commitlint/config-conventional 模块，并创建一个自定义的配置文件 commitlint.config.js。
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
'header-max-length': [2, 'always', 100],
'subject-case': [2, 'never', ['upper-case']],
},
};上述配置文件中:
extends属性：表示继承的规范，可以是 npm 包或本地文件rules属性：表示自定义的规则，可以覆盖继承的规范或添加新规则
其中，'header-max-length' 和 'subject-case' 是两个自定义规则，用于控制提交信息的长度和格式。
最后，在终端中执行以下命令，即可使用自定义配置对 Git 提交信息进行语义分析：
echo 'feat: add feature F' | npx commitlint
结论
使用 @commitlint/parse 可以轻松读取 Git 提交信息，并进行语义分析。自定义配置可以使语义分析更加灵活、规范化。使用 commit message 规范可以提高代码提交的一致性和可读性，从而促进代码质量的不断提高。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/110698