@jiakun-zhao/config

@jiakun-zhao/config

Shared config package that exports oxlint rule presets and oxfmt formatter config for downstream consumption.

Install

npm i -D @jiakun-zhao/config oxfmt oxlint oxlint-tsgolint

Usage

oxfmt

Create oxfmt.config.ts:

import { defineOxfmtConfig } from '@jiakun-zhao/config'

export default defineOxfmtConfig()

Pass options to override defaults:

import { defineOxfmtConfig } from '@jiakun-zhao/config'

export default defineOxfmtConfig({ semi: true })

oxlint

Create oxlint.config.ts:

import { defineOxlintConfig } from '@jiakun-zhao/config'

export default defineOxlintConfig()

Pass options to override defaults:

import { defineOxlintConfig } from '@jiakun-zhao/config'

export default defineOxlintConfig({
  rules: { 'typescript/ban-types': 'off' },
})

Default config

oxfmt

Option	Default
jsxSingleQuote	true
semi	false
singleQuote	true
sortImports.newlinesBetween	false
sortPackageJson.sortScripts	true

oxlint

Categories (all set to error): correctness, perf, restriction, style, suspicious

Plugins: eslint, typescript, unicorn, oxc, import, jsdoc, jsx-a11y, node, promise, vitest

Options: typeAware: true, typeCheck: true

Rules:

Rule	Severity
eslint/func-style	off
eslint/sort-imports	off
import/group-exports	off
import/no-default-export	off
import/no-named-export	off
import/prefer-default-export	off
typescript/ban-types	error
unicorn/prefer-node-protocol	error

License

MIT