规范提交 Husky 与 Lint-Staged 如何优雅地把代码提交做成一件有质量的事？

2024-02-20 07:54:02

使用 Husky 和 Lint-Staged 实现提交规范

作为一名出色的前端工程师，提交规范是至关重要的，它能让你写出优雅的代码并养成良好的编码习惯。本文将介绍如何利用 Husky 和 Lint-Staged 轻松实现提交规范，从而提升代码的可维护性和可审查性。

Husky 本质上是一个 Git 钩子，允许你在不同的 Git 工作流中运行脚本。你可以配置 Husky 在提交前或后执行特定脚本。如果你在提交前执行的脚本失败，它将阻止你的提交。

Lint-Staged 也是一个 Git 钩子，但它只在暂存区发生变化时运行脚本。这意味着当你运行 git add 命令时，Lint-Staged 会执行你配置的脚本，例如检查代码的语法或格式。

第一步：安装 Husky 和 Lint-Staged

npm install husky lint-staged --save-dev

第二步：配置 Husky

在项目根目录创建一个 .huskyrc 文件，并添加以下内容：

#!/bin/sh

npx lint-staged

第三步：配置 Lint-Staged

在项目根目录创建一个 .lintstagedrc 文件，并添加以下内容：

module.exports = {
  '*.js': [
    'eslint --fix'
  ]
};

第四步：运行 Husky

运行以下命令以运行 Husky：

npx husky install

Husky 和 Lint-Staged 可以通过以下方式帮助你实现提交规范：

使用 Husky 检查提交信息： 你可以配置 Husky 在提交前运行一个脚本，对提交信息进行验证。如果提交信息不符合规范，脚本将失败并阻止提交。
使用 Lint-Staged 检查代码： 你可以配置 Lint-Staged 在暂存区发生变化时运行一个脚本，对代码进行检查。如果代码不符合规范，脚本将失败并阻止提交。