zuke.tools.orval

← Python API reference

@zuke/orval 1.0.1: @zuke/orval — typed orval task wrappers for Zuke builds.

zuke on PyPI ↗ 2 symbols

Symbols

#

OrvalGenerateSettings

class 
class OrvalGenerateSettings(ToolSettings)

Settings for an orval generation run.

  • config(value: str) -> Self

    Configuration file to load settings from (-c/--config).

  • project(value: str) -> Self

    Run only the named project from the config (-p/--project).

  • input(value: str) -> Self

    OpenAPI specification to read — a file path or URL (-i/--input).

  • output(value: str) -> Self

    Directory the generated client is written to (-o/--output).

  • watch() -> Self

    Regenerate on changes to the specification (-w/--watch).

  • clean() -> Self

    Remove previously generated files before writing (--clean).

  • prettier() -> Self

    Format the generated output with Prettier (--prettier).

  • biome() -> Self

    Format the generated output with Biome (--biome).

  • mock() -> Self

    Generate mocks alongside the client (--mock).

#

OrvalTasks

class 
class OrvalTasks

Typed task functions for the orval OpenAPI client and mock generator.

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

    Generate a TypeScript API client and mocks from an OpenAPI spec with orval.