@three-doctor/oxlint-plugin

Oxlint bridge metadata for Three Doctor static diagnostics.

This package exposes Three Doctor's static rule metadata and a helper for creating an Oxlint bridge config. It is a metadata/config bridge package, not a native Oxlint plugin that executes Rust-side Oxlint rules. Use it to keep Oxlint-driven workflows aware of Three Doctor rule IDs, severities, and command wiring.

Install

npm install --save-dev three-doctor @three-doctor/oxlint-plugin

Node.js 20 or newer is required.

Usage

import {
  pluginName,
  rules,
  createOxlintBridgeConfig
} from "@three-doctor/oxlint-plugin";

console.log(pluginName);
console.log(Object.keys(rules));

export default createOxlintBridgeConfig({
  failOn: "warning",
  command: "three-doctor . --json-compact"
});

rules is a metadata map keyed by Three Doctor rule id:

{
  "useframe-set-state": {
    id: "useframe-set-state",
    category: "R3F",
    severity: "warning",
    message: "Avoid React state updates inside useFrame.",
    help: "Mutate refs or Three objects inside the frame loop...",
    url: "https://r3f.docs.pmnd.rs/advanced/pitfalls"
  }
}

CLI Pairing

Run Three Doctor directly for full diagnostics:

three-doctor . --json-compact
three-doctor . --diff main --annotations --sarif

License

MIT