@the1812/oxc-config

按照个人喜好 (@the1812) 配置的 OXC Config. 可用于 JavaScript 和 TypeScript 项目。

由于 OXC 暂不支持 Vue，Vue 项目目前只能通过 TSX 形式接受 OXC 检测。

安装

pnpm add -D @the1812/oxc-config oxlint oxfmt oxlint-tsgolint

Oxlint

在项目根目录创建 oxlint.config.ts：

import config from '@the1812/oxc-config/oxlint'
import { defineConfig } from 'oxlint'

export default defineConfig({
  extends: [config],
  categories: {
    correctness: 'off',
  },
  options: {
    typeAware: true,
    typeCheck: true,
  },
  ignorePatterns: ['dist/', 'node_modules/'],
})

Oxlint 的 extends 只继承规则、插件和覆盖项，因此 categories、options 与 ignorePatterns 必须由项目根配置显式设置。

Oxfmt

在项目根目录创建 oxfmt.config.ts：

import config from '@the1812/oxc-config/oxfmt'

export default config

需要增加项目特有的忽略项时：

import config from '@the1812/oxc-config/oxfmt'
import { defineConfig } from 'oxfmt'

export default defineConfig({
  ...config,
  ignorePatterns: [...config.ignorePatterns, 'generated/'],
})

Vite+

import oxfmtConfig from '@the1812/oxc-config/oxfmt'
import oxlintConfig from '@the1812/oxc-config/oxlint'
import { defineConfig } from 'vite-plus'

export default defineConfig({
  fmt: oxfmtConfig,
  lint: {
    ...oxlintConfig,
    categories: {
      correctness: 'off',
    },
    options: {
      typeAware: true,
      typeCheck: true,
    },
  },
})