oxlint-rules-meta

Metadata and JSON data for all Oxlint rules.

Introduction

This library provides comprehensive metadata for all Oxlint rules, including descriptions, categories, schemas, and documentation URLs. It's useful for building linting tools, IDE plugins, or any application that needs to work with Oxlint rule configurations.

Installation

pnpm add oxlint-rules-meta -D

Usage

Get All Rules

import { oxlintRuleMeta, oxlintRules } from 'oxlint-rules-meta'

// Access the full rules object with metadata
console.log(oxlintRules.name) // 'oxlint-rules-meta'
console.log(oxlintRules.version) // current version
console.log(oxlintRules.meta) // { name, version, url, rules }

// Access all rule metadata
console.log(oxlintRuleMeta['no-unused-vars'])
console.log(oxlintRuleMeta['@typescript-eslint/no-explicit-any'])

Get Single Rule Meta

import { getRuleMeta } from 'oxlint-rules-meta'

const ruleMeta = getRuleMeta('no-unused-vars')
console.log(ruleMeta)

Rule Metadata Structure

interface IRulesMeta {
    name: string
    meta?: {
        source?: string // Rule source plugin (e.g., 'eslint', 'typescript')
        category?: string // Rule category
        default?: boolean // Whether enabled by default
        docs?: {
            description?: string
            url?: string // Documentation URL
            category?: string
        }
        fixable?: string // Fix capability
        schema?: JSONSchema4 | JSONSchema4[] | [] // Rule options schema
    }
}

Development

Setup

# Clone the repository
git clone https://github.com/lonewolfyx/oxlint-rules-meta.git

# Install dependencies
pnpm install

# Generate rules metadata
pnpm dev

# Build for production
pnpm build

Scripts

| Script | Description | |--------|-------------| | pnpm dev | Run development mode (generate rules) | | pnpm build | Build the library | | pnpm lint | Run ESLint | | pnpm lint:fix | Fix ESLint errors | | pnpm release | Publish to npm |

API

Exports

// Main exports
export { getRuleMeta, oxlintRuleMeta, oxlintRules }

// Type exports
export type { IOxlintRules, IRulesMeta, IRulesMetaDocs, LintOptions, RulesMetaStrategy }

Related

• Oxlint - The Oxidation Compiler linter
• OXC - The Oxidation Compiler

License

MIT © 2025 lonewolfyx