webpack+vue项目中配置ESLint

使用ESLint对代码书写进行规范,可以有效的提高代码的质量,降低代码出错的机率,因此有必要将ESLint引入到项目中。

目前网上已经存在标准的ESLint配置,该规范是目前业界比较推崇的代码编写规范,以下是配置方法:

1. 安装ESLint标准配置

npm install --D eslint-config-standard eslint-plugin-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-node

其中:eslint-config-standard是依赖于后面的plugin

2. 编写配置文件

在项目根目录下添加.eslintrc文件,该文件是一个JSON配置文件,需要在该配置文件中指定"extends"字段为"standard",指明继承标准配置文件。
配置文件内容如下:

{
  "extends": "standard"
}

此时在package.json中的scripts字段中配置"lint"命令,如下

"lint": "eslint --ext .js --ext .vue src/"

调用本地的eslint命令,用--ext指明需要检测js文件和vue文件,最后指定检测的文件所在目录为src/。
注意:在package.json中scripts字段中调用eslint命令使用项目中的eslint命令,如果想要在全局中调用eslint命令,需要全局安装。
调用后结果如下:

运行结果

为什么会出错呢?
此时报错的都是vue文件,由于vue文件的书写格式特殊,所以需要配置后才能正确处理。

3. 配置Vue ESLint

Vue文件各个部分是由标签包裹的,因此编写规范同html一致。此时,需要下载eslint-plugin-html插件,并且在eslint的配置文件中指明使用插件。
插件下载命令

npm install -D eslint-plugin-html

此时配置文件修改为:

{
  "extends": "standard",
  "plugins": [
    "html"
  ]
}

此时在运行,便没有问题(前提条件是代码书写确实符合规范)


运行结果

4. 在webpack中配置ESLint

我们想要达到的目的是,在我们的代码编写过程中,webpack可以实时对代码进行检测,并给出提示。
在webpack+vue的项目中,我们编写的代码都需要通过babel编译,编译后的代码并不能满足eslint的规范,因此,我们需要对编译前的文件进行检查。这时,我们需要使用babel-eslint编译器对文件进行检查(否则无法识别新特性或者特殊文件的编写格式,如vue)。
安装指令如下

npm install babel-eslint -D

修改.eslintrc如下

{
  "extends": "standard",
  "plugins": [
    "html"
  ],
  "parser": "babel-eslint"
}

指明解析器为babel-eslint

在webpack中,提供了eslint-loader支持对特定文件进行代码格式检查,因此,首先我们需要下载eslint-loader,然后在webpack配置文件中配置规则。

{
  "extends": "standard",
  "plugins": [
    "html"
  ],
  "parser": "babel-eslint"
}
npm install eslint-loader -D

webpack中module.rules中新增一项规则

{
        test: /\.(vue|js)$/,
        loader: 'eslint-loader',
        exclude: /node_modules/,
        // 预处理
        enforce: 'pre'
}

这里指明了对js和vue文件使用eslint-loader进行处理,并排除了/node_modules/目录中的文件,并利用enforce字段指明,该loader是进行预处理的loader,先对指定文件进行eslint后才会执行babel编译。

以上便可完成了所有配置。


代码提交之前对代码进行检查

我们在github托管代码时,会将自己的代码提交到github仓库中,如果我们可以在每一次提交之前对我们的代码进行检查,确定无误后才正确提交,这样的话,就能保证线上的代码也是合乎规范的,这样有利于代码的维护。

如何实现以上功能呢?

这里我们需要借助husky工具,安装完该工具之后,该工具可以在我们提交代码时,调用"precommit"钩子,执行预处理操作。

首先安装该工具

npm install -D husky

然后在package.json的scripts字段中配置precommit,让其执行代码检测操作

 "precommit": "eslint --ext .js --ext .vue src/"

此时提交的代码存在问题,就会报错,提交失败。


统一编辑器设置

目前网上存在很多编辑器,其自定义配置也是各不相同,如何统一编辑器的设置呢?

所有的编辑器都提供了editorconfig的插件,它会读取项目根目录下的.editorconfig文件,然后进行配置,因此我们可以通过.editorconfig文件来编写编辑器的配置方案。

# 标识为最终配置
root = true

# 所有文件配置
[*]
# 字符集
charset = utf-8
# 行结束符号
end_of_line = lf
# 缩紧
indent_size = 2
# 缩紧方式
indent_style = space
# 最后插入一行
insert_final_newline = true
# 删除最后的空格
trim_trailing_whitespace = true
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,560评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,104评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,297评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,869评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,275评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,563评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,833评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,543评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,245评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,359评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,006评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2 273
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2 268

推荐阅读更多精彩内容