ESlint

1. 什么是ESlint?

ESLint 是一款开源的 JavaScript lint 工具,由 Nicholas C. Zakas 于2013 年创建。

ESLint 官方文档 About 页面分 About 和 Philosophy 两个部分对 ESLint 做了介绍,简洁明了,值得一读。

借助 ESLint,可将 静态代码分析问题代码协助修复 集成到 编码提交打包 过程中,及早发现并协助修复代码中:

  • 有语法错误的部分

  • 不符合约定的样式准则的部分

  • 不符合约定的最佳实践的部分

在项目开发中获得如下收益:

  • 在执行代码之前发现并修复语法错误,减少调试耗时和潜在 bug

  • 保证项目的编码风格统一,提高可维护性

  • 督促团队成员在编码时遵守约定的最佳实践,提高代码质量

主要有以下特点:

  • 默认规则包含所有 JSLint、 JSHint 中存在的规则, 易迁移;

  • 规则可配置性高: 可设置「 警告」、「 错误」 两个 error 等级, 或者直接禁用;

  • 包含代码风格检测的规则( 可以丢掉 JSCS 了);

  • 支持插件扩展、 自定义规则。

2. ESlint规范

AlloyTeam ESLint 规则

AlloyTeam ESLint 规则不仅是一套科学的 ESLint 配置规范,而且也是你配置个性化 ESLint 规则的最佳参考。

规则列表

名称 包含规则 解析器
标准规则 ESLint 规则 babel-eslint
React ESLint 规则、eslint-plugin-react babel-eslint
Vue ESLint 规则、eslint-plugin-vue vue-eslint-parser
TypeScript ESLint 规则、@typescript-eslint @typescript-eslint/parser
TypeScript React ESLint 规则、@typescript-eslint、eslint-plugin-react @typescript-eslint/parser
TypeScript Vue(开发中)

[babel-eslint] https://github.com/babel/babel-eslint

[vue-eslint-parser] https://github.com/mysticatea/vue-eslint-parser

[@typescript-eslint/parser] https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser

[ESLint 规则] https://eslint.org/docs/rules/

[eslint-plugin-react] https://github.com/yannickcr/eslint-plugin-react

[eslint-plugin-vue] https://eslint.vuejs.org/rules/

[@typescript-eslint] https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#supported-rules

配置原则

我们依据以下三条原则,研读了 ESLint 所有的配置项,定制出了心目中的「完美」ESLint 配置。

  1. 能够帮助发现代码错误的规则,全部开启

  2. 配置不应该依赖于某个具体项目,而应尽可能的合理

  3. 帮助保持团队的代码风格统一,而不是限制开发体验

配置解读

ESLint 的配置多达几百条,逐个查阅是一项非常繁重的工作,我们为了简化个性化配置的成本,针对每一条配置都有一句话的注释,以及对应的错误示例和正确示例。这样不仅方便了我们自己查阅某项配置的意义和原因,也使大家更容易配置出自己心目中的规则:

  • 每一条配置都有一句话注释说明此配置的用途

  • 每个开启的配置都有对应的错误示例和正确示例

  • 每个示例都会在真实的 ESLint 脚本中运行,以保证报错项与配置一一匹配

  • 对于有争议的配置,都在注释中说明了为什么要这么配置的原因

  • 对于能够自动修复的配置,在注释中有标注了 @fixable

使用方法

标准规则

安装:

安装:

npm install --save-dev eslint babel-eslint eslint-config-alloy

在你的项目根目录下创建 .eslintrc.js,并将以下内容复制到文件中:

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

推荐阅读更多精彩内容