1. 概述

规范化是践行前端工程化过程中重要的组成部分,俗话说没有规矩不成方圆,做人做事都是一样,尤其是在开发行业中,更是需要有严谨的工作态度。大多数情况下软件开发都不是一个人的工作,需要多人协同的,而不同的开发者有不同的编码习惯和喜好。这些个人的喜好并没有什么不好的地方,只是说如果同一个项目中,每个人的喜好都不相同。那就会导致项目的维护成本大大提高。

所以就需要为每个项目或者说团队明确一个统一的标准,让这个项目或者团队成员按照统一的标准去完成工作,从而避免各种不统一带来的麻烦。

因此在开发过程中所编写的代码,文档,甚至是提交的日志都需要去进行标准化的操作。总之凡是开发过程中人为编写而产生的一些内容,都应该去被规范化操作,其中代码的标准化规范最为重要。因为代码的规范很大程度上决定了项目的质量也决定了项目的可维护性。

为了便于后期维护和团队其他成员的阅读,一般都会对代码的编码风格做统一的要求,包括统一关键词和操作符左右的空格,统一代码的缩进方式,统一是否使用分号结尾,统一变量或者函数的命名规范等等。

最初在落实规范化的操作时非常的简单,只需要提前约定好一个可以执行的标准,然后按照这个标准进行各自的开发工作。最终在code review的环节就会按照之前约定的标准检查相应的代码。但是单靠人为约束的方式落实规范化会有很多的问题。一来人为约束并不可靠,二来开发者也很难记住每个规则,所以就需要有专门的工具加以保障。

相比于人为检察,工具的检查更为严谨,更为可靠。同时还可以配合自动化的工具实现自动化检查,这样的规范化就更加容易得到质量上的保证。

一般把通过工具去找到项目中不合规范的过程称之为Lint,之所以称之为Lint是因为刚有C语言的时候,有一些常见的代码问题是不能被编译器捕获到的,所以有人就开发了一个叫做Lint的工具,用于在编译之前检查出这些问题,避免编译之后带来一些不必要的问题。

所以后续这种类似功能的工具都被称之为叫做Lint,或者说linter,例如现在前端最常见的es-lintstyle-lint等等。

2. ESLint

ESLint是目前最为主流的javascrit lint工具,用于监测javascript代码质量。通过ESLint可以很容易的统一不同开发者的编码风格。例如缩进,换行,分号以及空格之类的使用。

ESLint还可以找出代码中一些不合理的地方,例如定义了一个从未使用的变量,或者说在一个变量使用之后才去进行声明,再或者在进行比较的时候往往总是选择==的符号等等。这些不合理的操作一般都是代码当中所存在的一些潜在问题,通过ESLint能够有效的避免这些问题,从而去提高代码的质量。

另一方面ESLint也可以帮助开发者提升编码能力,如果编写的代码每次在执行lint操作的时候都能够找出一堆的问题,而这些问题大都是以往编码时候的坏习惯。慢慢的就应该记住了这些问题,正常来说当下次遇到的时候自己就会主动避免,久而久之编码能力自然而然的就得到了一个提升。

1. 安装

使用npm init --yes初始化项目的package.json文件用于管理项目的npm依赖。

npm init --yes

安装ESLint模块。

npm install eslint --save-dev

eslint提供了一个cli程序,所以安装完成之后在node_modulesbin目录里就会多出一个eslint的可执行文件,后续可以通过这个cli程序检测代码当中的问题。

cd node_modules
cd .bin
eslint --version

yarnnpx可以直接执行node_modules中的命令。

npx eslint --version // yarn eslint --version

2. 使用

第一次运行时我们需要对eslint进行初始化。

npx eslint --init

运行之后会打印一些交互性的问题,第一个问题一般会给出三个选项,只检查语法错误,检查语法错误并且发现问题代码,检查错误语法,发现错误并且校验代码风格。很明显第三个是最全面的。

语法错误很好理解。而问题代码就是指代码中不合理的地方,例如定义了一个未被使用的变量,或者说调用了一个不存在的函数。最初对ESLint的期望值就是希望他能去找出代码当中编码风格上存在的一些问题。例如代码中的缩进不统一等等。

第二个问题是项目代码中的模块化采用的是哪一种,同样这里也是三个选项。ES ModulesCommonJS,以及不用模块化。简单来说这里的效果就是决定你的代码当中是否允许出现指定的语法或者调用。

例如如果选择的是CommonJS就允许使用全局的require函数和exports对象,如果选择是ES Modules就可以使用exportimport语法。

第三个问题是选择框架,reactvuenode等等。

第四个问题是否使用了typescript,如果用到了就输入y,默认是N

第五个问题询问代码最终运行在哪个环境,默认给出的是浏览器,这里可以选择浏览器和node。会根据运行环境判断是否允许使用相应环境下的API

第六个问题是询问如何定义代码风格,有三个选择,首先是使用市面上的主流风格,第二是通过一些问题形成一个风格,第三个是根据代码文件推断出风格。一般情况下都是采用市面上的主流代码风格。这样的话如果项目有新的成员加入也可以更好更快的适应风格。

主流风格分别是airbnbstandardgoogle,其中airbnbgoogle分别是这两家公司的具体编码规范,而standard是开源社区的一套规范,他最大的特点就是不用在语句的末尾添加分号。这里没有标准,只需要按照团队的标准执行就好了。

最后一个问题询问配置文件需要以什么样的格式存放。结束之后会提醒需要安装几个插件,这是因为刚刚选择的风格需要依赖一些插件。安装过后项目的根目录下面就会多出一个eslint的配置文件.eslintrc.js

初始化之后在项目中新建一个js文件main.js。故意调用fn的时候少写一个)然后再去调用一个不存在的函数syy

const foo=123;

function fn() {
    console.log("hello");
        console.log("eslint);
}

fn(
syy();

通过运行eslint跟上文件路径来查找这些问题,

npx eslint ./main.js

执行结果表示检查出一个error语法错误,也就是函数少个小括号的错误,回到代码修正这个错误,再次执行eslint

const foo=123;

function fn() {
    console.log("hello");
        console.log("eslint);
}

fn()
syy();

可以看到了更多的错误,可能会好奇为什么刚刚没有找出这些错误呢,其实原因非常简单,当代码中存在着语法错误时,eslint是没有办法去检查问题代码和代码风格的,那么这个时候就可以自己根据提示找到具体的问题代码。然后依次的进行解决。

也可以根据--fix参数,来自动修正绝大多数代码风格上的问题。

npx eslint ./main.js --fix

风格上的代码就已经被自动修正了,非常的方便。不过如果还没有养成良好的编码习惯建议在开始的使用还是手动的去修改每一个不好的地方,因为这样就可以加深印象。

作为一个优秀的开发人员写出来的代码他本身就应该是格式良好的,而不是后来去依赖这些工具,进行格式化。这些工具只是在最后用于确保代码的质量。

const foo = 123;

function fn () {
    console.log("hello");

    console.log("eslint);
}

fn()

syy()

最后会看到还有两个没有被自动fix的问题,需要回到代码当中自己手动的进行处理。这里foo变量是无意义的,syy函数没有定义,删除这两个内容。再次运行eslint检查,代码本身的问题就全部解决了。

3. 配置文件

通过eslint --int在项目根目录下创建了一个叫做.eslintrc.js的配置文件。在这个文件中写入的配置就会影响到当前这个目录以及所有子目录的文件,正常情况下是不会手动去修改这个配置,但是如果需要去开启或者说关闭某些校验规则的时候那这个配置文件就会非常重要。

module.exports = {
    env: {
        browser: true,
        es2020: true
    },
    extends: [
        'standard'
    ],
    parserOptions: {
        ecamVersion: 11
    },
    rules: {

    }
}

配置对象中目前有4个配置选项,JavaScript在不同的运行环境中有不同的API可以被调用,这些API很多时候都是以全局的成员方式提供,例如在浏览器环境可以直接去使用windowdocument对象。env的选项作用就是标记代码最终的运行环境,eslint会根据环境信息来判断某一个全局成员是否是可用的,从而去避免代码当中去使用到那些不存在的成员。browsertrue就表示代码会运行在浏览器环境中。

生成eslint配置的时候如果选择的是standard风格,最终这里的配置也会继承standard配置,在standard风格中做了一些具体的配置documentwindow在任何的环境中都可以使用。

env具体可以设置以下环境

环境 说明
browser 浏览器环境中的全局变量
node nodejs全局变量和作用域
commonjs CommonJs全局变量和CommonJs作用域(用于 Browserify/webpack打包的只有浏览器中运行的代码)
shared-node-browser NodeJs和Browser通用全局变量。
es6 启用除了modules以外的所有ECMAScript6特性,该选项会自动设置ecmaVersion解析器选项为6
worker Web Workers 全局变量
amd 将require和define定义为像amd一样的全局变量。
mocha 添加所有 Mocha 测试全局变量
jasmine 添加所有jasmine版本1.3和2.0的测试全局变量。
jest Jest 全局变量
phantomjs PhantomJs全局变啦
protractor protractor全局变量
qunit QUnit 全局变量
jquery JQuery 全局变量
prototypejs Prototype-js 全局变量
shelljs shelljs 全局变量
meteor Meteor 全局变量
mongo MongoDB 全局变量
applescript AppleScript 全局变量
nashorn Java 8 Nashorn 全局变量
serviceworker Service Worker全局变量
atomtest Atom 测试全局变量
embertest Ember全局变量
webextensions WebExtensions全局变量
greasemonkey Greasemonkey全局变量

这些环境并不是互斥的,可以同时开启多个不同的环境。

module.exports = {
    env: {
        browser: true,
        node: true,
        es2020: true
    },
    extends: [
        'standard'
    ],
    parserOptions: {
        ecamVersion: 11
    },
    rules: {

    }
}

extends选项是用来继承一些共享的配置,如果需要在多个项目当中共享一个eslint配置,可以定义一个公共的配置文件然后在这里继承就可以了。这个属性值是一个数组,数组中的每一项都是一个配置。

parserOptions的作用是设置语法解析器的,ECMAScript近几年发布了很多版本,这个配置的作用就是是否允许使用某一个ES版本的语法。这里设置的是11也就是ECMAScript2020

如果将ecamVersion设置为5,这个时候就没办法使用ES6的新特性了,在ecamVersion低于6的情况下sourceType不能是module,因为ES ModulesES6的新特性。

parserOptions影响的只是语法检测,不代表某个成员是否可用,如果是ES2015提供的全局成员比如Promise还是需要env中的ES6选项进行控制。

module.exports = {
    env: {
        browser: true,
        es2015: false
    },
    extends: [
        'standard'
    ],
    parserOptions: {
        ecamVersion: 2015
    },
    rules: {

    }
}

rules属性是配置ESLint中每个规则的开启或者是关闭,例如这里可以尝试开启no-alert规则。具体的开启方法就是在rules里面添加一个属性,属性名是内置的规则名称,属性值可以有三种,分别是offwarningerror。如果是off代表规则关闭,如果是warning就是发出警告,如果是error就表示当前报出错误。

module.exports = {
    env: {
        browser: true,
        es2015: false
    },
    extends: [
        'standard'
    ],
    parserOptions: {
        ecamVersion: 2015
    },
    rules: {
        'no-alert': "error"
    }
}

设置后代码中使用alert就会报出error错误,这就是rules的属性的作用。在eslint的官网上就给出了所有内置的可用的校验规则列表,可以在使用的时候进行查看。standard风格中已经开启了很多规则。基本上也满足了所有的需求,如果有需要的情况下可以根据自己的需求来进行具体的配置。

globals是额外的声明在代码中可以使用的全局成员。例如在使用了JQuery的项目当中,一般都会使用全局的JQuery对象,那么就可以直接去添加一个JQuery,将他的值设置为readonly,这样代码当中就能直接去使用JQuery,而且也不会报错。

module.exports = {
    env: {
        browser: true,
        es2015: false
    },
    extends: [
        'standard'
    ],
    parserOptions: {
        ecamVersion: 2015
    },
    rules: {
        'no-alert': "error"
    },
    globals: {
        jQuery: 'readonly'
    }
}

4. 配置注释

配置注释就可以理解为将配置直接通过注释的方式写在脚本文件中,然后再去执行代码的校验。比如在实际的开发过程中如果使用ESLint难免遇到一两处需要违反配置规则的地方,这种情况肯定不能因为这一两个点就去推翻校验规则的配置,在这个时候就可以去使用校验规则的配置注释去解决这个问题。

比如定义一个普通的字符串,在字符串中使用${}占位符,但是standard风格不允许这样使用。要解决这样的问题可以通过注释的方式,临时禁用一下规则,注释的语法有很多种,具体可以参考ESLint官方给出的文档,这里直接使用eslint-disable-line,这样eslint在工作的时候就会选择忽略这一行代码。

const str = '${name} is a coder'; // eslint-disable-line
console.log(str);

这样使用虽然可以解决问题,但同样也会带来新的问题,一行当中如果有多个问题存在的时候这样操作所有问题就都不会被检测。因此更好的做法应该是在eslint-disable-line后面跟上一个具体要禁用的规则名称。比如这里的是no-template-curly-in-string。这样就会只忽略指定的问题规则,其他的问题仍旧可以被发现。

const str = '${name} is a coder'; // eslint-disable-line no-template-curly-in-string
console.log(str);

当然注释的方式不仅可以禁用某个规则,还能声明全局变量,修改某个规则的配置,临时开启某个环境等等,这些功能可以通过下面的链接找到对应的文档查询对应的使用。文档

5. 结合 gulp

ESLint本身是一个独立的工具,但是如果现在是一个有自动化构建的工作流的项目当中,还是建议集成到自动化构建的工作流当中。

首先需要安装eslint模块和gulp-eslint模块,通过eslint --init创建eslint的配置文件。guipfile.js在处理js的任务中做修改。

const script = () => {
    return src('src/main.js', {base: 'src'})
    .pipe(plugins.babel({presets: ['@babel/preset-env']}))
    .pipe(dest('temp'))
    .pipe(bs.reload({stream: true}))
}

gulp属于一种管道的工作机制,想把eslint集成到这个工作当中,应该在babel处理之前先进行eslint操作,否则经过babel之后代码就不是真正的源代码了。

可以使用plugins.eslint找到这个插件进行使用.pipe(plugins.eslint())这样就会先执行eslint,然后再去执行babel编译。

默认情况下eslint只会去检查代码中存在的问题,并不会根据检查的结果做出任何的反馈,正确的做法是在eslint插件处理完之后,先去使用eslintformat方法在控制台打印出具体的错误信息,之后再去使用eslint中的failAfterError方法让eslint检查出错误后终止任务管道。

const script = () => {
    return src('src/main.js', {base: 'src'})
    .pipe(plugins.eslint())
    .pipe(plugins.eslint.format())
    .pipe(plugins.eslint.failAfterError())
    .pipe(plugins.babel({presets: ['@babel/preset-env']}))
    .pipe(dest('temp'))
    .pipe(bs.reload({stream: true}))
}

6. 结合 Webpack

webpack集成ESLint并不是以插件的方式来完成的,而是通过loader机制,webpack在打包模块之前会将遇到的模块都交给对应的loader进行处理。所以eslint就可以通过一个loader的形式集成到webpack当中,这样就可以实现在打包javascript之前,先通过eslint来校验javascript代码。

首先安装对应的eslint模块和eslint-loader模块。并且初始化.eslintrc.js配置文件。

npm install eslint eslint-loader -D

找到webpack的配置文件,把js使用的loader配置为一个数组,然后将eslint-loader放置在最后,loader执行的顺序是从后向前执行的,也就是后配置的先执行。也可以使用另一种配置方法,单独的为js文件再添加一个loader规则,然后在这个规则当中添加enfore属性,把他的值设置为pre,确保这个loader中配置的优先级是优于其他的loader,这样也可以实现通过eslint校验再去执行babel转换。

module.exports = {
    mode: 'production',
    entry: './src/main.js',
    module: {
        rules: [
            {
                test: /\.js$/,
                exclude: /node_modules/,
                use: 'eslint-loader',
                enfore: 'pre'
            },
            {
                test: /\.js$/,
                exclude: /node_modules/,
                use: 'babel-loader'
            },
            {
                test: /\.css$/,
                use: ['style-loader', 'css-loader']
            }
        ]
    }
}

配置之后使用webpack打包的就会报出eslinterror错误,这也就实现了将eslint集成到webpack当中。

7. 校验 React

使用webpack打包的时候eslint会自动使用规则校验javascript代码,会检查出很多定义但没有使用到的问题,比如React is define but never used, 但是Reactjsx编译之后代码所必须要使用到的,所以像这种特殊的情况,ESLint就必须要靠一些额外的插件来进行实现。

社区当中已经为React准备了一个插件eslint-plugin-react,需要安装这样一个模块到我们本地的开发依赖当中。

npm install eslint-plugin-react --save-dev

这个模块中定义了很多规则,这些规则都是专门针对于react项目的。如果想要使用这些规则直接去eslint的配置文件当中通过plugins属性进行配置。

简单来说plugins是一个数组,在他的内部可以直接指定使用哪些插件,这里的插件模块叫做eslint-plugin-react,在这个数组中添加react就可以了,模块名会去掉eslint-plugin-

完成之后就可以进行使用了。在rules中开启react/jsx-uses-react这个规则。可以用error也可以用数字的2代表error。这个规则的作用是避免React定义了但是没有使用的报错。

module.exports = {
    env: {
        browser: true,
        es2020: true
    },
    extends: [
        'standard'
    ],
    parserOptions: {
        ecamVersion: 11
    },
    rules: {
        'react/jsx-uses-react': 2,
        'react/jsx-uses-vars': 2,
    },
    plugins: [
        'react'
    ]
}

对于大多数ESLint插件来说一般都会提供一个共享的配置降低使用的成本,eslint-plugin-react里面就导出两个共享配置,分别是recommendall,一般使用recommend,它里面提供的共享的配置可以直接继承。

在继承的时候要遵守语法规则,具体来说就是我们使用plugin:插件名称/配置名字

module.exports = {
    env: {
        browser: true,
        es2020: true
    },
    extends: [
        'standard',
        'plugin:react/recommend'
    ],
    parserOptions: {
        ecamVersion: 11
    }
}

8. vue-cli 初始化

随着ReactVue这种框架的普及,框架中间生态也相应完善,最明显的感觉就是现阶段如果再去开发一个基于reactvue的项目,基本已经不需要再去自己配置webpack或者eslint了。在官cli中已经将他们直接集成了比如使用vue-cli创建一个vue

npm install @vue/cli -g

vue create yd-vue-app

在这个过程中会提示需要选择很多选项,选择babel运行环境,代码风格选择eslintstandard,然后会询问在什么样的环节执行lint操作。

第一个是save环节,也就是webpack在构建时自动进行校验,并不是文件保存时,因为很多时候采用的是监视的模式,也就是文件刚刚被修改过后webpack就会自动执行编译,这里就称之为保存时的校验。

第二个是commit环节这个环节指的就是利用git的钩子进入commit之前自动的校验当前的代码这就确保了提交到仓库中的代码是经过校验的。

一般这以上两个环节都需要。

接着会询问想要怎样存放babeleslint的配置文件,可以选择独立文存放,之所以有这个选项是因为大多数文件都支持package.json配置。

最后询问是否保存这些选择,下次可以直接使用,最好不要选择。

在基本的项目结构中eslint被自动的集成进去了,通过这样的操作就不需要在工具的配置和使用上花费时间,也就是说开发者可以更加专注于业务功能的开发。

9. 检查 TypeScript

以前TypeScriptlint操作使用tslint工具,后来由于tslint官网直接放弃维护,转而建议使用eslint配合typescript插件对TypeScript代码校验。

首先还是要初始化eslint,涉及到TypeScript选择的时候选择y,会自动安装两个默认插件。

安装过后就可以使用eslint检查TypeScript代码了。

function foo (ms: string): void {
    console.log(ms);
}

foo('hello typescript~')

.eslintrc.js配置选项里的parser是指定一个语法解析器,TypeScript相比较于普通的JavaScript代码来说会有很多特殊的语法,所以需要指定一个语法解析器。之后就可以对TypeScript代码进行校验了。

module.exports = {
    env: {
        browser: true,
        es2020: true
    },
    extends: [
        'standard'
    ],
    parser: '@typescript-eslint/parser',
    parserOptions: {
        ecamVersion: 11
    },
    plugins: [
        '@typescript-eslint'
    ],
    rules: {}
}

3. Stylelint

前端项目中除了javascript代码需要被lint之外css代码同样也需要被lint,对于css代码的lint操作一般会使用stylelint工具完成。stylelint的使用与eslint基本一致。

stylelint也提供了一系列代码检查的规则,供直接使用,和之前一样也可以直接在配置文件中选择性的开启或关闭某些规则。stylelint同样也提供了一个cli的工具,可以在终端中直接调用stylelint这命令检查css文件。

stylelint可以通过插件实现对于sasslesspostcsscss衍生语法的检查。stylelint同样可以与gulp自动化工具或webpack打包工具集成使用。

对于stylelint的使用可以完全参考eslint的操作方式,因为他们是极其类似的。

首先需要安装stylelint的模块,安装完成就可以使用cli命令了。

npm install stylelint -D

安装之后需要配置文件.stylelintrc.js,这个配置文件当中的属性基本和eslintrc中是相同的。

安装stylelint-config-standard共享配置模块。

npm install stylelint-config-standard -D

安装之后进行继承使用,和eslint不太一样的是这里的共享模块名称必须是一个完整模块的名称。

module.exports = {
    extends: "stylelint-config-standard"
}

执行stylelint命令。

npx stylelint ./index.css

发现问题后可以直接定位修改,也可以通过--fix参数让stylelint完成大多数问题的自动修复。

如果要使用stylelint校验项目中的sass代码需要安装stylelint-config-sass-guidelines

npm install stylelint-config-sass-guidelines -D

安装之后配置extends属性就可以使用了。

module.exports = {
    extends: ["stylelint-config-standard", "stylelint-config-sass-guidelines"]
}

至于lesspostcss操作都是类似的,把stylelint集成到gulp可以参考eslint

4. Prettier

prettier是近两年使用频率比较高的通用的前端代码格式化工具,几乎能完成所有前端代码文件的格式化工作,在日常的使用中可以通过它来完成代码的自动格式化工作,或者针对markdown文档进行格式化操作。通过使用prettier很容易的落实前端项目中的规范化标准,而且他的使用非常简的。

首先需要安装prettier

npm install prettier -D

完成之后可以直接使用prettier命令格式化代码。

npx prettier style.css

默认情况下这个命令会将格式化之后的代码输出到控制台当中,需要将格式化后的代码覆盖到源文件当中可以在命令中跟上--wirte参数。

npx prettier style.css --write

prettier支持通过命令通配符的方式格式化所有文件。

npx prettier . --write

5. Git Hooks

使用lint是为了确保提交到仓库当中的代码是没有问题的,如果只是单纯的口头约束,要求团队成员在提交代码之前必须执行lint必然流于形式,更好的办法应该是通过某种方式强制要求代码在提交之前必须通过lint检查,这就是githooks的价值。

githooks称为git钩子,每个钩子都关联着一些具体的git操作,比如commitpush等,可以直接找到某个具体的钩子,通过编写具体的shell脚本,定义一些git钩子触发时要执行的任务。

找到git仓库的目录,找到本地的.git目录,默认这是个隐藏的目录。进入之后可以找到hooks子目录,子目录里面存放了很多sample的文件,里面的每一个sample就是一个钩子,这里只关心pre-commit.sample的钩子即可,他对应的是commit操作。

当执行commit的时候会触发它里面定义的一些任务,可以打开这个文件,它里面有很多shell脚本,可以修改里面的shell比如替换为下面的代码。

#!/bin/sh
echo "before commit"

这个时候执行commit操作就会在终端中看到打印的before commit信息。这就是githooks的工作机制,就是通过钩子来对应具体的操作,然后在操作发生的时候自动的执行钩子里面定义的任务。将来可以在commit执行之前强制的执行eslint

6. ESLint 结合 Git Hooks

husky模块就是直接将githooks的操作简单化的实现,简单说就是有了这个模块可以实现在不编写shell脚本的情况下也能使用git钩子功能。

首先需要安装husky模块,安装之后会自动在.git/hooks的目录中添加一些自定义的钩子。

npm install husky --save-dev

接着在package.json文件中添加husky配置,在这个配置中定义hooks对象,在hooks对象中可以定义不同的任务。

添加pre-commit,值为npm命令,在执行commit提交的时候会找到scripts里面对应的test命令。

{
    ...
    "scripts": {
        "test": "eslint ."
    },
    "husky": {
        "hooks": {
            "pre-commit": "npm run test"
        }
    }
    ...
}

但是想要在检查之后继续做后续的操作,例如想经过检查的代码进行格式化或者直接将进行格式化的代码添加到暂存区。这个时候husky就显得有些不够用了。lint-stage模块可以配合husky增加一些其他的功能。

npm install lint-staged --save-dev

安装完成之后也要在package.json中添加lint-staged属性,同时在他的内部设置*.js属性,这个属性值可以是一个数组,在数组中添加一些后续需要执行的任务,比如这里先添加eslint,然后再设置git add,这样一来就相当于设置了两个命令。

还需要设置scripts,将precommit钩子执行的脚本设置为lint-staged, 不过这需要注意因为修改了钩子的名称叫precommit,所以还是要到huskynpm执行的命令修改为precommit

{
    ...
    "scripts": {
        "test": "eslint .",
        "precommit": "lint-staged"
    },
    "husky": {
        "hooks": {
            "pre-commit": "npm run precommit"
        }
    },
    "lint-staged": [
        "eslint",
        "git add"
    ]
    ...
}

配置完之后再提交的时候就会先触发npm run precommit,然后precommit中会执行eslint操作和git add操作。这也就实现了在commit之前给代码强行lint,同时也可以完成后续的需求。

一般建议使用husky配合lint-staged这样不仅可以在commit之前强制的验证代码同时还可以在验证之后或之前完成一些其他的操作。

转载须知

如转载必须标明文章出处文章名称文章作者,格式如下:

转自:【致前端 - zhiqianduan.com】 lint代码检查  "隐冬"
请输入评论...