@buka/eslint-config

Buka 基准 Eslint 规则，需要eslint > 9。

@buka/eslint-config 提供四种适用于不同场景的 eslint 规则：

• 适用于 .js 文件的通用的 eslint 规则。
• 适用于 .ts 文件的通用的 eslint 规则。
• 适用于 nuxt 的 eslint 规则。
• 适用于 nestjs 的 eslint 规则。
• 适用于 react 的 eslint 规则。

部分场景除recommended之外，还提供了其他选项。 但并不建议使用其他选项，除非你清楚的知道自己想要做什么。

js

// eslint.config.mjs
import buka from "@buka/eslint-config";

export default [...buka.js.recommend];

| Config | Description | | :-------------------- | :-------------------------------------------------------------------------------------------- | | buka.js.autofix | 仅包含 eslint 支持 autofix 的规则 | | buka.js.recommended | 包含 @eslint/js 的 recommended 规则 和 buka.js.autofix 规则。并增加 Buka 推荐的规则。 |

typescript

// eslint.config.mjs
import buka from "@buka/eslint-config";

export default [...buka.typescript.recommend];

| Config | Description | | :---------------------------- | :------------------------------------------------------------------------------------------------------------ | | buka.typescript.autofix | 仅包含 eslint 和 @typescript-eslint 支持 autofix 的规则 | | buka.typescript.recommended | 包含 @typescript-eslint 的 recommended 规则 和 buka.typescript.autofix 规则。并增加 Buka 推荐的规则。 |

nuxt

此规则需要配合nuxt@3 和 @nuxt/eslint 使用。

// eslint.config.mjs
import buka from "@buka/eslint-config";
import withNuxt from "./.nuxt/eslint.config.mjs";

export default withNuxt(...buka.nuxt.recommended);

| Config | Description | | :---------------------- | :----------------------------- | | buka.nuxt.recommended | 增加 Buka 推荐的规则。 |

nestjs

此规则需要配合 Nestjs 使用。

| Config | Description | | :------------------------ | :------------------------------------------------------------------ | | buka.nestjs.recommended | 在 buka.typescript.recommended 规则上，增加了 NestJS 需要的配置。 |

react

// eslint.config.mjs
import buka from "@buka/eslint-config";

export default buka.react.recommended;

| Config | Description | | :----------------------- | :---------------------------------------------------------------------------------------------------------- | | buka.react.recommended | 在 buka.typescript.recommended 规则上，增加了 eslint-plugin-react 和 eslint-plugin-react-hooks 规则。 |