@beisen/eslint-config-beisenux

BeisenUx ESLint 规则

名称	包含规则	解析器
标准规则	[ESLint 规则][]	[babel-eslint][]
React	ESLint 规则、[eslint-plugin-react][]	babel-eslint
[babel-eslint]: https://github.com/babel/babel-eslint
[ESLint 规则]: https://eslint.org/docs/rules/
[eslint-plugin-react]: https://github.com/yannickcr/eslint-plugin-react

配置原则

参考ESlint规则以及优秀团队的经验，定制出了ESLint 配置

1. 能够发现代码错误的规则，默认全部开启
2. 在不过多影响开发体验下，保持团队的代码风格统一
3. 合理、标准、通用

使用方法

标准规则

安装：

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

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

module.exports = {
    extends: [
        'eslint-config-beisenux',
    ],
    globals: {
        // 这里填入你的项目需要的全局变量
    },
    rules: {
        // 这里填入你的项目需要的个性化配置
    }
};

React

安装：

npm install --save-dev eslint babel-eslint eslint-plugin-react eslint-config-beisenux

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

module.exports = {
    extends: [
        'eslint-config-beisenux/react',
    ],
    globals: {
        // 这里填入你的项目需要的全局变量
    },
    rules: {
        // 这里填入你的项目需要的个性化配置
    }
};

Troubleshootings

在 VSCode 中使用

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

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

VSCode 中的 autoFixOnSave 没有效果

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

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