使用 husky 和 lint-staged 检查 Node.js 的代码一致性

2024-06-08 17:50:00

在软件开发过程中，代码风格检查（Code Linting）是保障代码规范和一致性的有效手段。过去，Lint 的工作一般在 Code Review 或者 CI 的时候进行，但这样会导致问题的反馈链，浪费不必要的时间。因此，我们需要利用 Git 的 Pre Commit 钩子，将 Lint 过程放到开发者提交代码之前。

本文将会重点介绍如何使用 husky 和 lint-staged 来检查 Node.js 项目的代码一致性。其中 husky 用于设置本地的 Git 钩子，lint-staged 会让钩子只检查本次提交所修改的文件。

安装 husky 和 lint-staged

首先，我们使用下面的命令把 husky 和 lint-staged 安装到 Node.js 项目的 devDependencies 中：

$ npm install husky lint-staged --save-dev
复制代码

如果你使用的是 Yarn，请使用下面的命令

$ yarn add husky --dev
复制代码

修改 package.json 配置

将下面的代码加入 package.json文件中：

{"husky": {"hooks": {"pre-commit": "lint-staged"}},"lint-staged": {"src/**/*.ts": ["tslint --project . --format stylish"],"src/**/*.{css,scss}": ["stylelint --config src/stylelint.config.json"]}
}
复制代码

这样，当在终端输入 git commit 命令提交代码的时候，Lint 程序便会自动检查本次提交所修改的文件是否符合本项目的代码规范。如果代码不符合规范，便会拒绝提交代码。

如果想要跳过 Lint 程序，可以使用 git commit -no-verify 进行提交。

查看原文： myanbin.github.io/post/lintin…

使用 husky 和 lint-staged 检查 Node.js 的代码一致性相关推荐

node/js 漏洞_6个可用于检查Node.js中漏洞的工具
node/js 漏洞 Vulnerabilities can exist in all products. The larger your software grows, the greater th ...
WebStorm 打开Node.js的代码提示功能
Node.js coding assistance is disabled,Suggests configuring coding assistance for Node.js core module ...
node.js 后台代码怎么部署到服务器上？
服务器先安装node 安装node,进入到想要把node下载到的那个文件夹下.本文是/usr/local cd /usr/local wget https://nodejs.org/dist/v8.9 ...
UDP IPv4广播地址计算（附Node.js示例代码）
文章目录目的计算方法示例代码代码演示总结目的 UDP广播是比较常用的一种功能,应用方面来说经常用在设备发现等功能中.UDP广播需要知道广播地址,这篇文章将介绍通过IPv4地址和子网掩码来计 ...
成为自信的node.js开发者（一）
这个博客是我最近整理了过去的文章. 适合阅读的同学想更进一步深入理解node的同学,如果你已经稍微了解一点点node, 可以用node做一些小demo,并且想更深一步的了解,希望这篇文章可以帮助到你 ...
Node.js基础总结
一.Node.js简介什么是Node.js js 属于一种脚本性语言,然而脚本语言运行需要一个解析器来解析,对于我们原来写的 js 代码大部分都是运行在网页上,所以浏览器本身就担当了解析器的角色.而 ...
node.js和npm版本升级及升级过程中遇到的问题和解决方案
Node.js和NPM版本升级 1. 安装Node.js 1.1 版本检查 1.2 下载安装程序 1.3 安装 2. npm升级 2.1 版本检查 2.2 升级 3. 检查Node.js和npm之间的 ...
在Ubuntu 14.04上设置生产环境可用的Node.js
在Ubuntu 14.04上设置生产环境可用的Node.js 提供:ZStack社区前言 Node.js是一个开源的JavaScript运行时环境,开发者可以用它方便的构建服务器端应用和网络应用.N ...
windows node.js 安装
最近基础到vue 看到vue-cli 我以前是用vue.js 文件渲染前台的文件那么vue-cli是干嘛的啊带着疑问,带着好奇,我看到了一篇博客 https://blog.csdn.net/muz ...

最新文章

热门文章