zuke.tools.oxlint

← Python API reference

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

Symbols

#

OxlintSettings

class
class OxlintSettings(ToolSettings)

Settings for an oxlint run.

  • paths(*values: str) -> Self

    Files or directories to lint (positional); repeatable.

  • config(path: str) -> Self

    Use an explicit config file (-c/--config).

  • tsconfig(path: str) -> Self

    Point at a tsconfig.json for type-aware rules (--tsconfig).

  • fix() -> Self

    Apply automatic fixes (--fix).

  • fix_suggestions() -> Self

    Apply suggestion fixes too (--fix-suggestions).

  • deny(rule: str) -> Self

    Raise a rule or category to error (-D/--deny); repeatable.

  • warn(rule: str) -> Self

    Set a rule or category to warning (-W/--warn); repeatable.

  • allow(rule: str) -> Self

    Turn a rule or category off (-A/--allow); repeatable.

  • ignore_path(path: str) -> Self

    Read ignore globs from a file (--ignore-path).

  • ignore_pattern(glob: str) -> Self

    Ignore files matching a glob (--ignore-pattern); repeatable.

  • max_warnings(count: float) -> Self

    Fail once this many warnings are reached (--max-warnings).

  • quiet_warnings() -> Self

    Report errors only, suppressing warnings (--quiet).

  • deny_warnings() -> Self

    Exit non-zero if any warnings are found (--deny-warnings).

  • format(value: str) -> Self

    Output format, e.g. default, json, github (-f/--format).

  • threads(count: float) -> Self

    Number of threads to use (--threads).

#

OxlintTasks

class
class OxlintTasks

Typed task functions for the oxlint linter.

  • static async lint(ctx: ServiceContext, configure: Callable[[OxlintSettings], OxlintSettings] | None=None) -> ExecResult

    Lint with oxlint.