Skip to content
Public template

About

Template for an Oxlint plugin: Vite+, tests, dogfood run, tokenless publishing, contribution kit.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

oxlint-plugin-template

npm version npm downloads CI license

DESCRIPTION

It catches things like:

// FIXME: handle empty input     ← no-fixme

Install

npm i -D oxlint oxlint-plugin-template
pnpm add -D oxlint oxlint-plugin-template
yarn add -D oxlint oxlint-plugin-template
bun add -d oxlint oxlint-plugin-template

Use

oxlint.config.ts:

import { defineConfig } from "oxlint";
import plugin from "oxlint-plugin-template";

export default defineConfig({
  extends: [plugin.configs.recommended],
});

Or .oxlintrc.json:

{
  "jsPlugins": ["oxlint-plugin-template"],
  "rules": {
    "template/no-fixme": "warn"
  }
}

The same package loads in ESLint 9: plugins: { template: plugin }.

Rules

🔧 has an autofix. ✅ is in recommended.

Rule What it flags 🔧 ✅
no-fixme Comments containing FIXME. ✅

Contributing

Read CONTRIBUTING.md. The short version: pnpm new-rule <name> scaffolds a rule with its test and doc page, PR titles are conventional commits, and issues labelled good first issue are a fine place to start.

License

MIT

About

Template for an Oxlint plugin: Vite+, tests, dogfood run, tokenless publishing, contribution kit.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages