我花了两个月时间,定制出了心目中「完美」的 ESLint 规则,我用四个空格缩进

2017-08-25 17:52:07 +08:00
 xcatliu

包含以下几种配置项:

配置原则

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

  1. 能够帮助发现代码错误的规则,全部开启
  2. 配置不应该依赖于某个具体项目,而应尽可能的合理
  3. 帮助保持团队的代码风格统一,而不是限制开发体验

配置解读

我们对每一条配置,都有详尽的注释,这样不仅方便了我们自己查阅某项配置的意义和原因,也使大家更容易配置出自己心目中的规则:

详细的配置内容在这里:

下面列出一个代码片段供参考:

module.exports = {
    parser: 'babel-eslint',
    parserOptions: {
        ecmaVersion: 2017,
        sourceType: 'module',
        ecmaFeatures: {
            experimentalObjectRestSpread: true,
            jsx: true
        }
    },
    env: {
        browser: true,
        node: true,
        commonjs: true,
        es6: true
    },
    // 以当前目录为根目录,不再向上查找 .eslintrc.js
    root: true,
    rules: {
        //
        //
        // 可能的错误
        // 这些规则与 JavaScript 代码中可能的语法错误或逻辑错误有关
        //
        // 禁止 for 循环出现方向错误的循环,比如 for (i = 0; i < 10; i--)
        'for-direction': 'error',
        // getter 必须有返回值,并且禁止返回空,比如 return;
        'getter-return': [
            'error',
            {
                allowImplicit: false
            }
        ],
        // 禁止将 await 写在循环里,因为这样就无法同时发送多个异步请求了
        // @off 要求太严格了,有时需要在循环中写 await
        'no-await-in-loop': 'off',
        // 禁止与负零进行比较
        'no-compare-neg-zero': 'error',
        // 禁止在 if, for, while 里使用赋值语句,除非这个赋值语句被括号包起来了
        'no-cond-assign': [
            'error',
            'except-parens'
        ],
        // 禁止使用 console
        // @off console 的使用很常见
        'no-console': 'off',
        // 禁止将常量作为 if, for, while 里的测试条件,比如 if (true), for (;;),除非循环内部有 break 语句
        'no-constant-condition': [
            'error',
            {
                checkLoops: false
            }
        ],
        // 禁止在正则表达式中出现 Ctrl 键的 ASCII 表示,即禁止使用 /\x1f/
        // 开启此规则,因为字符串中一般不会出现 Ctrl 键,所以一旦出现了,可能是一个代码错误
        'no-control-regex': 'error',
        // @fixable 禁止使用 debugger
        'no-debugger': 'error',
        // 禁止在函数参数中出现重复名称的参数
        'no-dupe-args': 'error',
        // 禁止在对象字面量中出现重复名称的键名
        'no-dupe-keys': 'error',
    }
};

使用方法

请在 GitHub Repo 中查看。

20962 次点击
所在节点    分享创造
66 条回复
xcatliu
2017-08-25 18:05:55 +08:00
我用四个空格缩进,你呢?
leopku
2017-08-25 18:17:32 +08:00
开源项目 2 个,公司项目 4 个(看你肿么办,,,
isayme
2017-08-25 18:19:35 +08:00
我用 standard,无配置,都不用争了。
xcatliu
2017-08-25 18:19:36 +08:00
@leopku 自从用了四个,就觉得两个太丑了。
dong3580
2017-08-25 18:33:44 +08:00
我用 2 格缩进,不然,公司项目报错😂
isb
2017-08-25 18:47:37 +08:00
用 2 个啊。。默认 vue-cli 默认是 2 个。。。
xcatliu
2017-08-25 18:52:49 +08:00
@isb 2 个还是 4 个,纯粹个人喜好了,我的屏幕足够大,四个看的挺顺眼的😂
ps
2017-08-25 18:55:04 +08:00
四个空格+1
lixinyang
2017-08-25 18:59:53 +08:00
希望提供英文注释版
xcatliu
2017-08-25 19:12:24 +08:00
@ps 握爪🤝
zpvip
2017-08-25 19:12:47 +08:00
原来四个,自从用了两个,觉得四个真是太大了

有编辑器自动对齐,点开头,自动高亮结尾,没必要用四个目测了。
xcatliu
2017-08-25 19:14:06 +08:00
@lixinyang 下一步工作会是完善 test,然后用工具把 test 直接转化为文档网页。然后就会开始英文版的工作
xcatliu
2017-08-25 19:15:18 +08:00
@zpvip 现在的编辑器都很智能,四个两个都不是问题啦
jeneser
2017-08-25 20:33:30 +08:00
standard
2 格
vardarling
2017-08-25 20:49:14 +08:00
2 格缩紧 2k 分辨率上面看的难受
djyde
2017-08-25 21:25:35 +08:00
我用 standard
dong3580
2017-08-25 21:28:21 +08:00
@xcatliu
你不觉得 4 格浪费空间么^_^哈哈
leamtrop
2017-08-25 21:47:51 +08:00
2 格,对齐更好看
xcatliu
2017-08-25 22:03:03 +08:00
@dong3580 屏幕大,就是爽!
xcatliu
2017-08-25 22:03:18 +08:00
@vardarling 同意

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/385804

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX