Kordeta ESLint 规则

名称	包含规则	解析器
标准规则	ESLint 规则	babel-eslint
Vue	ESLint 规则、eslint-plugin-vue	vue-eslint-parser@2.0.1-beta.2 babel-eslint

配置原则

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

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

配置解读

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

每一条配置都有注释说明此配置的用途
对于理解困难的配置，都在注释中有举例
对于有争议的配置，都在注释中说明了为什么要这么配置的原因
对于关闭掉的配置，都在注释中有对应的原因说明，以及 @off 的标识
对于能够 autofix 的配置，都在注释中有标注 @autofix

使用方法

标准规则

安装：

npm install eslint-config-kordeta --save-dev

PS：相关依赖比如eslint、babel-eslint会自动安装，如果原来项目中已有babel-eslint，请确保版本号在8.0.1以下。如果一些依赖安装失败，请先全局安装eslint和关联的依赖。

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

module.exports = {
    extends: [
        'eslint-config-kordeta',
    ],
    globals: {
        // 这里填入你的项目需要的全局变量
        // 这里值为 false 表示这个全局变量不允许被重新赋值，比如：
        //
        // jQuery: false,
        // $: false
    },
    rules: {
        // 这里填入你的项目需要的个性化配置，比如：
        //
        // // @fixable 一个缩进必须用两个空格替代
        // 'indent': [
        //     'error',
        //     2,
        //     {
        //         SwitchCase: 1,
        //         flatTernaryExpressions: true
        //     }
        // ]
    }
};

Vue

安装：

npm install eslint-config-kordeta --save-dev

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

module.exports = {
    extends: [
        'eslint-config-kordeta/vue',
    ],
    globals: {
        // 这里填入你的项目需要的全局变量
        // 这里值为 false 表示这个全局变量不允许被重新赋值，比如：
        //
        // Vue: false
    },
    rules: {
        // 这里填入你的项目需要的个性化配置，比如：
        //
        // // @fixable 一个缩进必须用两个空格替代
        // 'indent': [
        //     'error',
        //     2,
        //     {
        //         SwitchCase: 1,
        //         flatTernaryExpressions: true
        //     }
        // ]
    }
};

Troubleshootings

在 VSCode 中使用

在 VSCode 中，默认 ESLint 并不能识别 .vue文件，需要在「文件 => 首选项 => 设置」里做如下配置：

{
    "eslint.validate": [
        "javascript",
        "javascriptreact",
        "html",
        "vue"
    ]
}

VSCode 中的 autoFixOnSave 没有效果

如果需要针对 .vue文件开启 ESLint 的 autoFix，则需要配置成：

{
    "eslint.autoFixOnSave": true,
    "eslint.validate": [
        "javascript",
        "javascriptreact",
        "html",
        {
            "language": "vue",
            "autoFix": true
        }
    ]
}

Testing

npm test

Julien822/eslint-config-kordeta