@zuke/dprint

← API reference

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

Symbols

# DprintCheckSettings class
class DprintCheckSettings extends DprintSettings

Settings for dprint check (verify formatting without writing).

# DprintFmtSettings class
class DprintFmtSettings extends DprintSettings

Settings for dprint fmt (format files in place).

# DprintSettings class
class DprintSettings extends ToolSettings

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

MemberSignatureDoc
config config(path: PathLike): this Use an explicit config file (-c/--config).
files files(...patterns: PathLike[]): this File paths or globs to format/check (positional); repeatable.
excludes excludes(...patterns: string[]): this Exclude files matching a pattern (--excludes); repeatable.
incremental incremental(): this Only process files that changed since the last run (--incremental).
allowNoFiles allowNoFiles(): this Do not error when no files are matched (--allow-no-files).
# DprintTasks const
const DprintTasks: DprintTasksApi

Typed task functions for the dprint code formatter.

# DprintTasksApi interface
interface DprintTasksApi

The shape of DprintTasks.

MemberSignatureDoc
fmt fmt(configure?: Configure<DprintFmtSettings>): Promise<CommandOutput> Format files in place: dprint fmt.
check check(configure?: Configure<DprintCheckSettings>): Promise<CommandOutput> Verify formatting: dprint check.