@doist/eslint-config

剂量 ESLint 语录 相会.

使用量

安装

npm install --save-dev @doist/eslint-config

平面配置

// eslint.config.js
import eslintConfig from '@doist/eslint-config'

export default [
    // Core set of rules, recommended for all JS projects
    ...eslintConfig.recommended,
    // OR
    // Core set of rules, recommended for all TS projects
    ...eslintConfig.recommendedTypeChecked,

    // Additional rules for sorting/grouping import statements (optional)
    ...eslintConfig.simpleImportSort,

    // Recommended for projects using React.
    ...eslintConfig.react,
]

.eslintrac Config( 列克西语)

单位 .eslintrc数字 :

{
    // ...
    "extends": [
        // ...

        // Core set of rules, recommended for all projects.
        "@doist/eslint-config/eslintrc/recommended",

        // Additional rules requiring type information (recommended for TypeScript projects).
        "@doist/eslint-config/eslintrc/recommended-type-checked",

        // Additional rules for sorting/grouping import statements (optional)
        "@doist/eslint-config/eslintrc/simple-import-sort"

        // Recommended for projects using React.
        "@doist/eslint-config/eslintrc/react"
    ],

    // When using `recommended-type-checked`,
    // you need to link to `tsconfig.eslint.json` file (see section below) for the project.
    "parserOptions": {
        "project": "tsconfig.eslint.json"
    }
}

导入排序的路径别名支持

如果您的项目使用路径化名( 例如 ) . @components 地图到 src/components/,可以配置 simple-import-sort 通过使用 simpleImportSortFactory。 。 。 .

平面配置 :

// eslint.config.js
import eslintConfig from '@doist/eslint-config'

export default [
    ...eslintConfig.recommended,
    // Replace ...eslintConfig.simpleImportSort with a custom config:
    ...eslintConfig.simpleImportSortFactory({ aliases: ['@app', '@components'] }),
]

遗产配置 ——在 .eslintrc数字 :

const config = {
    extends: ['@doist/eslint-config/eslintrc/simple-import-sort'],
    rules: {
        'simple-import-sort/imports':
            require('@doist/eslint-config/lib/create-simple-import-sort').createSimpleImportSortConfig(
                { aliases: ['@app', '@components'] },
            ),
    },
}

别名归为一组(它们之间没有空白行),按它们在数组中的位置排列.

配置类型检查

对于基于类型的规则,项目 tsconfig.json 文件需要在 parserOptions.project。如果您想要插入未包含在构建中的文件,我们建议 创建单独的 tsconfig.eslint.json 配置并指定它而不是默认的.

注:在平面配置中, recommendedTypeChecked 套装 project: true 默认, 自动检测 tsconfig.json。 。 。 .

释放新软件包

这个项目使用 语义版本。当驱动新标签时,将向 npm 和 GitHub 软件包注册处发布新版本。 请确保增加一个条目 变动情况。 。 。 .

git checkout main
npm version <major|minor|patch>
git push --follow-tags

链接

• ESLint 可共享配置