Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (oxlint) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OXC Logo

⚓ Oxc

The Oxidation Compiler is creating a suite of high-performance tools for JavaScript and TypeScript.

Oxlint

This is the linter for oxc.

Run

npx --yes oxlint@latest in your JavaScript / TypeScript codebase and see it complete in milliseconds. No configurations are required.
npx oxlint@latest --help for usage instructions.
npx oxlint@latest --rules for the list of rules.

Usage Instructions

npx oxlint@latest --help:

Usage: oxlint [-A=NAME | -D=NAME]... [--fix] [-c=<./eslintrc.json>] [PATH]...

Allowing / Denying Multiple Lints
  For example `-D correctness -A no-debugger` or `-A all -D no-debugger`.
  The default category is "-D correctness".
  Use "--rules" for rule names.
  Use "--help --help" for rule categories.
    -A, --allow=NAME          Allow the rule or category (suppress the lint)
    -D, --deny=NAME           Deny the rule or category (emit an error)

Enable Plugins
        --import-plugin       Enable the experimental import plugin and detect ESM problems. It is
                              recommended to use along side with the `--tsconfig` option.
        --jsdoc-plugin        Enable the experimental jsdoc plugin and detect JSDoc problems
        --jest-plugin         Enable the Jest plugin and detect test problems
        --jsx-a11y-plugin     Enable the JSX-a11y plugin and detect accessibility problems
        --nextjs-plugin       Enable the Next.js plugin and detect Next.js problems
        --react-perf-plugin   Enable the React performance plugin and detect rendering performance
                              problems

Fix Problems
        --fix                 Fix as many issues as possible. Only unfixed issues are reported in
                              the output

Ignore Files
        --ignore-path=PATH    Specify the file to use as your .eslintignore
        --ignore-pattern=PAT  Specify patterns of files to ignore (in addition to those in
                              .eslintignore)
        --no-ignore           Disables excluding of files from .eslintignore files, --ignore-path
                              flags and --ignore-pattern flags

Handle Warnings
        --quiet               Disable reporting on warnings, only errors are reported
        --deny-warnings       Ensure warnings produce a non-zero exit code
        --max-warnings=INT    Specify a warning threshold, which can be used to force exit with an
                              error status if there are too many warning-level rule violations in
                              your project

Output
    -f, --format=ARG          Use a specific output format (default, json, checkstyle, unix)

Miscellaneous
        --threads=INT         Number of threads to use. Set to 1 for using only 1 CPU core

Available positional items:
    PATH                      Single file, single path or list of paths

Available options:
        --rules               list all the rules that are currently registered
    -c, --config=<./eslintrc.json>  ESLint configuration file (experimental)
        --tsconfig=<./tsconfig.json>  TypeScript `tsconfig.json` path for reading path alias and
                              project references for import plugin
    -h, --help                Prints help information
    -V, --version             Prints version information