Skip to content
TypeScript Dev Toolkitv3.7.2

formatters/biome

Format the source code with Biome.

Interfaces

Section titled “Interfaces”
Interface Description
EnsureBiomeConfigOptions Parameters for the ensureBiomeConfig function.
FormatOptions Parameters for the format function.

Functions

Section titled “Functions”
Function Description
ensureBiomeConfig Makes sure the project has a Biome configuration of its own. Biome resolves a configuration’s VCS root and globs against the configuration file’s own folder, so a shared configuration cannot be passed with --config-path from inside node_modules: it looks for .gitignore there. The project’s own biome.json extends it instead. When there is none, the default one is copied in, or a biome.json extending the shared configuration is written.
format Format the source code with Biome.
hasBiomeConfig Says whether the project configures Biome itself.

Variables

Section titled “Variables”
Variable Description
BIOME_CONFIG_FILE_NAMES The files Biome reads its configuration from.
BIOME_EXPLICIT_PATHS_ARGUMENTS The flags that make Biome skip, rather than fail on, a path it is handed but does not handle: a pre-commit hook hands every tool explicit file lists, which can name a file Biome does not know or a file the project ignores.