@fnko/config

A sensible, opinionated Oxlint config for modern JavaScript and TypeScript projects.

Installation

Install @fnko/config as a dev dependency:

$ npm add -D @fnko/config

Add rulesets to your Vite+ config:

import { defineConfig } from "vite-plus";
import { core, strict, typed, viteplus } from "@fnko/config/oxlint";

export default defineConfig({
  lint: {
    extends: [core, strict, typed, viteplus],
  },
});

Tip

If you're not using Vite+, you can use the rulesets directly with Oxlint:

Show config

import { defineConfig } from "oxlint";
import { core, strict, typed } from "@fnko/config/oxlint";

export default defineConfig({
  extends: [core, strict, typed],
});

Rulesets

Ruleset	Description
core	General project rules applicable for most codebases.
jsdoc	JSDoc documentation rules.
strict	Stricter rules that might not fit all codebases.
sveltekit	SvelteKit rules.
typed	TypeScript rules that use type information.
viteplus	Vite+ toolchain rules.

Philosophy

Target

We target modern, ESM-first JavaScript and TypeScript projects. Read Move on to ESM-only to learn why.

Rules

Rule selection is subjective. If you disagree with a rule or have a suggestion, feel free to open an issue.

License

This project is licensed under the MIT License. See the LICENSE file for details.