使用ESLint构建团队代码规则

前言

js是一门动态弱类型语言,程序中的错误要在代码运行时才能发现。而ESLint就是能在编译中发现代码错误的工具,在团队协作中,避免低级 Bug,产出风格统一的代码。

工具需要的是合适

ESLint是最新的工具,支持配置,自定义规则,报告错误,文档详尽,支持ES6语法最广,支持JSX语法。那Airbnb ESLint又是什么呢,为什么这么多人推荐?这是我一开始的疑惑,其实这是Airbnb公司自身定制的标准。ESLint默认有一套规则eslint:recommended,每个团队可以根据自身需求,进行部分配置修改。如果你很喜欢大厂那一套,可以自己安装配置进ESLint工具中使用,但这里建议不要迷信权威,Airbnb的标准是高度定制的,不一定适合你的项目,所以学好怎么配置自己的标准才是重要的。

安装

ESLint是一个运行在node环境的工具,使用npm进行安装

  1. 全局安装
npm install -g eslint
  1. 本地安装
npm install eslint --save-dev

我喜欢都安装,因为全局安装能多个工程直接使用命令,本地安装能为后续提供灵活配置。

生成配置文件

工具基本都有配置文件,告诉工具该做什么,怎么做。如npm的就是package.json文件,而ESLint的配置文件就是.eslintrc。

进入项目根目录,终端执行

eslint --init

之后程序会询问你一些问题,以创建符合你风格的配置文件,最终生成配置文件,其格式会有JavaScript、YAML、JSON、package.json等等。这里我们把生成的文件重命名一下为.eslintrc,为后续在IDE中进行配置。

配置文件

打开配置文件,可以看到以下内容,我使用的是JSON格式

{
    "env": {
        "browser": true
    },
    "extends": "eslint:recommended",
    "rules": {
        "indent": [
            "error",
            "tab"
        ],
        "linebreak-style": [
            "error",
            "unix"
        ],
        "quotes": [
            "error",
            "double"
        ],
        "semi": [
            "error",
            "always"
        ]
    },
    Globals: {
    }
}

解析以下参数的意思

  1. env:指定你的js代码在哪个运行环境中检测(每个运行环境都有一组预定义的全局变量);
  2. extends:扩展配置规则,我这里扩展的是eslint的推荐规则,可以使用Airbnb的规则;
  3. rules:指定检测规则。这是最重要的部分,也是你的自定义js代码监测规则的地方,格式为:规则名: 规则。比如:
"indent": ["error","tab"]

这里indent就是规则名,它定义了缩进应该使用tab,规则内的第一个值error指的是错误等级,它有三个等级,分别是

error level 对应数值 含义
error 2 错误
warn 1 提醒
off 0 关闭该规则

具体请参考eslint官网

  1. Globals:指定脚本执行过程中访问的附加全局变量(比如jquery)

运行工具

到上面为止,已经完成基本配置了,在终端运行

eslint yourfile.js

便可以对该文件进行检测,如果有问题,终端会提示相关错误的代码和错误类型,可以运行

eslint yourfile.js --fix

进行自动修复,但这只是局限于部分规则。

更多项目中的应用请查看《如何在WebStorm中配置ESLint》《利用 git 钩子做代码提交前的检查》,谢谢支持!

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

推荐阅读更多精彩内容