快速搭建自己的 git commit hooks 规范:使用 ESLint 和 husky

阅读时长 4 分钟读完

介绍

在团队协作开发中,代码规范是非常重要的。为了保证代码质量,我们可以使用 ESLint 和 husky 来快速搭建自己的 git commit hooks 规范。

ESLint

ESLint 是一个开源的 JavaScript 代码检查工具,可以帮助我们发现代码中的问题并进行修复。它可以识别出 JavaScript 代码中的语法错误、代码风格问题以及潜在的 bug。使用 ESLint 可以帮助我们避免在开发过程中出现一些常见的错误,提高代码的可读性和可维护性。

安装

在项目中安装 ESLint:

配置

在项目根目录下创建 .eslintrc.js 文件:

-- -------------------- ---- -------
-------------- - -
  -------- ---------------------- -------------------------------
  -------------- -
    ------------ -----
    ----------- ---------
  --
  ---- -
    -------- -----
    ---- -----
    ----- -----
  --
  ------ -
    ------------- ------
  --
--

这里我们使用了 eslint:recommendedplugin:prettier/recommended 这两个规则集,同时关闭了 no-console 这个规则。

使用

在项目根目录下运行:

这里的 . 表示当前目录,ESLint 会检查当前目录下所有的 JavaScript 文件。

husky

husky 是一个 Git 钩子工具,可以在 Git 的不同阶段执行自定义的脚本。使用 husky 可以在代码提交前进行代码检查、格式化、测试等操作,保证代码的质量和稳定性。

安装

在项目中安装 husky:

配置

package.json 文件中添加以下代码:

这里我们在 pre-commit 钩子中执行 npm run lint 命令,也就是在代码提交前进行代码检查。

使用

在项目中运行:

这时 husky 会在提交代码前自动执行 pre-commit 钩子中的命令,如果代码检查失败,则无法提交代码。

示例代码

下面是一个简单的示例代码:

-- -------------------- ---- -------
-- --------

----- --- - -- -- -
  -------------------
--

------

-- -- --- ------ - ---
-- --------
--   ---  -----  ---------- ------- ---------  ----------

-- ------------

-
  ------- -------------
  ---------- --------
  ---------- -
    ------- ------- --
  --
  -------- -
    -------- -
      ------------- ---- --- -----
    -
  --
  ------------------ -
    --------- ----------
    -------- ---------
    ------------------------- ---------
    ------------------------- --------
  -
-

总结

使用 ESLint 和 husky 可以帮助我们快速搭建自己的 git commit hooks 规范,保证代码的质量和稳定性。同时,我们也可以根据项目的需要自定义不同的代码检查规则和钩子操作。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/650ce81695b1f8cacd6a8b3c

纠错
反馈