Skip to content

standard-config/oxlint

Repository files navigation

@standard-config/oxlint

Curated Oxlint config with sensible defaults. Designed as a careful, environment-agnostic baseline for writing better TypeScript.

  • If you’re adopting Oxlint, this config will get you started right away.
  • If you’re migrating from xo, you’ll feel right at home.
  • For additional rules not yet implemented in Oxlint, see @standard-config/eslint.

Install

npm install --save-dev @standard-config/oxlint
pnpm add --save-dev @standard-config/oxlint

For type-aware linting, make sure both oxlint and oxlint-tsgolint are installed.

Usage

Create your oxlint.config.ts:

import { defineConfig } from '@standard-config/oxlint';

export default defineConfig();

Overrides

You can override the defaults by passing your own config options.

import { defineConfig } from '@standard-config/oxlint';

export default defineConfig({
    rules: {
        'typescript/consistent-type-definitions': ['error', 'interface'],
    },
});

React

Standard Config includes a set of React-related rules that are off by default. You can enable them by setting react: true at the root of your config.

import { defineConfig } from '@standard-config/oxlint';

export default defineConfig({
    react: true,
});

FAQ

Can I use this config with Vite+?

Absolutely. In your vite.config.ts:

import { defineOxlintConfig } from '@standard-config/oxlint';
import { defineConfig } from 'vite-plus';

export default defineConfig({
    lint: defineOxlintConfig({
        react: true,
        rules: {
            /* Optional overrides */
        },
    }),
});

Related

License

MIT © Dom Porada

About

Curated Oxlint config with sensible defaults

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Contributors