@ecomfe/eslint-config

    7.1.0 • Public • Published

    @ecomfe/eslint-config

    EFE 团队使用的 ESLint 配置。

    安装

    npm i -D eslint @babel/eslint-parser @babel/eslint-plugin @ecomfe/eslint-config

    使用

    .eslintrc.js 中使用:

    module.exports = {
        extends: [
            '@ecomfe/eslint-config',
        ],
    };

    也可开启严格模式:

    module.exports = {
        extends: [
            '@ecomfe/eslint-config/strict',
        ],
    };

    扩展

    import

    如果需要检测与 import 相关的规则,需要安装这个插件:

    npm i -D eslint-plugin-import

    并在 .eslintrc.js 中引用:

    module.exports = {
        extends: [
            '@ecomfe/eslint-config',
            '@ecomfe/eslint-config/import',
            // 或者选择严格模式
            // '@ecomfe/eslint-config/import/strict',
        ],
    };

    注意这些规则会要求使用 ES6 的 import 来引入依赖,如果使用的是 require 则会出现检查错误,可禁用 import/no-commonjsimport/unambiguous 来解决。

    React

    如果需要检测 React 相关的代码,需要安装相关插件:

    npm i -D eslint-plugin-react eslint-plugin-react-hooks

    并在 .eslintrc.js 中引用:

    module.exports = {
        extends: [
            '@ecomfe/eslint-config',
            '@ecomfe/eslint-config/react',
            // 或者选择严格模式
            // '@ecomfe/eslint-config/react/strict',
        ],
    };

    会自动检测本地 React 的版本,默认情况下无需其它配置。

    Vue

    如果需要检测 Vue 相关的代码,需要安装相关插件:

    npm i -D eslint-plugin-vue

    并在 .eslintrc.js 中引用:

    module.exports = {
        extends: [
            '@ecomfe/eslint-config',
            '@ecomfe/eslint-config/vue', // 注意顺序
            // 或者选择严格模式
            // '@ecomfe/eslint-config/vue/strict',
        ],
    };

    San

    如果需要检测 San 相关的代码,需要安装相关插件:

    npm i -D eslint-plugin-san

    并在 .eslintrc.js 中引用:

    module.exports = {
        extends: [
            '@ecomfe/eslint-config',
            '@ecomfe/eslint-config/san', // 注意顺序
            // 或者选择严格模式
            // '@ecomfe/eslint-config/san/strict',
        ],
    };

    TypeScript

    如果需要检测 TypeScript 代码,需要安装相关插件:

    npm i -D @typescript-eslint/parser @typescript-eslint/eslint-plugin

    除此之外,需要先安装typescript包,并在项目根目录有tsconfig.json文件

    并在.eslintrc.js中引用:

    module.exports = {
        extends: [
            '@ecomfe/eslint-config',
            '@ecomfe/eslint-config/typescript',
            // 或者选择严格模式
            // '@ecomfe/eslint-config/typescript/strict',
        ],
    };

    细节

    默认配置 @ecomfe/eslint-configFECS 相同,但临时移除了 fecs-* 的规则。

    严格版配置 */strict 开启了更严格的规则。

    Keywords

    none

    Install

    npm i @ecomfe/eslint-config

    DownloadsWeekly Downloads

    300

    Version

    7.1.0

    License

    MIT

    Unpacked Size

    63.7 kB

    Total Files

    24

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar