@nx/oxlint - Executors
The @nx/oxlint plugin provides various executors to help you create and configure oxlint projects within your Nx workspace. Below is a complete reference for all available executors and their options.
For an overview of the plugin and setup instructions, see the @nx/oxlint introduction.
Lints a project with Oxlint. Runs in batch mode by default, so one Oxlint process lints every project in the run, from the workspace root. Options not listed here are forwarded to Oxlint as CLI flags; paths in them are relative to the workspace root.
The @nx/oxlint:lint executor runs Oxlint on a project. When several projects lint in one command, Nx batches them: one Oxlint process lints every project and each project still gets its own result, cache entry, and output. Pass --batch=false to lint each project in its own process.
Options not listed in the schema are forwarded to Oxlint as CLI flags, so nx run-many -t lint --config a.json runs Oxlint with --config a.json, and the same holds for options set on the target. Oxlint runs from the workspace root, so a path in a forwarded option is workspace-relative rather than project-relative.
In a batch, Oxlint uses the first project’s flags for every project, and Nx warns when another project sets different ones. Each project still uses its own --format, --silent, --max-warnings, and --deny-warnings.
{ "targets": { "lint": { "executor": "@nx/oxlint:lint", "options": { "typeAware": true, "maxWarnings": 0 } } }}Lint only the sources
Section titled “Lint only the sources”Narrow what a project lints with lintFilePatterns. Paths are workspace-relative and {projectRoot} is interpolated.
{ "targets": { "lint": { "executor": "@nx/oxlint:lint", "options": { "lintFilePatterns": ["{projectRoot}/src"] } } }}Fix violations
Section titled “Fix violations”Fixer flags such as --fix pass through to Oxlint.
nx run-many -t lint --fixGitHub Actions annotations
Section titled “GitHub Actions annotations”format is rendered by Nx from the Oxlint JSON report, so the values are default, agent, github, and json. In CI and under an AI agent, default renders one line per diagnostic, as Oxlint itself does.
nx run-many -t lint --format=githubOptions
Section titled “Options”| Option | Type | Description | Default |
|---|---|---|---|
__unparsed__ | array | ||
args | string | Extra arguments appended to the Oxlint command. A string is split on whitespace outside quotes, with no shell escaping or expansion; an array passes each item as one argument. Paths are relative to the workspace root, which is where Oxlint runs. In a batch, Oxlint uses the first project’s arguments, so list extra paths in lintFilePatterns instead. | |
format | string | Output format. Rendered by Nx from the Oxlint JSON report, so only these values are supported. default matches the Oxlint terminal output, and switches to agent in CI or under an AI agent, as Oxlint does. | "default" |
lintFilePatterns | array | One or more files or directories to pass to Oxlint. Oxlint does not expand globs. | ["{projectRoot}"] |
nestedProjectRoots | array | Workspace-relative roots of projects nested inside this one. The inferred target sets this. |