OXC.Lint (OXC v0.18.0)

Copy Markdown View Source

Lint JavaScript/TypeScript source with oxlint's built-in rules and optional custom Elixir rules.

Combines native Rust performance for 650+ standard rules with the ability to write project-specific rules in Elixir using the same AST that OXC.parse/2 returns.

Examples

{:ok, diags} = OXC.Lint.run("debugger;", "test.js",
  rules: %{"no-debugger" => :deny})

{:ok, []} = OXC.Lint.run("export const x = 1;\n", "test.ts")

Summary

Types

diagnostic()
global_access()
option()
plugin()

An oxlint plugin name, such as "react" or "jsx-a11y".

severity()

Rule severity in lint options. Findings report :error for :deny and :warning for :warn.

Functions

run(files, opts)

Lint source code with oxlint's built-in rules and optional custom rules.

run(source, filename, opts \\ [])
run!(source, filename, opts \\ [])

Like run/3 but raises on errors.

Types

diagnostic()

@type diagnostic() :: OXC.Diagnostic.t()

global_access()

@type global_access() :: :readonly | :writable | :off

option()

@type option() ::
  {:rules, %{required(String.t()) => severity()}}
  | {:plugins, [plugin()]}
  | {:env, [String.t()]}
  | {:globals, %{required(String.t()) => global_access()}}
  | {:fix, boolean()}
  | {:custom_rules, [{module(), severity()}]}
  | {:settings, map()}

plugin()

@type plugin() :: String.t()

An oxlint plugin name, such as "react" or "jsx-a11y".

severity()

@type severity() :: :allow | :warn | :deny

Rule severity in lint options. Findings report :error for :deny and :warning for :warn.

Functions

run(files, opts)

@spec run([String.t()], [OXC.Lint.TypeAware.option()]) ::
  {:ok, [diagnostic()]} | {:error, [diagnostic()]}

Lint source code with oxlint's built-in rules and optional custom rules.

Pass a list of files with type_aware: true to run TypeScript type-aware rules through tsgolint headless mode:

OXC.Lint.run(["lib/app.ts"],
  type_aware: true,
  tsgolint: "tsgolint",
  rules: %{"typescript/no-floating-promises" => :deny})

Options

  • :rules — map of rule names to severity (:deny, :warn, :allow). Rule names follow oxlint conventions: "eqeqeq", "react/no-danger", "typescript/no-explicit-any", etc.

  • :plugins — oxlint plugin names to enable, such as ["react", "jsx-a11y"], accepting the same names and aliases as an oxlint config file. Default: oxlint's default plugins. Unknown names are errors.

  • :fix — compute fix suggestions. Default: false

  • :env — list of enabled Oxlint environment names, for example ["browser", "node", "mocha"].

  • :globals — map of global names to :readonly, :writable, or :off, for example %{"jQuery" => :readonly}.

  • :custom_rules — list of {module, severity} tuples for Elixir rules. Each module must implement the OXC.Lint.Rule behaviour.

  • :settings — arbitrary map passed to custom rule context.

Examples

# Built-in rules only
{:ok, diags} = OXC.Lint.run("debugger;", "test.js",
  rules: %{"no-debugger" => :deny})

# With specific plugins and rules
{:ok, diags} = OXC.Lint.run(source, "app.tsx",
  plugins: ["react", "typescript"],
  rules: %{"no-console" => :warn, "react/no-danger" => :deny}
)

# With custom Elixir rules
{:ok, diags} = OXC.Lint.run(source, "app.ts",
  custom_rules: [{MyApp.NoConsoleLog, :warn}]
)

run(source, filename, opts \\ [])

@spec run(iodata(), String.t(), [option()]) ::
  {:ok, [diagnostic()]} | {:error, [diagnostic()]}

run!(source, filename, opts \\ [])

@spec run!(iodata(), String.t(), [option()]) :: [diagnostic()]

Like run/3 but raises on errors.