zuke.tools.dprint

← Python API reference

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

zuke on PyPI ↗ 4 symbols

Symbols

#

DprintCheckSettings

class 
class DprintCheckSettings(DprintSettings)

Settings for dprint check (verify formatting without writing).

#

DprintFmtSettings

class 
class DprintFmtSettings(DprintSettings)

Settings for dprint fmt (format files in place).

#

DprintSettings

class 
class DprintSettings(ToolSettings)

Shared options for a dprint subcommand (fmt or check).

  • config(path: str) -> Self

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

  • files(*patterns: str) -> Self

    File paths or globs to format/check (positional); repeatable.

  • excludes(*patterns: str) -> Self

    Exclude files matching a pattern (--excludes); repeatable.

  • incremental() -> Self

    Only process files that changed since the last run (--incremental).

  • allow_no_files() -> Self

    Do not error when no files are matched (--allow-no-files).

#

DprintTasks

class 
class DprintTasks

Typed task functions for the dprint code formatter.

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

    Format files in place: dprint fmt.

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

    Verify formatting: dprint check.