ESlint代码质量监控

1.怎么用?

    首先安装eslint(npm install eslint),可以使用3种方法对项目进行验证:

    、使用js注释直接把配置信息注入到一个代码源文件中。

    、为整个项目新建配置文件,可以有很多的不同层级的配置文件,校验文件语法时,eslint会使用最近的配置文件。(PS:我推荐,哈哈)

    三、直接在package.json文件里面的eslintConfig字段指定配置,eslint会自动查找读取。

2.指定解析器选项

    在.eslintrc.*文件里面的parserOptions字段里面进行配置。

    ecmaVersion:当前的ECMAScript版本,默认是3和5,还可以使用6(2015)-7(2016)-8(2017)-9(2018)指定想要的版本;

    sourceType:这个是项目的类型,默认是"script",但是如果你的项目的模块化的,就要用"module";

    ecmaFeatures:是个对象

        globalReturn: 允许全局作用下使用return

        impliedStrict:启用全局严格模式

        jsx:启用jsx

3.指定解析器

    parse:eslint默认使用Espree作为其解析器,可以在配置文件中修改。但是我不知道改了有什么好处或者什么情况下修改它才能更优。

4.指定环境

      env:一个环境定义了一组预定义的全局变量。就是写在这里,eslint检测到就不会报错了!

        browser:浏览器中的全局变量,类似于window吧

        node:node.js全局变量和node.js全局作用域

        commonjs:CommonJs全局变量和CommonJs作用域

        es6:等同于ecmaVersion:6,启用除了modules以外的所有ECMAScript6特性。

        worker - Web Workers 全局变量(开启多线程,解决js的单线程问题。Worker对象)。

        amd - 将 require() 和 define() 定义为像 amd 一样的全局变量。

        mocha - 添加所有的 Mocha 测试全局变量(mocha是测试框架)。

        jasmine - 添加所有的 Jasmine 版本 1.3 和 2.0 的测试全局变量(也是测试框架)。

        jest - Jest 全局变量(还是测试框架)。

        phantomjs - PhantomJS 全局变量(js API)。

        protractor - Protractor 全局变量(又是测试框架)。

        qunit - QUnit 全局变量(强大的js单元测试框架)。

        jquery - jQuery 全局变量。

        prototypejs - Prototype.js 全局变量(js API)。

        shelljs - ShellJS 全局变量。用于 Node.js的Unix shell-命令   

        meteor - Meteor 全局变量。构建在 Node.js 之上的平台,用来开发实时网页程序。

        mongo - MongoDB 全局变量。(数据库)

        applescript - AppleScript 全局变量。

        nashorn - Java 8 Nashorn 全局变量。

        serviceworker - Service Worker 全局变量。

        atomtest - Atom 测试全局变量。

        embertest - Ember 测试全局变量。

        webextensions - WebExtensions 全局变量。

        greasemonkey - GreaseMonkey 全局变量。

5.指定全局

    global:访问当前eslit配置文件的时候,出现未定义的变量,会发出警告,要在global字段里面定义全局变量,true为可以重写,false是不能重写。

6.配置插件

    plugins:eslint支持使用第三方插件,使用之前必须用npm安装一下。

7.配置规则

    铛铛铛,最重要的,代码监控规则上线,在配置文件里面的rules字段里面

    eslint里面的所有校验规则默认都是off,就是不警告也不报错,就当没看见。但是需要代码漂亮有规范就得开启一些代码校验规则。

    “quotes” : ["error", "double"]; 数组的第一个参数总是错误级别

    PS:附上eslint的全部规则:http://eslint.cn/docs/rules/

8.禁用规则

   块儿: 直接在文件中使用注释告诉eslint该区域禁用某些校验规则

        /* eslint-disable  no-alert no-console*/

        /* eslint-enable  no-alert no-console*/

    整个文件:整个文件禁用某种校验

        /* eslint-disable no-alert */  放在文件顶部

   一半儿一半儿: 对上半部分禁用,下半部分启用

        /* eslint-disable  no-alert */

        // Disables no-alert for rest of the file

    :单行禁用,禁用多条规则,英文逗号隔开,谢谢

        // eslint-disable-line no-alert                /* eslint-disable-line no-alert  */ 

        // eslint-disable-next-line no-alert        /* eslint-disable-next-line no-alert  */

9.共享设置

    类似于自定义的公共规则:

    settings:{  }

10.配置文件的优先级别

    同一个目录下有多个eslint配置文件,那么eslint只会用一个,按照优先级别取用。

        .eslintrc.js > .eslintrc.yaml > .eslintrc.yml > .eslintrc.json >.eslintrc > package.json

    如果当前目录有配置文件,父级目录也有配置那么文件,那么优先使用当前目录的配置文件。

    在配置文件的root字段设置为true,那么eslint会停止在腹肌目录寻找配置文件,只用当前目录下的配置文件,应该就是这个意思!

11.忽略的文件

    项目中 有些第三放的插件不需要eslint验证,就像npm安装的依赖,也就是node_modules中文件,不需要被校验。   

12.官方文档地址

    http://eslint.cn/docs/user-guide/configuring

13.集成到webpack

 npm安装eslint-loader,在webpack基本配置里面,module字段里面添加preLoaders

webpack集成eslint配置

放在preLoaders里面是想在编译之间先对语法和代码风格进行校验,语法不过关,直接停止webpack编译。

14.集成到编辑器

    但是如果在编译的时候才进行校验还是觉得有点慢,浪费时间。我用的vs-code编辑器,在编辑器里面下载eslint的插件,编辑器就会在当前项目目录下查找.eslintrc.json文件,进行文件校验,这样在编写代码的时候就能知道哪里错,错在哪里了。

    在vscode编辑器里面,选中项目打开终端,mac下执行 ./node_modules/.bin/eslint --init 就会在当前项目根目录下创建一个.eslintrc.js文件,默认情况下,逗号后面留空格。

    此处参考原文链接:https://segmentfault.com/a/1190000007030775

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342