@bluzzi/eslint-配置

即时使用 ESLint 配置预设,高度有见地,严格的最佳做法,使您既能插入,又能 格式 您的 JavaScript 和 TypeScript 文件.

• QQ 格式化( Pretier 选项), 仅包含基本配置( 半、 引号、 缩进)
• JS和TS非常严格的规则,鼓励最佳做法
• 与TS、JSX和React合作
• qq 自动启用基于您的依赖关系的特定规则
• QQ使用推荐的共享配置( ESLint, TSLint, Stylistic...)

如果你是想找一个 更贴切的配置 我建议你 Antfu 预设。 。 。 .

安装

在您的工程中安装配置预设 .

软件包

npm install -D eslint @bluzzi/eslint-config

yarn add --dev eslint @bluzzi/eslint-config

pnpm install -D eslint @bluzzi/eslint-config

配置文件

创建 eslint.config.mjs 并添加最小配置 :

import { eslintConfig } from "@bluzzi/eslint-config";

export default eslintConfig();

脚本

在您的 package.json 文件中,您可以选择添加以下脚本来方便地运行项目中的 ESLint :

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

VS 代码支持

VS代码插件的安装和配置,在保存文件时利用自动更正,以及显示出问题.

安装 VS 代码 ESLint 扩展 中添加以下设置: .vscode/settings.json数字 :

{
  // Disable the default formatter, use eslint instead:
  "prettier.enable": false,
  "editor.formatOnSave": false,

  // Auto fix:
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit",
    "source.organizeImports": "never"
  },

  // Silent the stylistic rules in you IDE, but still auto fix them:
  "eslint.rules.customizations": [
    { "rule": "style/*", "severity": "off", "fixable": true },
    { "rule": "format/*", "severity": "off", "fixable": true },
    { "rule": "*-indent", "severity": "off", "fixable": true },
    { "rule": "*-spacing", "severity": "off", "fixable": true },
    { "rule": "*-spaces", "severity": "off", "fixable": true },
    { "rule": "*-order", "severity": "off", "fixable": true },
    { "rule": "*-dangle", "severity": "off", "fixable": true },
    { "rule": "*-newline", "severity": "off", "fixable": true },
    { "rule": "*quotes", "severity": "off", "fixable": true },
    { "rule": "*semi", "severity": "off", "fixable": true }
  ],

  // Enable eslint for all supported languages:
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact"
  ]
}

自定义

你可以调整一些代码的格式选项,但我们建议坚持 结构化JS社区内部一致性的默认规则:

export default eslintConfig({
  stylistic: {
    indent: 2,
    quotes: "single",
    semi: false,
  },
});

你可以充分利用 ESLint 的平面配置 任意扩展配置 :

export default eslintConfig(
  {
    // The configuration options offered by our package
  },

  // From the second arguments they are ESLint Flat Configs
  // you can have multiple configs:
  {
    files: ["**/*.ts"],
    rules: {},
  },
  {
    rules: {},
  },
);

谢谢

• 傅安东尼为了他的 配置预设 委员会的工作 结构化
• ESLint团队,为此 惊人的项目 推动整个JS生态系统向前发展

许可证

这个包裹是麻省理工学院许可的.