@zuke/oxlint

`@zuke/oxlint` — typed `oxlint` task wrappers for Zuke builds.

Symbols

# OxlintSettings class

class OxlintSettings extends ToolSettings

Settings for an oxlint run.

Member	Signature	Doc
`paths`	`paths(...values: PathLike[]): this`	Files or directories to lint (positional); repeatable.
`config`	`config(path: PathLike): this`	Use an explicit config file (`-c`/`--config`).
`tsconfig`	`tsconfig(path: PathLike): this`	Point at a `tsconfig.json` for type-aware rules (`--tsconfig`).
`fix`	`fix(): this`	Apply automatic fixes (`--fix`).
`fixSuggestions`	`fixSuggestions(): this`	Apply suggestion fixes too (`--fix-suggestions`).
`deny`	`deny(rule: string): this`	Raise a rule or category to error (`-D`/`--deny`); repeatable.
`warn`	`warn(rule: string): this`	Set a rule or category to warning (`-W`/`--warn`); repeatable.
`allow`	`allow(rule: string): this`	Turn a rule or category off (`-A`/`--allow`); repeatable.
`ignorePath`	`ignorePath(path: PathLike): this`	Read ignore globs from a file (`--ignore-path`).
`ignorePattern`	`ignorePattern(glob: string): this`	Ignore files matching a glob (`--ignore-pattern`); repeatable.
`maxWarnings`	`maxWarnings(count: number): this`	Fail once this many warnings are reached (`--max-warnings`).
`quietWarnings`	`quietWarnings(): this`	Report errors only, suppressing warnings (`--quiet`).
`denyWarnings`	`denyWarnings(): this`	Exit non-zero if any warnings are found (`--deny-warnings`).
`format`	`format(value: string): this`	Output format, e.g. `default`, `json`, `github` (`-f`/`--format`).
`threads`	`threads(count: number): this`	Number of threads to use (`--threads`).

# OxlintTasks const

const OxlintTasks: OxlintTasksApi

Typed task functions for the oxlint linter.

# OxlintTasksApi interface

interface OxlintTasksApi

The shape of OxlintTasks.

Member	Signature	Doc
`lint`	`lint(configure?: Configure<OxlintSettings>): Promise<CommandOutput>`	Lint with `oxlint`.