eslint-config-sufu

一套我自己用着觉得舒服的 eslint 规则。

这套规则参考了许多 eslint-config-alloy 里的配置，如果你不喜我这个配置，建议你去看看 eslint-config-alloy 的。

不同于 eslint-config-alloy，该配置并没有使用 Prettier 来格式化代码，因为我觉得 Prettier 的可配置性不够，格式化出来的代码很多时候达不到要求。

使用方法

1. 安装

npm install --save-dev eslint-config-sufu

2. 创建 eslint.config.js

const sufu = require('eslint-config-sufu');

module.exports = [
    /**
     * 如果你的项目只有 javascript 那就选 js
     * 如果你的项目只有 typescript 那就选 ts
     * 如果你的项目既有 javascript 又有 typescript 那就选 js-ts
     */
    ...sufu['js-ts'],
    {
        rules: {
            /**
             * 添加自定义规则
             */
        }
    }
];

3. 在 package.json 中添加以下 script

这里只对 src 和 test 文件夹进行了检查，实际使用时可以修改

{
    "lint-js": "eslint --max-warnings 0 \"{src,test}/**/*.{js,mjs,cjs,jsx}\"",
    "lint-ts": "eslint --max-warnings 0 \"{src,test}/**/*.{ts,mts,cts,tsx}\"",
    "lint-js-ts": "eslint --max-warnings 0 \"{src,test}/**/*.{js,mjs,cjs,jsx,ts,mts,cts,tsx}\"",
}

常见问题

如果遇到类似于以下的报错

Parsing error: "parserOptions.project" has been provided for @typescript-eslint/parser.
The file was not found in any of the provided project(s): test\index.test.ts

那大概率是因为你正在 Lint 的文件并没有包含在 tsconfig.json 的 include 当中。

第一种解决办法就是把你要 Lint 的文件添加到 include 当中。

第二种解决办法就是创建一个 tsconfig.eslint.json 文件

{
    "extends": "./tsconfig.json",
    "include": ["**/*"]
}

接着在 eslint.config.js 中添加下面这条规则

{
    files: ['**/*.{ts,mts,cts,tsx}'],
    languageOptions: {
        parserOptions: {
            project: './tsconfig.eslint.json',
            projectService: false
        }
    }
}