@zuke/biome

`@zuke/biome` — typed `BiomeTasks` wrappers for the [Biome](https://biomejs.dev)

Symbols

# BiomeCheckSettings class

class BiomeCheckSettings extends BiomeSettings

Settings for biome check (lint + format + organize-imports).

Member	Signature	Doc
`write`	`write(): this`	Write safe fixes back to disk (`--write`).
`unsafe`	`unsafe(): this`	Also apply unsafe fixes; implies writing (`--unsafe`).

# BiomeCiSettings class

class BiomeCiSettings extends BiomeSettings

Settings for biome ci (read-only check tuned for CI).

# BiomeFormatSettings class

class BiomeFormatSettings extends BiomeSettings

Settings for biome format.

Member	Signature	Doc
`write`	`write(): this`	Write formatting changes back to disk (`--write`).

# BiomeLintSettings class

class BiomeLintSettings extends BiomeSettings

Settings for biome lint.

Member	Signature	Doc
`write`	`write(): this`	Write safe lint fixes back to disk (`--write`).
`unsafe`	`unsafe(): this`	Also apply unsafe fixes; implies writing (`--unsafe`).

# BiomeSettings class

class BiomeSettings extends ToolSettings

Base for all biome subcommand settings: the binary is biome, and the common filters (config path, reporter, --staged, --changed) plus the trailing path arguments are shared by every subcommand.

Member	Signature	Doc
`paths`	`paths(...paths: PathLike[]): this`	Files or directories to operate on; omit to use the configured includes.
`config`	`config(path: PathLike): this`	Use an explicit configuration file (`--config-path`).
`reporter`	`reporter(name: string): this`	Choose the diagnostics reporter, e.g. `github` or `json` (`--reporter`).
`staged`	`staged(): this`	Restrict to files staged in git (`--staged`).
`changed`	`changed(): this`	Restrict to files changed against the VCS base (`--changed`).

# BiomeTasks const

const BiomeTasks: BiomeTasksApi

Typed task functions for the biome CLI.

# BiomeTasksApi interface

interface BiomeTasksApi

The shape of BiomeTasks.

Member	Signature	Doc
`check`	`check(configure?: Configure<BiomeCheckSettings>): Promise<CommandOutput>`	Lint, format, and organize imports: `biome check`.
`format`	`format(configure?: Configure<BiomeFormatSettings>): Promise<CommandOutput>`	Format code: `biome format`.
`lint`	`lint(configure?: Configure<BiomeLintSettings>): Promise<CommandOutput>`	Lint code: `biome lint`.
`ci`	`ci(configure?: Configure<BiomeCiSettings>): Promise<CommandOutput>`	Read-only CI check: `biome ci`.