Skip to content

buka-inc/npm.eslint-config

Repository files navigation

@buka/eslint-config

version downloads dependencies license

Buka 基准 Eslint 规则,需要eslint > 9

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

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

javascript

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

export default defineConfig([
  {
    files: ["**/*.js"],
    extends: [buka.javascript.recommended],
  },
]);
Config Description
buka.javascript.fixable 仅包含 @eslint/js@stylistic/eslint-plugin 支持 --fix 的规则
buka.javascript.recommended 包含 @eslint/jsrecommended 规则 和 buka.javascript.fixable 规则。

typescript

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

export default defineConfig([
  {
    files: ["**/*.ts"],
    extends: [buka.typescript.recommended],
  },
]);
Config Description
buka.typescript.fixable 包含 @eslint/js@stylistic/eslint-plugin@typescript-eslint 支持 --fix 的规则。
buka.typescript.recommended 包含 @typescript-eslintrecommended 规则 和 buka.typescript.fixable 规则。

nestjs

此规则需要配合 Nestjs 使用。

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

export default defineConfig([
  {
    files: ["**/*.ts"],
    extends: [buka.nestjs.recommended],
  },
]);
Config Description
buka.nestjs.recommended buka.typescript.recommended 规则上,添加了适配 NestJSrules

Packages

 
 
 

Contributors