`javascript.biome_config` Submodule

Structs

Actions

Initializer

import { javascript } from 'projen'

const actions: javascript.biome_config.Actions = { ... }

Properties

Name	Type	Description
`preset`	`projen.javascript.biome_config.PresetConfig`	Selects the baseline set of assist actions.
`recommended`	`boolean`	Enables or disables Biome's recommended assist actions across all action groups.
`source`	`projen.javascript.biome_config.Source`	Configures source-level actions such as organizing imports and sorting declarations.

`preset`^Optional

public readonly preset: PresetConfig;

Type: projen.javascript.biome_config.PresetConfig
Default: recommended`.

Selects the baseline set of assist actions.

recommended enables Biome's recommended actions, all enables all actions, and none starts with no actions enabled. Group presets and explicit action settings override this preset. Defaults to recommended.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean
Default: true`.

Enables or disables Biome's recommended assist actions across all action groups.

Defaults to true.

`source`^Optional

public readonly source: Source;

Type: projen.javascript.biome_config.Source

Configures source-level actions such as organizing imports and sorting declarations.

These actions are exposed through editor source actions and through CLI checking and application.

AssistConfiguration

Initializer

import { javascript } from 'projen'

const assistConfiguration: javascript.biome_config.AssistConfiguration = { ... }

Properties

Name	Type	Description
`actions`	`projen.javascript.biome_config.Actions`	The assist-action configuration.
`enabled`	`boolean`	Enables configured assist actions in the CLI and editor integrations.
`includes`	`string[]`	A list of glob patterns selecting files on which assist actions can run.

`actions`^Optional

public readonly actions: Actions;

Type: projen.javascript.biome_config.Actions

The assist-action configuration.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: true`.

Enables configured assist actions in the CLI and editor integrations.

Defaults to true.

`includes`^Optional

public readonly includes: string[];

Type: string[]

A list of glob patterns selecting files on which assist actions can run.

If omitted, all files selected by files.includes remain eligible for assist actions. An empty list selects no files. This option can only narrow the files selected by files.includes.

BiomeConfiguration

The configuration contained in biome.json or biome.jsonc.

Initializer

import { javascript } from 'projen'

const biomeConfiguration: javascript.biome_config.BiomeConfiguration = { ... }

Properties

Name	Type	Description
`assist`	`projen.javascript.biome_config.AssistConfiguration`	The assist configuration.
`css`	`projen.javascript.biome_config.CssConfiguration`	Configuration specific to CSS.
`extends`	`any`	Extends the current configuration with settings from one or more other Biome configurations.
`files`	`projen.javascript.biome_config.FilesConfiguration`	Configures which files Biome can discover and process.
`formatter`	`projen.javascript.biome_config.FormatterConfiguration`	Configures formatting for selected files.
`graphql`	`projen.javascript.biome_config.GraphqlConfiguration`	Configuration specific to GraphQL.
`grit`	`projen.javascript.biome_config.GritConfiguration`	Configuration specific to GritQL.
`html`	`projen.javascript.biome_config.HtmlConfiguration`	Configuration specific to HTML.
`javascript`	`projen.javascript.biome_config.JsConfiguration`	Configuration specific to JavaScript.
`json`	`projen.javascript.biome_config.JsonConfiguration`	Configuration specific to JSON.
`linter`	`projen.javascript.biome_config.LinterConfiguration`	The linter configuration.
`markdown`	`projen.javascript.biome_config.MarkdownConfiguration`	Configuration specific to Markdown.
`overrides`	`projen.javascript.biome_config.OverridePattern[]`	Configures settings for files selected by each override.
`plugins`	`any[]`	A list of GritQL plugins to load.
`root`	`boolean`	Marks whether this file is the root configuration for a Biome project.
`schema`	`string`	The JSON Schema used to validate the configuration and provide editor completion.
`tailwind`	`projen.javascript.biome_config.TailwindConfiguration`	Configures how Biome recognizes Tailwind class strings.
`vcs`	`projen.javascript.biome_config.VcsConfiguration`	The version control integration configuration.
`yaml`	`projen.javascript.biome_config.YamlConfiguration`	Configuration specific to YAML.

`assist`^Optional

public readonly assist: AssistConfiguration;

Type: projen.javascript.biome_config.AssistConfiguration

The assist configuration.

`css`^Optional

public readonly css: CssConfiguration;

Type: projen.javascript.biome_config.CssConfiguration

Configuration specific to CSS.

`extends`^Optional

public readonly extends: any;

Type: any

Extends the current configuration with settings from one or more other Biome configurations.

Use "//" in a nested configuration to extend the root configuration at any nesting depth. Use an array to extend configurations by relative path or installed package specifier.

Biome merges configurations from left to right. Later configurations take precedence for single-value options, list entries are combined, and the current file is applied last.

`files`^Optional

public readonly files: FilesConfiguration;

Type: projen.javascript.biome_config.FilesConfiguration

Configures which files Biome can discover and process.

`formatter`^Optional

public readonly formatter: FormatterConfiguration;

Type: projen.javascript.biome_config.FormatterConfiguration

Configures formatting for selected files.

`graphql`^Optional

public readonly graphql: GraphqlConfiguration;

Type: projen.javascript.biome_config.GraphqlConfiguration

Configuration specific to GraphQL.

`grit`^Optional

public readonly grit: GritConfiguration;

Type: projen.javascript.biome_config.GritConfiguration

Configuration specific to GritQL.

`html`^Optional

public readonly html: HtmlConfiguration;

Type: projen.javascript.biome_config.HtmlConfiguration

Configuration specific to HTML.

`javascript`^Optional

public readonly javascript: JsConfiguration;

Type: projen.javascript.biome_config.JsConfiguration

Configuration specific to JavaScript.

`json`^Optional

public readonly json: JsonConfiguration;

Type: projen.javascript.biome_config.JsonConfiguration

Configuration specific to JSON.

`linter`^Optional

public readonly linter: LinterConfiguration;

Type: projen.javascript.biome_config.LinterConfiguration

The linter configuration.

`markdown`^Optional

public readonly markdown: MarkdownConfiguration;

Type: projen.javascript.biome_config.MarkdownConfiguration

Configuration specific to Markdown.

`overrides`^Optional

public readonly overrides: OverridePattern[];

Type: projen.javascript.biome_config.OverridePattern[]

Configures settings for files selected by each override.

When multiple overrides configure the same single-value setting, the last matching override takes precedence.

`plugins`^Optional

public readonly plugins: any[];

Type: any[]

A list of GritQL plugins to load.

`root`^Optional

public readonly root: boolean;

Type: boolean
Default: true. Biome implicitly treats rootasfalse` when a nested configuration uses

Marks whether this file is the root configuration for a Biome project.

The root configuration establishes the project's base settings, while false marks a configuration found inside the project as nested rather than a second project root.

Defaults to true. Biome implicitly treats root as false when a nested configuration uses "extends": "//". All other nested configurations must explicitly set root to false.

`schema`^Optional

public readonly schema: string;

Type: string

The JSON Schema used to validate the configuration and provide editor completion.

Biome emits a diagnostic when a biomejs.dev schema URL specifies a version that differs from the running CLI version.

`tailwind`^Optional

public readonly tailwind: TailwindConfiguration;

Type: projen.javascript.biome_config.TailwindConfiguration

Configures how Biome recognizes Tailwind class strings.

`vcs`^Optional

public readonly vcs: VcsConfiguration;

Type: projen.javascript.biome_config.VcsConfiguration

The version control integration configuration.

`yaml`^Optional

public readonly yaml: YamlConfiguration;

Type: projen.javascript.biome_config.YamlConfiguration

Configuration specific to YAML.

CssAssistConfiguration

Options that change how CSS assist behaves.

Initializer

import { javascript } from 'projen'

const cssAssistConfiguration: javascript.biome_config.CssAssistConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables assist actions for CSS.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables assist actions for CSS.

CssConfiguration

Options applied to CSS and languages that extend it.

Language-specific settings take precedence over corresponding global settings. Global settings apply when their language-specific counterparts are omitted, unless stated otherwise.

Initializer

import { javascript } from 'projen'

const cssConfiguration: javascript.biome_config.CssConfiguration = { ... }

Properties

Name	Type	Description
`assist`	`projen.javascript.biome_config.CssAssistConfiguration`	CSS assist options.
`formatter`	`projen.javascript.biome_config.CssFormatterConfiguration`	CSS formatter options.
`globals`	`string[]`	Reserved for future CSS analyzer support.
`linter`	`projen.javascript.biome_config.CssLinterConfiguration`	CSS linter options.
`parser`	`projen.javascript.biome_config.CssParserConfiguration`	CSS parsing options.

`assist`^Optional

public readonly assist: CssAssistConfiguration;

Type: projen.javascript.biome_config.CssAssistConfiguration

CSS assist options.

`formatter`^Optional

public readonly formatter: CssFormatterConfiguration;

Type: projen.javascript.biome_config.CssFormatterConfiguration

CSS formatter options.

`globals`^Optional

public readonly globals: string[];

Type: string[]

Reserved for future CSS analyzer support.

This option currently has no effect.

`linter`^Optional

public readonly linter: CssLinterConfiguration;

Type: projen.javascript.biome_config.CssLinterConfiguration

CSS linter options.

`parser`^Optional

public readonly parser: CssParserConfiguration;

Type: projen.javascript.biome_config.CssParserConfiguration

CSS parsing options.

CssFormatterConfiguration

Options that change how the CSS formatter behaves.

Initializer

import { javascript } from 'projen'

const cssFormatterConfiguration: javascript.biome_config.CssFormatterConfiguration = { ... }

Properties

Name	Type	Description
`delimiterSpacing`	`boolean`	Controls spaces inside CSS parentheses and square brackets when their content fits on one line.
`enabled`	`boolean`	Enables or disables the formatter for CSS and languages that extend it.
`indentStyle`	`projen.javascript.biome_config.IndentStyle`	The indent style applied to CSS and languages that extend it.
`indentWidth`	`number`	The indentation width applied to CSS and languages that extend it.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	The line ending applied to CSS and languages that extend it.
`lineWidth`	`number`	The preferred maximum line width for CSS and languages that extend it.
`quoteStyle`	`projen.javascript.biome_config.QuoteStyle`	Selects the preferred quote style for CSS strings.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of the file.

`delimiterSpacing`^Optional

public readonly delimiterSpacing: boolean;

Type: boolean

Controls spaces inside CSS parentheses and square brackets when their content fits on one line.

When enabled, rgb(0, 0, 0) becomes rgb( 0, 0, 0 ) and [data-attr] becomes [ data-attr ]. Empty delimiters are unchanged.

If unset, inherits the global delimiter spacing setting.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the formatter for CSS and languages that extend it.

`indentStyle`^Optional

public readonly indentStyle: IndentStyle;

Type: projen.javascript.biome_config.IndentStyle

The indent style applied to CSS and languages that extend it.

If unset, inherits the global indentation style.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The indentation width applied to CSS and languages that extend it.

If unset, inherits the global indentation width.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding

The line ending applied to CSS and languages that extend it.

If unset, inherits the global line ending.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

The preferred maximum line width for CSS and languages that extend it.

If unset, inherits the global line width.

`quoteStyle`^Optional

public readonly quoteStyle: QuoteStyle;

Type: projen.javascript.biome_config.QuoteStyle
Default: double`.

Selects the preferred quote style for CSS strings.

Biome may use the alternate quote when that avoids additional escaping. Quotes in @charset rules are currently preserved. Defaults to double.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean

Whether to add a trailing newline at the end of the file.

If unset, inherits the global trailing newline setting.

CssLinterConfiguration

Options that change how the CSS linter behaves.

Initializer

import { javascript } from 'projen'

const cssLinterConfiguration: javascript.biome_config.CssLinterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables the linter for CSS.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the linter for CSS.

CssParserConfiguration

Options that change how the CSS parser behaves.

Initializer

import { javascript } from 'projen'

const cssParserConfiguration: javascript.biome_config.CssParserConfiguration = { ... }

Properties

Name	Type	Description
`allowWrongLineComments`	`boolean`	Enables `//` line comments in plain CSS.
`cssModules`	`boolean`	Enables CSS Modules-specific syntax such as `:local`, `:global`, `composes`, and `@value`.
`tailwindDirectives`	`boolean`	Enables parsing Tailwind CSS 4.0 directives and functions, including `@theme`, `@utility`, `@variant`, `@source`, and `@apply`. Defaults to `false`.

`allowWrongLineComments`^Optional

public readonly allowWrongLineComments: boolean;

Type: boolean
Default: false`.

Enables // line comments in plain CSS.

Standard CSS treats // as delimiter characters rather than as a comment, and SCSS accepts // comments independently of this option. Defaults to false.

`cssModules`^Optional

public readonly cssModules: boolean;

Type: boolean

Enables CSS Modules-specific syntax such as :local, :global, composes, and @value.

When unset, Biome enables this syntax automatically for files whose names end in .module.css or .module.scss; otherwise, it defaults to false`. Enable it explicitly when CSS Module files use another naming convention.

`tailwindDirectives`^Optional

public readonly tailwindDirectives: boolean;

Type: boolean
Default: false`.

Enables parsing Tailwind CSS 4.0 directives and functions, including @theme, @utility, @variant, @source, and @apply. Defaults to false.

FilesConfiguration

The file handling configuration.

Initializer

import { javascript } from 'projen'

const filesConfiguration: javascript.biome_config.FilesConfiguration = { ... }

Properties

Name	Type	Description
`experimentalScannerIgnores`	`string[]`	Deprecated: Please use force-ignore syntax in `files.includes` instead: https://biomejs.dev/reference/configuration/#filesincludes.
`ignoreUnknown`	`boolean`	Prevents Biome from emitting diagnostics for unrecognized file types.
`includes`	`string[]`	A list of glob patterns selecting which files and directories Biome can process.
`maxSize`	`number`	The maximum source-file size in bytes.

`experimentalScannerIgnores`^Optional

public readonly experimentalScannerIgnores: string[];

Type: string[]

Deprecated: Please use force-ignore syntax in files.includes instead: https://biomejs.dev/reference/configuration/#filesincludes.

File or directory names that the scanner ignores unconditionally while crawling. Each value matches a complete path component, not a glob. Ignored files are not added to the module graph, so types are not inferred from them.

`ignoreUnknown`^Optional

public readonly ignoreUnknown: boolean;

Type: boolean
Default: false`.

Prevents Biome from emitting diagnostics for unrecognized file types.

Defaults to false.

`includes`^Optional

public readonly includes: string[];

Type: string[]

A list of glob patterns selecting which files and directories Biome can process.

If omitted, this option does not further restrict the supported files Biome can process. An empty list selects no files. Biome ignores files under node_modules even when they match a pattern.

The scanner uses these patterns and, when enabled, VCS ignore files while discovering nested configuration and ignore files. When enabled rules use the project or types domains, it also indexes source files and project dependencies. It may still discover required metadata or index excluded source files needed for analysis. A pattern beginning with !! prevents the scanner from indexing matching paths. Patterns are evaluated in order, and a pattern beginning with ! excludes matches.

`maxSize`^Optional

public readonly maxSize: number;

Type: number
Default: 1 MiB`.

The maximum source-file size in bytes.

Biome skips larger files and emits a warning diagnostic. Defaults to 1 MiB.

FormatterConfiguration

Configures formatting for selected files.

Initializer

import { javascript } from 'projen'

const formatterConfiguration: javascript.biome_config.FormatterConfiguration = { ... }

Properties

Name	Type	Description
`attributePosition`	`projen.javascript.biome_config.AttributePosition`	The attribute position style in HTML-like languages.
`bracketSameLine`	`boolean`	Controls the placement of the closing bracket for multiline HTML and JSX opening tags.
`bracketSpacing`	`boolean`	Controls spaces inside braces in supported single-line structures.
`delimiterSpacing`	`boolean`	Controls spaces immediately inside supported delimiters when their content fits on one line.
`enabled`	`boolean`	Enables or disables the formatter.
`expand`	`projen.javascript.biome_config.Expand`	Controls whether arrays and objects are formatted on one line or multiple lines.
`formatWithErrors`	`boolean`	Allows formatting files that contain syntax errors when set to `true`.
`includes`	`string[]`	A list of glob patterns selecting files to format.
`indentStyle`	`projen.javascript.biome_config.IndentStyle`	Uses tabs or spaces for indentation.
`indentWidth`	`number`	Sets the indentation width.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	Selects the line ending.
`lineWidth`	`number`	Sets the preferred maximum line width used when deciding where to wrap code.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of the file.
`useEditorconfig`	`boolean`	Controls whether Biome loads formatter settings from an `.editorconfig` file. Biome reads `indent_style`, `indent_size`, `end_of_line`, and `insert_final_newline`. Settings in `biome.json` or `biome.jsonc` take precedence. Biome loads only one `.editorconfig`. Nested cascading configurations and the EditorConfig `root` property are not supported. Defaults to `false`.

`attributePosition`^Optional

public readonly attributePosition: AttributePosition;

Type: projen.javascript.biome_config.AttributePosition
Default: auto`.

The attribute position style in HTML-like languages.

Defaults to auto.

`bracketSameLine`^Optional

public readonly bracketSameLine: boolean;

Type: boolean
Default: false`.

Controls the placement of the closing bracket for multiline HTML and JSX opening tags.

Biome places the bracket at the end of the last attribute line when enabled and on its own line when disabled. This also affects self-closing HTML elements, but self-closing JSX elements are unaffected. Defaults to false.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean
Default: true`.

Controls spaces inside braces in supported single-line structures.

The affected structures vary by language. Defaults to true.

`delimiterSpacing`^Optional

public readonly delimiterSpacing: boolean;

Type: boolean
Default: false`.

Controls spaces immediately inside supported delimiters when their content fits on one line.

It doesn't add spaces before opening delimiters or inside empty delimiters.

The affected delimiters vary by language. Defaults to false.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: true`.

Enables or disables the formatter.

Defaults to true.

`expand`^Optional

public readonly expand: Expand;

Type: projen.javascript.biome_config.Expand
Default: auto`.

Controls whether arrays and objects are formatted on one line or multiple lines.

auto formats objects on multiple lines if the first property has a newline, and arrays on one line if they fit.

always formats arrays and objects on multiple lines.

never formats arrays and objects on one line if they fit.

Defaults to auto.

When formatting package.json, Biome uses always unless configured otherwise.

`formatWithErrors`^Optional

public readonly formatWithErrors: boolean;

Type: boolean
Default: false`.

Allows formatting files that contain syntax errors when set to true.

Defaults to false.

`includes`^Optional

public readonly includes: string[];

Type: string[]

A list of glob patterns selecting files to format.

If omitted, all files selected by files.includes remain eligible for formatting. An empty list selects no files. This option can only narrow the files selected by files.includes.

`indentStyle`^Optional

public readonly indentStyle: IndentStyle;

Type: projen.javascript.biome_config.IndentStyle
Default: tab`.

Uses tabs or spaces for indentation.

Defaults to tab.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number
Default: 2`.

Sets the indentation width.

With space indentation, this is the number of spaces emitted per indentation level. With tab indentation, Biome emits one tab per level and uses this value as the tab's display width when calculating line length. Accepted values are 0 through 24. Defaults to 2.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding
Default: lf`.

Selects the line ending.

auto uses the platform convention. Defaults to lf.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number
Default: 80`.

Sets the preferred maximum line width used when deciding where to wrap code.

Some content, such as long unbreakable strings, may still exceed this width. Accepted values are 1 through 320. Defaults to 80.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean
Default: true`. Disabling

Whether to add a trailing newline at the end of the file.

Defaults to true. Disabling this option can cause compatibility problems with other tools.

`useEditorconfig`^Optional

public readonly useEditorconfig: boolean;

Type: boolean
Default: false`.

Controls whether Biome loads formatter settings from an .editorconfig file. Biome reads indent_style, indent_size, end_of_line, and insert_final_newline. Settings in biome.json or biome.jsonc take precedence. Biome loads only one .editorconfig. Nested cascading configurations and the EditorConfig root property are not supported. Defaults to false.

GraphqlAssistConfiguration

Options that change how GraphQL assist behaves.

Initializer

import { javascript } from 'projen'

const graphqlAssistConfiguration: javascript.biome_config.GraphqlAssistConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables assist actions for GraphQL.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: false`.

Enables or disables assist actions for GraphQL.

Defaults to false.

GraphqlConfiguration

Options applied to GraphQL files.

Language-specific settings take precedence over corresponding global settings. Global settings apply when their language-specific counterparts are omitted, unless stated otherwise.

Initializer

import { javascript } from 'projen'

const graphqlConfiguration: javascript.biome_config.GraphqlConfiguration = { ... }

Properties

Name	Type	Description
`assist`	`projen.javascript.biome_config.GraphqlAssistConfiguration`	GraphQL assist options.
`formatter`	`projen.javascript.biome_config.GraphqlFormatterConfiguration`	GraphQL formatter options.
`linter`	`projen.javascript.biome_config.GraphqlLinterConfiguration`	GraphQL linter options.

`assist`^Optional

public readonly assist: GraphqlAssistConfiguration;

Type: projen.javascript.biome_config.GraphqlAssistConfiguration

GraphQL assist options.

`formatter`^Optional

public readonly formatter: GraphqlFormatterConfiguration;

Type: projen.javascript.biome_config.GraphqlFormatterConfiguration

GraphQL formatter options.

`linter`^Optional

public readonly linter: GraphqlLinterConfiguration;

Type: projen.javascript.biome_config.GraphqlLinterConfiguration

GraphQL linter options.

GraphqlFormatterConfiguration

Options that change how the GraphQL formatter behaves.

Initializer

import { javascript } from 'projen'

const graphqlFormatterConfiguration: javascript.biome_config.GraphqlFormatterConfiguration = { ... }

Properties

Name	Type	Description
`bracketSpacing`	`boolean`	Controls spaces inside the braces of single-line GraphQL object values.
`enabled`	`boolean`	Enables or disables the formatter for GraphQL.
`indentStyle`	`projen.javascript.biome_config.IndentStyle`	The indent style applied to GraphQL files.
`indentWidth`	`number`	The indentation width applied to GraphQL files.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	The line ending applied to GraphQL files.
`lineWidth`	`number`	The preferred maximum line width for GraphQL files.
`quoteStyle`	`projen.javascript.biome_config.QuoteStyle`	Reserved for future formatter support.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of the file.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean

Controls spaces inside the braces of single-line GraphQL object values.

Biome formats {name: "Biome"} when disabled and { name: "Biome" } when enabled. If unset, inherits the global bracket spacing setting.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the formatter for GraphQL.

`indentStyle`^Optional

public readonly indentStyle: IndentStyle;

Type: projen.javascript.biome_config.IndentStyle

The indent style applied to GraphQL files.

If unset, inherits the global indentation style.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The indentation width applied to GraphQL files.

If unset, inherits the global indentation width.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding

The line ending applied to GraphQL files.

If unset, inherits the global line ending.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

The preferred maximum line width for GraphQL files.

If unset, inherits the global line width.

`quoteStyle`^Optional

public readonly quoteStyle: QuoteStyle;

Type: projen.javascript.biome_config.QuoteStyle

Reserved for future formatter support.

The current formatter preserves standard double-quoted GraphQL strings and does not use this setting.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean

Whether to add a trailing newline at the end of the file.

If unset, inherits the global trailing newline setting.

GraphqlLinterConfiguration

Options that change how the GraphQL linter behaves.

Initializer

import { javascript } from 'projen'

const graphqlLinterConfiguration: javascript.biome_config.GraphqlLinterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables the linter for GraphQL.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the linter for GraphQL.

GritAssistConfiguration

Options that change how GritQL assist behaves.

Initializer

import { javascript } from 'projen'

const gritAssistConfiguration: javascript.biome_config.GritAssistConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables assist actions for GritQL.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables assist actions for GritQL.

GritConfiguration

Options applied to GritQL files.

Language-specific settings take precedence over corresponding global settings. Global settings apply when their language-specific counterparts are omitted, unless stated otherwise.

Initializer

import { javascript } from 'projen'

const gritConfiguration: javascript.biome_config.GritConfiguration = { ... }

Properties

Name	Type	Description
`assist`	`projen.javascript.biome_config.GritAssistConfiguration`	GritQL assist options.
`formatter`	`projen.javascript.biome_config.GritFormatterConfiguration`	GritQL formatter options.
`linter`	`projen.javascript.biome_config.GritLinterConfiguration`	GritQL linter options.

`assist`^Optional

public readonly assist: GritAssistConfiguration;

Type: projen.javascript.biome_config.GritAssistConfiguration

GritQL assist options.

`formatter`^Optional

public readonly formatter: GritFormatterConfiguration;

Type: projen.javascript.biome_config.GritFormatterConfiguration

GritQL formatter options.

`linter`^Optional

public readonly linter: GritLinterConfiguration;

Type: projen.javascript.biome_config.GritLinterConfiguration

GritQL linter options.

GritFormatterConfiguration

Options that change how the GritQL formatter behaves.

Initializer

import { javascript } from 'projen'

const gritFormatterConfiguration: javascript.biome_config.GritFormatterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables the formatter for GritQL.
`indentStyle`	`projen.javascript.biome_config.IndentStyle`	The indent style applied to GritQL files.
`indentWidth`	`number`	The indentation width applied to GritQL files.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	The line ending applied to GritQL files.
`lineWidth`	`number`	The preferred maximum line width for GritQL files.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of the file.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the formatter for GritQL.

`indentStyle`^Optional

public readonly indentStyle: IndentStyle;

Type: projen.javascript.biome_config.IndentStyle

The indent style applied to GritQL files.

If unset, inherits the global indentation style.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The indentation width applied to GritQL files.

If unset, inherits the global indentation width.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding

The line ending applied to GritQL files.

If unset, inherits the global line ending.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

The preferred maximum line width for GritQL files.

If unset, inherits the global line width.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean

Whether to add a trailing newline at the end of the file.

If unset, inherits the global trailing newline setting.

GritLinterConfiguration

Options that change how the GritQL linter behaves.

Initializer

import { javascript } from 'projen'

const gritLinterConfiguration: javascript.biome_config.GritLinterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables the linter for GritQL.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the linter for GritQL.

HtmlAssistConfiguration

Options that change how HTML assist behaves.

Initializer

import { javascript } from 'projen'

const htmlAssistConfiguration: javascript.biome_config.HtmlAssistConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables assist actions for HTML and languages that extend it.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables assist actions for HTML and languages that extend it.

HtmlConfiguration

Options applied to HTML and languages that extend it.

Full HTML support and the HTML formatter are experimental. Biome aims to minimize breaking changes, but bug fixes and new features may change formatting output or diagnostics.

Language-specific settings take precedence over corresponding global settings. Global settings apply when their language-specific counterparts are omitted, unless stated otherwise.

Initializer

import { javascript } from 'projen'

const htmlConfiguration: javascript.biome_config.HtmlConfiguration = { ... }

Properties

Name	Type	Description
`assist`	`projen.javascript.biome_config.HtmlAssistConfiguration`	HTML assist options.
`experimentalFullSupportEnabled`	`boolean`	Enables Biome's experimental full support for `.html`, `.vue`, `.svelte`, and `.astro` files. In this mode, Biome parses the complete document and can analyze or format its markup and supported embedded languages.
`formatter`	`projen.javascript.biome_config.HtmlFormatterConfiguration`	HTML formatter options.
`linter`	`projen.javascript.biome_config.HtmlLinterConfiguration`	HTML linter options.
`parser`	`projen.javascript.biome_config.HtmlParserConfiguration`	HTML parsing options.

`assist`^Optional

public readonly assist: HtmlAssistConfiguration;

Type: projen.javascript.biome_config.HtmlAssistConfiguration

HTML assist options.

`experimentalFullSupportEnabled`^Optional

public readonly experimentalFullSupportEnabled: boolean;

Type: boolean
Default: false`.

Enables Biome's experimental full support for .html, .vue, .svelte, and .astro files. In this mode, Biome parses the complete document and can analyze or format its markup and supported embedded languages.

When disabled, .vue, .svelte, and .astro files use legacy handling, which extracts their JavaScript or TypeScript portions and leaves the rest unchanged. This option selects how these files are processed. It does not enable the HTML formatter. Set html.formatter.enabled to true to format complete HTML, Vue, Svelte, and Astro files. Defaults to false.

`formatter`^Optional

public readonly formatter: HtmlFormatterConfiguration;

Type: projen.javascript.biome_config.HtmlFormatterConfiguration

HTML formatter options.

`linter`^Optional

public readonly linter: HtmlLinterConfiguration;

Type: projen.javascript.biome_config.HtmlLinterConfiguration

HTML linter options.

`parser`^Optional

public readonly parser: HtmlParserConfiguration;

Type: projen.javascript.biome_config.HtmlParserConfiguration

HTML parsing options.

HtmlFormatterConfiguration

Options that change how the HTML formatter behaves.

Initializer

import { javascript } from 'projen'

const htmlFormatterConfiguration: javascript.biome_config.HtmlFormatterConfiguration = { ... }

Properties

Name	Type	Description
`attributePosition`	`projen.javascript.biome_config.AttributePosition`	The attribute position style in HTML elements.
`bracketSameLine`	`boolean`	Controls the placement of the closing bracket for multiline HTML opening tags.
`enabled`	`boolean`	Enables or disables the formatter for HTML and languages that extend it.
`indentScriptAndStyle`	`boolean`	Controls whether the content of `<script>` and `<style>` tags is indented by one level in HTML, Vue, Svelte, and Astro files.
`indentStyle`	`projen.javascript.biome_config.IndentStyle`	The indent style applied to HTML and languages that extend it.
`indentWidth`	`number`	The indentation width applied to HTML and languages that extend it.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	The line ending applied to HTML and languages that extend it.
`lineWidth`	`number`	The preferred maximum line width for HTML and languages that extend it.
`selfCloseVoidElements`	`projen.javascript.biome_config.SelfCloseVoidElements`	Controls whether void elements are self-closed.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of the file.
`whitespaceSensitivity`	`projen.javascript.biome_config.WhitespaceSensitivity`	Controls how the formatter treats whitespace around text and child elements in HTML, Vue, Svelte, and Astro markup.

`attributePosition`^Optional

public readonly attributePosition: AttributePosition;

Type: projen.javascript.biome_config.AttributePosition

The attribute position style in HTML elements.

If unset, inherits the global attribute position setting.

`bracketSameLine`^Optional

public readonly bracketSameLine: boolean;

Type: boolean

Controls the placement of the closing bracket for multiline HTML opening tags.

Biome places the bracket at the end of the last attribute line when enabled and on its own line after the last attribute when disabled. This option also affects self-closing HTML elements. If unset, inherits the global bracketSameLine setting.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the formatter for HTML and languages that extend it.

The formatter is experimental and disabled by default. Formatting complete HTML, Vue, Svelte, and Astro files requires html.experimentalFullSupportEnabled to be true.

`indentScriptAndStyle`^Optional

public readonly indentScriptAndStyle: boolean;

Type: boolean
Default: false`.

Controls whether the content of <script> and <style> tags is indented by one level in HTML, Vue, Svelte, and Astro files.

Defaults to false.

`indentStyle`^Optional

public readonly indentStyle: IndentStyle;

Type: projen.javascript.biome_config.IndentStyle

The indent style applied to HTML and languages that extend it.

If unset, inherits the global indentation style.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The indentation width applied to HTML and languages that extend it.

If unset, inherits the global indentation width.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding

The line ending applied to HTML and languages that extend it.

If unset, inherits the global line ending.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

The preferred maximum line width for HTML and languages that extend it.

If unset, inherits the global line width.

`selfCloseVoidElements`^Optional

public readonly selfCloseVoidElements: SelfCloseVoidElements;

Type: projen.javascript.biome_config.SelfCloseVoidElements
Default: never`.

Controls whether void elements are self-closed.

Defaults to never.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean

Whether to add a trailing newline at the end of the file.

Unlike other language-specific trailing newline settings, this option defaults to true instead of inheriting the global setting.

`whitespaceSensitivity`^Optional

public readonly whitespaceSensitivity: WhitespaceSensitivity;

Type: projen.javascript.biome_config.WhitespaceSensitivity
Default: css`.

Controls how the formatter treats whitespace around text and child elements in HTML, Vue, Svelte, and Astro markup.

The ignore setting should be used only when whitespace cannot affect rendered output. Defaults to css.

HtmlLinterConfiguration

Options that change how the HTML linter behaves.

Initializer

import { javascript } from 'projen'

const htmlLinterConfiguration: javascript.biome_config.HtmlLinterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables the linter for HTML and languages that extend it.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the linter for HTML and languages that extend it.

HtmlParserConfiguration

Options that change how the HTML parser behaves.

Initializer

import { javascript } from 'projen'

const htmlParserConfiguration: javascript.biome_config.HtmlParserConfiguration = { ... }

Properties

Name	Type	Description
`interpolation`	`boolean`	Enables double-curly interpolation expressions such as `{{ expression }}` in `.html` files. Defaults to `false`.
`vue`	`boolean`	Enables parsing Vue syntax (`v-if`, `v-bind`, etc.) in `.html` files. Enabling this option also enables `interpolation` implicitly.

`interpolation`^Optional

public readonly interpolation: boolean;

Type: boolean
Default: false`.

Enables double-curly interpolation expressions such as {{ expression }} in .html files. Defaults to false.

`vue`^Optional

public readonly vue: boolean;

Type: boolean
Default: false`.

Enables parsing Vue syntax (v-if, v-bind, etc.) in .html files. Enabling this option also enables interpolation implicitly.

Biome will already automatically enable Vue parsing in .vue files, so you probably don't need to enable this option. This only affects .html files, and does not change how .vue, .svelte, or .astro files are parsed. Defaults to false.

JsAssistConfiguration

Assist options specific to the JavaScript assist.

Initializer

import { javascript } from 'projen'

const jsAssistConfiguration: javascript.biome_config.JsAssistConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables assist actions for JavaScript and languages that extend it.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables assist actions for JavaScript and languages that extend it.

JsConfiguration

Options applied to JavaScript, TypeScript, JSX, TSX, and supported languages that embed JavaScript.

Language-specific settings take precedence over corresponding global settings. Global settings apply when their language-specific counterparts are omitted, unless stated otherwise.

Initializer

import { javascript } from 'projen'

const jsConfiguration: javascript.biome_config.JsConfiguration = { ... }

Properties

Name	Type	Description
`assist`	`projen.javascript.biome_config.JsAssistConfiguration`	JavaScript assist options.
`experimentalEmbeddedSnippetsEnabled`	`boolean`	Enables experimental parsing, formatting, linting, diagnostics, and fixes for CSS and GraphQL snippets embedded in JavaScript and TypeScript template literals.
`formatter`	`projen.javascript.biome_config.JsFormatterConfiguration`	JavaScript formatter options.
`globals`	`string[]`	A list of additional names that Biome's JavaScript linter treats as predefined global bindings.
`jsxRuntime`	`projen.javascript.biome_config.JsxRuntime`	Configures how the analyzer accounts for imports used by JSX.
`linter`	`projen.javascript.biome_config.JsLinterConfiguration`	JavaScript linter options.
`parser`	`projen.javascript.biome_config.JsParserConfiguration`	JavaScript parser options.
`resolver`	`projen.javascript.biome_config.JsResolverConfiguration`	JavaScript module and dependency resolver options.

`assist`^Optional

public readonly assist: JsAssistConfiguration;

Type: projen.javascript.biome_config.JsAssistConfiguration

JavaScript assist options.

`experimentalEmbeddedSnippetsEnabled`^Optional

public readonly experimentalEmbeddedSnippetsEnabled: boolean;

Type: boolean
Default: false`.

Enables experimental parsing, formatting, linting, diagnostics, and fixes for CSS and GraphQL snippets embedded in JavaScript and TypeScript template literals.

Biome recognizes CSS in css and styled templates and GraphQL in gql and graphql templates or calls. Templates containing interpolations are not currently supported. Defaults to false.

`formatter`^Optional

public readonly formatter: JsFormatterConfiguration;

Type: projen.javascript.biome_config.JsFormatterConfiguration

JavaScript formatter options.

`globals`^Optional

public readonly globals: string[];

Type: string[]

A list of additional names that Biome's JavaScript linter treats as predefined global bindings.

Use this for globals supplied by a runtime, framework, or external script that are not declared in the source file.

`jsxRuntime`^Optional

public readonly jsxRuntime: JsxRuntime;

Type: projen.javascript.biome_config.JsxRuntime
Default: transparent`.

Configures how the analyzer accounts for imports used by JSX.

This option does not transform JSX or select a runtime for a build tool. Defaults to transparent.

`linter`^Optional

public readonly linter: JsLinterConfiguration;

Type: projen.javascript.biome_config.JsLinterConfiguration

JavaScript linter options.

`parser`^Optional

public readonly parser: JsParserConfiguration;

Type: projen.javascript.biome_config.JsParserConfiguration

JavaScript parser options.

`resolver`^Optional

public readonly resolver: JsResolverConfiguration;

Type: projen.javascript.biome_config.JsResolverConfiguration

JavaScript module and dependency resolver options.

JsFormatterConfiguration

Formatting options specific to JavaScript and languages that extend it.

Initializer

import { javascript } from 'projen'

const jsFormatterConfiguration: javascript.biome_config.JsFormatterConfiguration = { ... }

Properties

Name	Type	Description
`arrowParentheses`	`projen.javascript.biome_config.ArrowParentheses`	Controls parentheses around arrow-function parameters.
`attributePosition`	`projen.javascript.biome_config.AttributePosition`	The attribute position style in JSX elements.
`bracketSameLine`	`boolean`	Controls the placement of the closing bracket for multiline JSX opening tags.
`bracketSpacing`	`boolean`	Controls spaces inside the braces of single-line object literals.
`delimiterSpacing`	`boolean`	Controls spaces immediately inside supported JavaScript and TypeScript delimiters when their content fits on one line.
`enabled`	`boolean`	Enables or disables the formatter for JavaScript and languages that extend it.
`expand`	`projen.javascript.biome_config.Expand`	Uses the same `auto`, `always`, and `never` behavior as the global expansion setting.
`indentStyle`	`projen.javascript.biome_config.IndentStyle`	The indent style applied to JavaScript and languages that extend it.
`indentWidth`	`number`	The indentation width applied to JavaScript and languages that extend it.
`jsxQuoteStyle`	`projen.javascript.biome_config.QuoteStyle`	Selects the preferred quote style for JSX attribute values.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	The line ending applied to JavaScript and languages that extend it.
`lineWidth`	`number`	The preferred maximum line width applied to JavaScript and languages that extend it.
`operatorLinebreak`	`projen.javascript.biome_config.OperatorLinebreak`	When breaking binary expressions into multiple lines, whether to break them before or after the binary operator.
`quoteProperties`	`projen.javascript.biome_config.QuoteProperties`	Controls whether quotes around object property names are preserved.
`quoteStyle`	`projen.javascript.biome_config.QuoteStyle`	Selects the preferred quote style for JavaScript and TypeScript string literals.
`semicolons`	`projen.javascript.biome_config.Semicolons`	Prints semicolons after every statement or only where needed to avoid automatic semicolon insertion hazards.
`trailingCommas`	`projen.javascript.biome_config.JsTrailingCommas`	Controls trailing commas in multiline comma-separated structures.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of the file.

`arrowParentheses`^Optional

public readonly arrowParentheses: ArrowParentheses;

Type: projen.javascript.biome_config.ArrowParentheses
Default: always`.

Controls parentheses around arrow-function parameters.

always always prints parentheses, while asNeeded omits them when an arrow function has one parameter and the syntax permits it. Defaults to always.

`attributePosition`^Optional

public readonly attributePosition: AttributePosition;

Type: projen.javascript.biome_config.AttributePosition

The attribute position style in JSX elements.

If unset, inherits the global attribute position setting.

`bracketSameLine`^Optional

public readonly bracketSameLine: boolean;

Type: boolean

Controls the placement of the closing bracket for multiline JSX opening tags.

Biome places the bracket at the end of the last attribute line when enabled and on its own line after the last attribute when disabled. Self-closing JSX elements are unaffected. If unset, inherits the global bracket placement setting.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean

Controls spaces inside the braces of single-line object literals.

Biome formats {value: 1} when disabled and { value: 1 } when enabled. If unset, inherits the global bracket spacing setting.

`delimiterSpacing`^Optional

public readonly delimiterSpacing: boolean;

Type: boolean

Controls spaces immediately inside supported JavaScript and TypeScript delimiters when their content fits on one line.

This affects parentheses, square brackets, template interpolations, TypeScript angle brackets, and JSX expression braces. Empty delimiters are unchanged.

It also controls spacing after logical NOT operators. In a chain of logical NOT operators, only the final operator receives a following space. Biome doesn't add spaces before opening delimiters.

If unset, inherits the global delimiter spacing setting.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the formatter for JavaScript and languages that extend it.

`expand`^Optional

public readonly expand: Expand;

Type: projen.javascript.biome_config.Expand

Uses the same auto, always, and never behavior as the global expansion setting.

If unset, inherits the global expansion setting.

`indentStyle`^Optional

public readonly indentStyle: IndentStyle;

Type: projen.javascript.biome_config.IndentStyle

The indent style applied to JavaScript and languages that extend it.

If unset, inherits the global indentation style.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The indentation width applied to JavaScript and languages that extend it.

If unset, inherits the global indentation width.

`jsxQuoteStyle`^Optional

public readonly jsxQuoteStyle: QuoteStyle;

Type: projen.javascript.biome_config.QuoteStyle
Default: double`.

Selects the preferred quote style for JSX attribute values.

Defaults to double.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding

The line ending applied to JavaScript and languages that extend it.

If unset, inherits the global line ending.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

The preferred maximum line width applied to JavaScript and languages that extend it.

If unset, inherits the global line width.

`operatorLinebreak`^Optional

public readonly operatorLinebreak: OperatorLinebreak;

Type: projen.javascript.biome_config.OperatorLinebreak
Default: after`.

When breaking binary expressions into multiple lines, whether to break them before or after the binary operator.

Defaults to after.

`quoteProperties`^Optional

public readonly quoteProperties: QuoteProperties;

Type: projen.javascript.biome_config.QuoteProperties
Default: asNeeded` in configuration

Controls whether quotes around object property names are preserved.

asNeeded removes quotes when the property name is valid without them, while preserve keeps quotes around property names that were quoted in the input. Defaults to asNeeded in configuration (as-needed on the CLI).

`quoteStyle`^Optional

public readonly quoteStyle: QuoteStyle;

Type: projen.javascript.biome_config.QuoteStyle
Default: double`.

Selects the preferred quote style for JavaScript and TypeScript string literals.

Biome may use the alternate quote when that avoids additional escaping. Defaults to double.

`semicolons`^Optional

public readonly semicolons: Semicolons;

Type: projen.javascript.biome_config.Semicolons
Default: always`.

Prints semicolons after every statement or only where needed to avoid automatic semicolon insertion hazards.

Defaults to always.

`trailingCommas`^Optional

public readonly trailingCommas: JsTrailingCommas;

Type: projen.javascript.biome_config.JsTrailingCommas
Default: all`.

Controls trailing commas in multiline comma-separated structures.

all adds trailing commas wherever syntax permits, including function parameters and calls. es5 adds them only in constructs supported by ES5, such as array and object literals, and excludes function parameters, function calls, and TypeScript type parameters. none removes trailing commas. Defaults to all.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean

Whether to add a trailing newline at the end of the file.

If unset, inherits the global trailing newline setting.

JsLinterConfiguration

Linter options specific to the JavaScript linter.

Initializer

import { javascript } from 'projen'

const jsLinterConfiguration: javascript.biome_config.JsLinterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables the linter for JavaScript and languages that extend it.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the linter for JavaScript and languages that extend it.

JsonAssistConfiguration

Assist options specific to the JSON linter.

Initializer

import { javascript } from 'projen'

const jsonAssistConfiguration: javascript.biome_config.JsonAssistConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables assist actions for JSON and languages that extend it.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables assist actions for JSON and languages that extend it.

JsonConfiguration

Options applied to JSON, JSONC, and recognized JSON-based configuration files.

Language-specific settings take precedence over corresponding global settings. Global settings apply when their language-specific counterparts are omitted, unless stated otherwise.

Initializer

import { javascript } from 'projen'

const jsonConfiguration: javascript.biome_config.JsonConfiguration = { ... }

Properties

Name	Type	Description
`assist`	`projen.javascript.biome_config.JsonAssistConfiguration`	Assist options.
`formatter`	`projen.javascript.biome_config.JsonFormatterConfiguration`	Formatting options.
`linter`	`projen.javascript.biome_config.JsonLinterConfiguration`	Linting options.
`parser`	`projen.javascript.biome_config.JsonParserConfiguration`	Parsing options.

`assist`^Optional

public readonly assist: JsonAssistConfiguration;

Type: projen.javascript.biome_config.JsonAssistConfiguration

Assist options.

`formatter`^Optional

public readonly formatter: JsonFormatterConfiguration;

Type: projen.javascript.biome_config.JsonFormatterConfiguration

Formatting options.

`linter`^Optional

public readonly linter: JsonLinterConfiguration;

Type: projen.javascript.biome_config.JsonLinterConfiguration

Linting options.

`parser`^Optional

public readonly parser: JsonParserConfiguration;

Type: projen.javascript.biome_config.JsonParserConfiguration

Parsing options.

JsonFormatterConfiguration

Initializer

import { javascript } from 'projen'

const jsonFormatterConfiguration: javascript.biome_config.JsonFormatterConfiguration = { ... }

Properties

Name	Type	Description
`bracketSpacing`	`boolean`	Whether to insert spaces inside braces in object literals.
`delimiterSpacing`	`boolean`	Controls spaces inside JSON square brackets when their content fits on one line.
`enabled`	`boolean`	Enables or disables the formatter for JSON and languages that extend it.
`expand`	`projen.javascript.biome_config.Expand`	Uses the same `auto`, `always`, and `never` behavior as the global expansion setting.
`indentStyle`	`projen.javascript.biome_config.IndentStyle`	The indent style applied to JSON and languages that extend it.
`indentWidth`	`number`	The indentation width applied to JSON and languages that extend it.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	The line ending applied to JSON and languages that extend it.
`lineWidth`	`number`	The preferred maximum line width applied to JSON and languages that extend it.
`trailingCommas`	`projen.javascript.biome_config.JsonTrailingCommas`	Controls trailing commas in multiline JSON arrays and objects.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of the file.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean

Whether to insert spaces inside braces in object literals.

If unset, inherits the global bracket spacing setting.

`delimiterSpacing`^Optional

public readonly delimiterSpacing: boolean;

Type: boolean

Controls spaces inside JSON square brackets when their content fits on one line.

When enabled, [1, 2, 3] becomes [ 1, 2, 3 ]. Empty brackets are unchanged.

If unset, inherits the global delimiter spacing setting.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the formatter for JSON and languages that extend it.

`expand`^Optional

public readonly expand: Expand;

Type: projen.javascript.biome_config.Expand

Uses the same auto, always, and never behavior as the global expansion setting.

If unset, inherits the global expansion setting.

When formatting package.json, Biome uses always unless configured otherwise.

`indentStyle`^Optional

public readonly indentStyle: IndentStyle;

Type: projen.javascript.biome_config.IndentStyle

The indent style applied to JSON and languages that extend it.

If unset, inherits the global indentation style.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The indentation width applied to JSON and languages that extend it.

If unset, inherits the global indentation width.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding

The line ending applied to JSON and languages that extend it.

If unset, inherits the global line ending.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

The preferred maximum line width applied to JSON and languages that extend it.

If unset, inherits the global line width.

`trailingCommas`^Optional

public readonly trailingCommas: JsonTrailingCommas;

Type: projen.javascript.biome_config.JsonTrailingCommas
Default: none`.

Controls trailing commas in multiline JSON arrays and objects.

none removes trailing commas, while all adds them wherever the JSON formatter supports them. Use all only for JSON variants that allow trailing commas, and ensure json.parser.allowTrailingCommas is enabled or automatically detected for those files. Defaults to none.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean

Whether to add a trailing newline at the end of the file.

If unset, inherits the global trailing newline setting.

JsonLinterConfiguration

Linter options specific to the JSON linter.

Initializer

import { javascript } from 'projen'

const jsonLinterConfiguration: javascript.biome_config.JsonLinterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Enables or disables the linter for JSON and languages that extend it.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the linter for JSON and languages that extend it.

JsonParserConfiguration

Options that change how the JSON parser behaves.

Initializer

import { javascript } from 'projen'

const jsonParserConfiguration: javascript.biome_config.JsonParserConfiguration = { ... }

Properties

Name	Type	Description
`allowComments`	`boolean`	Controls whether comments are allowed in files parsed as JSON.
`allowTrailingCommas`	`boolean`	Controls whether trailing commas are allowed in files parsed as JSON.

`allowComments`^Optional

public readonly allowComments: boolean;

Type: boolean

Controls whether comments are allowed in files parsed as JSON.

When unset, Biome follows the file type's default behavior. An explicit value overrides that behavior, except that biome.jsonc always allows comments.

`allowTrailingCommas`^Optional

public readonly allowTrailingCommas: boolean;

Type: boolean

Controls whether trailing commas are allowed in files parsed as JSON.

When unset, Biome follows the file type's default behavior. An explicit value overrides that behavior, except that biome.jsonc always allows trailing commas.

JsParserConfiguration

Options that change how the JavaScript parser behaves.

Initializer

import { javascript } from 'projen'

const jsParserConfiguration: javascript.biome_config.JsParserConfiguration = { ... }

Properties

Name	Type	Description
`jsxEverywhere`	`boolean`	Controls whether `.js`, `.mjs`, and `.cjs` files may contain JSX syntax. Disabling this option causes JSX in those files to raise a diagnostic. Defaults to `true`.
`unsafeParameterDecoratorsEnabled`	`boolean`	Enables parsing decorators on class parameters.

`jsxEverywhere`^Optional

public readonly jsxEverywhere: boolean;

Type: boolean
Default: true`.

Controls whether .js, .mjs, and .cjs files may contain JSX syntax. Disabling this option causes JSX in those files to raise a diagnostic. Defaults to true.

`unsafeParameterDecoratorsEnabled`^Optional

public readonly unsafeParameterDecoratorsEnabled: boolean;

Type: boolean
Default: false`.

Enables parsing decorators on class parameters.

This syntax belongs to an old experimental proposal and may change. Defaults to false.

JsResolverConfiguration

Resolver options specific to JavaScript files.

Initializer

import { javascript } from 'projen'

const jsResolverConfiguration: javascript.biome_config.JsResolverConfiguration = { ... }

Properties

Name	Type	Description
`experimentalPnpmCatalogs`	`boolean`	Enables pnpm workspace catalog resolution for JavaScript package manifests.

`experimentalPnpmCatalogs`^Optional

public readonly experimentalPnpmCatalogs: boolean;

Type: boolean
Default: false`.

Enables pnpm workspace catalog resolution for JavaScript package manifests.

Opt-in:

Set javascript.resolver.experimentalPnpmCatalogs to true.

Scope:

Resolves catalog: and catalog:<name> dependency versions from package.json.
Applies to dependencies, devDependencies, and peerDependencies.

Fail-safe behavior:

If pnpm-workspace.yaml is missing, unreadable, or cannot be parsed, Biome silently falls back to the default behavior (as if this option were disabled).
Unknown keys and unsupported value shapes in pnpm-workspace.yaml are ignored.

Limitations:

Only pnpm-workspace.yaml is read.
Biome only reads top-level catalog / catalogs mappings and scalar string entries.

Defaults to false.

LinterConfiguration

Initializer

import { javascript } from 'projen'

const linterConfiguration: javascript.biome_config.LinterConfiguration = { ... }

Properties

Name	Type	Description
`domains`	`projen.javascript.biome_config.RuleDomains`	Configures rules associated with a framework, library, project-wide analysis, or type analysis.
`enabled`	`boolean`	Enables or disables the linter.
`includes`	`string[]`	A list of glob patterns selecting files to lint.
`rules`	`projen.javascript.biome_config.Rules`	The lint-rule configuration.

`domains`^Optional

public readonly domains: RuleDomains;

Type: projen.javascript.biome_config.RuleDomains

Configures rules associated with a framework, library, project-wide analysis, or type analysis.

Keys are domain names and values are all, recommended, or none. Enabling rules from the project or types domains activates project and dependency scanning. The types domain also enables type-aware resolution.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: true`.

Enables or disables the linter.

Defaults to true.

`includes`^Optional

public readonly includes: string[];

Type: string[]

A list of glob patterns selecting files to lint.

If omitted, all files selected by files.includes remain eligible for linting. An empty list selects no files. This option can only narrow the files selected by files.includes.

`rules`^Optional

public readonly rules: Rules;

Type: projen.javascript.biome_config.Rules

The lint-rule configuration.

MarkdownConfiguration

Options applied to Markdown files.

Initializer

import { javascript } from 'projen'

const markdownConfiguration: javascript.biome_config.MarkdownConfiguration = { ... }

Properties

Name	Type	Description
`analyzeEmbeds`	`boolean`	Runs the linter and assist actions on the code inside fenced code blocks, frontmatter, and HTML blocks, with the rules and actions of the code's language.
`formatter`	`projen.javascript.biome_config.MarkdownFormatterConfiguration`	Formatter options.
`linter`	`projen.javascript.biome_config.MarkdownLinterConfiguration`	Linter options.
`parser`	`projen.javascript.biome_config.MarkdownParserConfiguration`	Parsing options.

`analyzeEmbeds`^Optional

public readonly analyzeEmbeds: boolean;

Type: boolean
Default: false`.

Runs the linter and assist actions on the code inside fenced code blocks, frontmatter, and HTML blocks, with the rules and actions of the code's language.

Defaults to false.

`formatter`^Optional

public readonly formatter: MarkdownFormatterConfiguration;

Type: projen.javascript.biome_config.MarkdownFormatterConfiguration

Formatter options.

`linter`^Optional

public readonly linter: MarkdownLinterConfiguration;

Type: projen.javascript.biome_config.MarkdownLinterConfiguration

Linter options.

`parser`^Optional

public readonly parser: MarkdownParserConfiguration;

Type: projen.javascript.biome_config.MarkdownParserConfiguration

Parsing options.

MarkdownFormatterConfiguration

Options that change how the Markdown formatter behaves.

Initializer

import { javascript } from 'projen'

const markdownFormatterConfiguration: javascript.biome_config.MarkdownFormatterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Control the formatter for Markdown (and its super languages) files.
`formatEmbeds`	`boolean`	Formats the code inside fenced code blocks, frontmatter, and HTML blocks with the formatter of the code's language.
`indentStyle`	`projen.javascript.biome_config.IndentStyle`	The indent style applied to Markdown files.
`indentWidth`	`number`	The size of the indentation applied to Markdown files.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	The type of line ending applied to Markdown (and its super languages) files.
`lineWidth`	`number`	What's the max width of a line applied to Markdown files.
`proseWrap`	`projen.javascript.biome_config.ProseWrap`	Controls whether Biome keeps, adds, or removes line breaks in Markdown paragraphs.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of the file.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the formatter for Markdown (and its super languages) files.

`formatEmbeds`^Optional

public readonly formatEmbeds: boolean;

Type: boolean
Default: true`.

Formats the code inside fenced code blocks, frontmatter, and HTML blocks with the formatter of the code's language.

Defaults to true.

A block with a syntax error stays as written, and Biome still formats the rest of the file.

When this option is false, Biome keeps every block as written.

`indentStyle`^Optional

public readonly indentStyle: IndentStyle;

Type: projen.javascript.biome_config.IndentStyle

The indent style applied to Markdown files.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number
Default: 2.

The size of the indentation applied to Markdown files.

Defaults to 2.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding

The type of line ending applied to Markdown (and its super languages) files.

auto uses CRLF on Windows and LF on other platforms.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number
Default: 80.

What's the max width of a line applied to Markdown files.

Defaults to 80.

`proseWrap`^Optional

public readonly proseWrap: ProseWrap;

Type: projen.javascript.biome_config.ProseWrap

Controls whether Biome keeps, adds, or removes line breaks in Markdown paragraphs.

Manual line breaks are always kept. In Markdown, a manual line break is created by ending a line with two spaces or a backslash.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean
Default: true.

Whether to add a trailing newline at the end of the file.

Setting this option to false is highly discouraged because it could cause many problems with other tools:

Disable the option at your own risk.

Defaults to true.

MarkdownLinterConfiguration

Options that change how the Markdown linter behaves.

Initializer

import { javascript } from 'projen'

const markdownLinterConfiguration: javascript.biome_config.MarkdownLinterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Control the linter for Markdown files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the linter for Markdown files.

MarkdownParserConfiguration

Options that change how the Markdown parser behaves.

Initializer

import { javascript } from 'projen'

const markdownParserConfiguration: javascript.biome_config.MarkdownParserConfiguration = { ... }

Properties

Name	Type	Description
`cjkFriendlyEmphasis`	`boolean`	Recognizes bold, italic, and strikethrough markers placed directly next to Chinese, Japanese, or Korean text. Defaults to `false`.
`frontmatter`	`boolean`	Enables parsing frontmatter at the start of the file.
`gfm`	`boolean`	Enables GitHub Flavored Markdown extensions.

`cjkFriendlyEmphasis`^Optional

public readonly cjkFriendlyEmphasis: boolean;

Type: boolean
Default: false`.

Recognizes bold, italic, and strikethrough markers placed directly next to Chinese, Japanese, or Korean text. Defaults to false.

Standard Markdown doesn't treat **テスト。**テスト as bold text, because the closing ** is between a punctuation mark and a letter with no space around it. Languages that don't put spaces between words run into this often. When enabled, Biome follows the CommonMark CJK-friendly amendments and treats such text as bold or italic. The option applies to *, _, and ~~ markers. After a variation selector (an invisible character that picks a glyph style for the character before it), Biome classifies a marker by the character before the selector.

The option can also change markers that aren't next to Chinese, Japanese, or Korean text, because a marker that can now open or close formatting can take another marker's partner in the same paragraph, heading, or table cell. For example, standard Markdown shows **テスト。**テスト a** with テスト a in bold. With the option enabled, テスト。 is bold and the last ** is shown as written.

The formatter and the linter both use this reading of the document. Enable the option only when the tool that renders your Markdown also supports these amendments. Otherwise, Biome treats as bold some text that your renderer shows with literal **, and formatting can change what your renderer shows. For example, the option makes __ after a variation selector a bold marker, and the formatter rewrites it as **, which standard Markdown shows as bold even where it showed the original __ as written.

`frontmatter`^Optional

public readonly frontmatter: boolean;

Type: boolean
Default: false`.

Enables parsing frontmatter at the start of the file.

Defaults to false.

`gfm`^Optional

public readonly gfm: boolean;

Type: boolean
Default: true`.

Enables GitHub Flavored Markdown extensions.

Defaults to true.

OverrideAssistConfiguration

Initializer

import { javascript } from 'projen'

const overrideAssistConfiguration: javascript.biome_config.OverrideAssistConfiguration = { ... }

Properties

Name	Type	Description
`actions`	`projen.javascript.biome_config.Actions`	The assist-action configuration for matched files.
`enabled`	`boolean`	Enables or disables assist actions for matched files.

`actions`^Optional

public readonly actions: Actions;

Type: projen.javascript.biome_config.Actions

The assist-action configuration for matched files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables assist actions for matched files.

OverrideFilesConfiguration

Initializer

import { javascript } from 'projen'

const overrideFilesConfiguration: javascript.biome_config.OverrideFilesConfiguration = { ... }

Properties

Name	Type	Description
`maxSize`	`number`	The maximum source-file size in bytes for matched files.

`maxSize`^Optional

public readonly maxSize: number;

Type: number

The maximum source-file size in bytes for matched files.

OverrideFormatterConfiguration

Initializer

import { javascript } from 'projen'

const overrideFormatterConfiguration: javascript.biome_config.OverrideFormatterConfiguration = { ... }

Properties

Name	Type	Description
`attributePosition`	`projen.javascript.biome_config.AttributePosition`	The attribute position style in HTML-like languages.
`bracketSameLine`	`boolean`	Controls the placement of the closing bracket for multiline HTML and JSX opening tags.
`bracketSpacing`	`boolean`	Controls spaces inside braces in supported single-line structures.
`delimiterSpacing`	`boolean`	Controls spaces immediately inside supported delimiters when their content fits on one line.
`enabled`	`boolean`	Enables or disables the formatter for matched files.
`expand`	`projen.javascript.biome_config.Expand`	Controls whether arrays and objects are formatted on one line or multiple lines.
`formatWithErrors`	`boolean`	Allows formatting matched files that contain syntax errors.
`indentSize`	`number`	The indentation width.
`indentStyle`	`projen.javascript.biome_config.IndentStyle`	Uses tabs or spaces for indentation.
`indentWidth`	`number`	Sets the indentation width.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	The line ending.
`lineWidth`	`number`	Sets the preferred maximum line width used when deciding where to wrap code.
`trailingCommas`	`projen.javascript.biome_config.JsTrailingCommas`	Prints trailing commas wherever possible in multiline comma-separated structures.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of matched files.

`attributePosition`^Optional

public readonly attributePosition: AttributePosition;

Type: projen.javascript.biome_config.AttributePosition

The attribute position style in HTML-like languages.

`bracketSameLine`^Optional

public readonly bracketSameLine: boolean;

Type: boolean

Controls the placement of the closing bracket for multiline HTML and JSX opening tags.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean

Controls spaces inside braces in supported single-line structures.

The affected structures vary by language.

`delimiterSpacing`^Optional

public readonly delimiterSpacing: boolean;

Type: boolean

Controls spaces immediately inside supported delimiters when their content fits on one line.

It doesn't add spaces before opening delimiters or inside empty delimiters.

The affected delimiters vary by language. If unset, uses the configured formatter setting.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the formatter for matched files.

`expand`^Optional

public readonly expand: Expand;

Type: projen.javascript.biome_config.Expand

Controls whether arrays and objects are formatted on one line or multiple lines.

auto formats objects on multiple lines if the first property has a newline, and arrays on one line if they fit.

always formats arrays and objects on multiple lines.

never formats arrays and objects on one line if they fit.

If unset, uses the configured formatter setting.

When formatting package.json, Biome uses always unless configured otherwise.

`formatWithErrors`^Optional

public readonly formatWithErrors: boolean;

Type: boolean

Allows formatting matched files that contain syntax errors.

`indentSize`^Optional

public readonly indentSize: number;

Type: number

The indentation width.

Deprecated, use indentWidth instead.

`indentStyle`^Optional

public readonly indentStyle: IndentStyle;

Type: projen.javascript.biome_config.IndentStyle

Uses tabs or spaces for indentation.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

Sets the indentation width.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding

The line ending.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

Sets the preferred maximum line width used when deciding where to wrap code.

Some content, such as long unbreakable strings, may still exceed this width. Accepted values are 1 through 320.

`trailingCommas`^Optional

public readonly trailingCommas: JsTrailingCommas;

Type: projen.javascript.biome_config.JsTrailingCommas

Prints trailing commas wherever possible in multiline comma-separated structures.

This is a legacy override option. Prefer javascript.formatter.trailingCommas.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean

Whether to add a trailing newline at the end of matched files.

Disabling this option can cause compatibility problems with other tools.

OverrideLinterConfiguration

Initializer

import { javascript } from 'projen'

const overrideLinterConfiguration: javascript.biome_config.OverrideLinterConfiguration = { ... }

Properties

Name	Type	Description
`domains`	`projen.javascript.biome_config.RuleDomains`	The lint-domain configuration for matched files.
`enabled`	`boolean`	Enables or disables the linter for matched files.
`rules`	`projen.javascript.biome_config.Rules`	The lint-rule configuration for matched files.

`domains`^Optional

public readonly domains: RuleDomains;

Type: projen.javascript.biome_config.RuleDomains

The lint-domain configuration for matched files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables or disables the linter for matched files.

`rules`^Optional

public readonly rules: Rules;

Type: projen.javascript.biome_config.Rules

The lint-rule configuration for matched files.

OverridePattern

Initializer

import { javascript } from 'projen'

const overridePattern: javascript.biome_config.OverridePattern = { ... }

Properties

Name	Type	Description
`assist`	`projen.javascript.biome_config.OverrideAssistConfiguration`	Assist settings for matched files.
`css`	`projen.javascript.biome_config.CssConfiguration`	CSS-specific settings for matched files.
`files`	`projen.javascript.biome_config.OverrideFilesConfiguration`	File-handling settings for matched files.
`formatter`	`projen.javascript.biome_config.OverrideFormatterConfiguration`	Formatter settings for matched files.
`graphql`	`projen.javascript.biome_config.GraphqlConfiguration`	GraphQL-specific settings for matched files.
`grit`	`projen.javascript.biome_config.GritConfiguration`	GritQL-specific settings for matched files.
`html`	`projen.javascript.biome_config.HtmlConfiguration`	HTML-specific settings for matched files.
`includes`	`string[]`	A list of glob patterns selecting the files to which this override applies.
`javascript`	`projen.javascript.biome_config.JsConfiguration`	JavaScript-specific settings for matched files.
`json`	`projen.javascript.biome_config.JsonConfiguration`	JSON-specific settings for matched files.
`linter`	`projen.javascript.biome_config.OverrideLinterConfiguration`	Linter settings for matched files.
`markdown`	`projen.javascript.biome_config.MarkdownConfiguration`	Specific configuration for the Markdown language.
`plugins`	`any[]`	Additional plugins for matched files.
`yaml`	`projen.javascript.biome_config.YamlConfiguration`	Specific configuration for the YAML language.

`assist`^Optional

public readonly assist: OverrideAssistConfiguration;

Type: projen.javascript.biome_config.OverrideAssistConfiguration

Assist settings for matched files.

`css`^Optional

public readonly css: CssConfiguration;

Type: projen.javascript.biome_config.CssConfiguration

CSS-specific settings for matched files.

`files`^Optional

public readonly files: OverrideFilesConfiguration;

Type: projen.javascript.biome_config.OverrideFilesConfiguration

File-handling settings for matched files.

`formatter`^Optional

public readonly formatter: OverrideFormatterConfiguration;

Type: projen.javascript.biome_config.OverrideFormatterConfiguration

Formatter settings for matched files.

`graphql`^Optional

public readonly graphql: GraphqlConfiguration;

Type: projen.javascript.biome_config.GraphqlConfiguration

GraphQL-specific settings for matched files.

`grit`^Optional

public readonly grit: GritConfiguration;

Type: projen.javascript.biome_config.GritConfiguration

GritQL-specific settings for matched files.

`html`^Optional

public readonly html: HtmlConfiguration;

Type: projen.javascript.biome_config.HtmlConfiguration

HTML-specific settings for matched files.

`includes`^Optional

public readonly includes: string[];

Type: string[]

A list of glob patterns selecting the files to which this override applies.

If omitted, the override applies to every file. An empty list applies to no files.

`javascript`^Optional

public readonly javascript: JsConfiguration;

Type: projen.javascript.biome_config.JsConfiguration

JavaScript-specific settings for matched files.

`json`^Optional

public readonly json: JsonConfiguration;

Type: projen.javascript.biome_config.JsonConfiguration

JSON-specific settings for matched files.

`linter`^Optional

public readonly linter: OverrideLinterConfiguration;

Type: projen.javascript.biome_config.OverrideLinterConfiguration

Linter settings for matched files.

`markdown`^Optional

public readonly markdown: MarkdownConfiguration;

Type: projen.javascript.biome_config.MarkdownConfiguration

Specific configuration for the Markdown language.

`plugins`^Optional

public readonly plugins: any[];

Type: any[]

Additional plugins for matched files.

`yaml`^Optional

public readonly yaml: YamlConfiguration;

Type: projen.javascript.biome_config.YamlConfiguration

Specific configuration for the YAML language.

RuleDomains

Initializer

import { javascript } from 'projen'

const ruleDomains: javascript.biome_config.RuleDomains = { ... }

Properties

Name	Type	Description
`astro`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`drizzle`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`next`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`playwright`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`project`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`qwik`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`react`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`reactNative`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`solid`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`svelte`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`tailwind`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`tanstackQuery`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`test`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`turborepo`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`types`	`projen.javascript.biome_config.RuleDomainValue`	No description.
`vue`	`projen.javascript.biome_config.RuleDomainValue`	No description.

`astro`^Optional

public readonly astro: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`drizzle`^Optional

public readonly drizzle: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`next`^Optional

public readonly next: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`playwright`^Optional

public readonly playwright: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`project`^Optional

public readonly project: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`qwik`^Optional

public readonly qwik: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`react`^Optional

public readonly react: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`reactNative`^Optional

public readonly reactNative: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`solid`^Optional

public readonly solid: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`svelte`^Optional

public readonly svelte: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`tailwind`^Optional

public readonly tailwind: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`tanstackQuery`^Optional

public readonly tanstackQuery: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`test`^Optional

public readonly test: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`turborepo`^Optional

public readonly turborepo: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`types`^Optional

public readonly types: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

`vue`^Optional

public readonly vue: RuleDomainValue;

Type: projen.javascript.biome_config.RuleDomainValue

Rules

Initializer

import { javascript } from 'projen'

const rules: javascript.biome_config.Rules = { ... }

Properties

Name	Type	Description
`a11Y`	`any`	No description.
`complexity`	`any`	No description.
`correctness`	`any`	No description.
`nursery`	`any`	No description.
`performance`	`any`	No description.
`preset`	`projen.javascript.biome_config.PresetConfig`	Selects the baseline set of lint rules.
`recommended`	`boolean`	Enables or disables Biome's recommended non-nursery rules. Defaults to `true`.
`security`	`any`	No description.
`style`	`any`	No description.
`suspicious`	`any`	No description.

`a11Y`^Optional

public readonly a11Y: any;

Type: any

`complexity`^Optional

public readonly complexity: any;

Type: any

`correctness`^Optional

public readonly correctness: any;

Type: any

`nursery`^Optional

public readonly nursery: any;

Type: any

`performance`^Optional

public readonly performance: any;

Type: any

`preset`^Optional

public readonly preset: PresetConfig;

Type: projen.javascript.biome_config.PresetConfig
Default: recommended`.

Selects the baseline set of lint rules.

recommended enables Biome's recommended non-nursery rules, all enables all non-nursery rules, and none starts with no rules enabled. Group-level settings and explicit rule settings override this preset. Defaults to recommended.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean
Default: true`.

Enables or disables Biome's recommended non-nursery rules. Defaults to true.

Deprecated: This option will be removed in the next major version. Use linter.rules.preset instead, or run biome migrate to update the configuration.

`security`^Optional

public readonly security: any;

Type: any

`style`^Optional

public readonly style: any;

Type: any

`suspicious`^Optional

public readonly suspicious: any;

Type: any

Source

Configures one group of assist actions.

Initializer

import { javascript } from 'projen'

const source: javascript.biome_config.Source = { ... }

Properties

Name	Type	Description
`noDuplicateClasses`	`any`	Remove repeated CSS class names from HTML class attributes.
`organizeImports`	`any`	Organize imports and exports in JavaScript and TypeScript files.
`preset`	`projen.javascript.biome_config.PresetConfig`	Selects the baseline set of assist actions for this group.
`recommended`	`boolean`	Enables or disables the recommended actions in this group.
`useGraphqlSortedArguments`	`any`	Sort the arguments of GraphQL fields and directives in natural order.
`useGraphqlSortedDefinitions`	`any`	Sort the named definitions in a GraphQL document.
`useGraphqlSortedVariables`	`any`	Sort the variable definitions of GraphQL operations in natural order.
`useSortedAttributes`	`any`	Sort HTML attributes and framework directives into a consistent order.
`useSortedEnumMembers`	`any`	Sort GraphQL enum values in natural order.
`useSortedInterfaceMembers`	`any`	Sort named members of a TypeScript interface.
`useSortedKeys`	`any`	Sort keys in a JSON object.
`useSortedPackageJson`	`any`	Organize package.json fields according to established conventions. See https://biomejs.dev/assist/actions/use-sorted-package-json.
`useSortedProperties`	`any`	Sort CSS properties and nested rules into a consistent order.
`useSortedSelectionSet`	`any`	Sort selections inside GraphQL operations and fragments.
`useSortedTypeFields`	`any`	Sort fields in GraphQL type definitions by name.

`noDuplicateClasses`^Optional

public readonly noDuplicateClasses: any;

Type: any

Remove repeated CSS class names from HTML class attributes.

See https://biomejs.dev/assist/actions/no-duplicate-classes

`organizeImports`^Optional

public readonly organizeImports: any;

Type: any

Organize imports and exports in JavaScript and TypeScript files.

See https://biomejs.dev/assist/actions/organize-imports

`preset`^Optional

public readonly preset: PresetConfig;

Type: projen.javascript.biome_config.PresetConfig

Selects the baseline set of assist actions for this group.

recommended enables the group's recommended actions, all enables all actions in the group, and none starts with no actions enabled in the group. Explicit action settings override this group preset, which overrides assist.actions.preset for the group.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

Enables or disables the recommended actions in this group.

The group's preset setting takes precedence when both options are set.

`useGraphqlSortedArguments`^Optional

public readonly useGraphqlSortedArguments: any;

Type: any

Sort the arguments of GraphQL fields and directives in natural order.

See https://biomejs.dev/assist/actions/use-graphql-sorted-arguments

`useGraphqlSortedDefinitions`^Optional

public readonly useGraphqlSortedDefinitions: any;

Type: any

Sort the named definitions in a GraphQL document.

See https://biomejs.dev/assist/actions/use-graphql-sorted-definitions

`useGraphqlSortedVariables`^Optional

public readonly useGraphqlSortedVariables: any;

Type: any

Sort the variable definitions of GraphQL operations in natural order.

See https://biomejs.dev/assist/actions/use-graphql-sorted-variables

`useSortedAttributes`^Optional

public readonly useSortedAttributes: any;

Type: any

Sort HTML attributes and framework directives into a consistent order.

See https://biomejs.dev/assist/actions/use-sorted-attributes

`useSortedEnumMembers`^Optional

public readonly useSortedEnumMembers: any;

Type: any

Sort GraphQL enum values in natural order.

See https://biomejs.dev/assist/actions/use-sorted-enum-members

`useSortedInterfaceMembers`^Optional

public readonly useSortedInterfaceMembers: any;

Type: any

Sort named members of a TypeScript interface.

See https://biomejs.dev/assist/actions/use-sorted-interface-members

`useSortedKeys`^Optional

public readonly useSortedKeys: any;

Type: any

Sort keys in a JSON object.

See https://biomejs.dev/assist/actions/use-sorted-keys

`useSortedPackageJson`^Optional

public readonly useSortedPackageJson: any;

Type: any

Organize package.json fields according to established conventions. See https://biomejs.dev/assist/actions/use-sorted-package-json.

`useSortedProperties`^Optional

public readonly useSortedProperties: any;

Type: any

Sort CSS properties and nested rules into a consistent order.

See https://biomejs.dev/assist/actions/use-sorted-properties

`useSortedSelectionSet`^Optional

public readonly useSortedSelectionSet: any;

Type: any

Sort selections inside GraphQL operations and fragments.

See https://biomejs.dev/assist/actions/use-sorted-selection-set

`useSortedTypeFields`^Optional

public readonly useSortedTypeFields: any;

Type: any

Sort fields in GraphQL type definitions by name.

See https://biomejs.dev/assist/actions/use-sorted-type-fields

TailwindConfiguration

Tells Biome where your code lists Tailwind CSS classes, so the Tailwind lint rules know which strings to check.

Initializer

import { javascript } from 'projen'

const tailwindConfiguration: javascript.biome_config.TailwindConfiguration = { ... }

Properties

Name	Type	Description
`attributes`	`string[]`	Attributes whose values are Tailwind classes, such as `class` in `<div class="px-2 py-2">`.
`mergeFunctions`	`string[]`	Functions that combine Tailwind classes, such as `clsx` and `cn`.
`stylesheet`	`string`	The CSS file that holds your Tailwind CSS configuration, such as `"./src/app.css"`. A relative path starts from the folder of the Biome configuration file.
`variantFunctions`	`string[]`	Functions that describe a component's styles with an object, such as `cva` and `tv`.

`attributes`^Optional

public readonly attributes: string[];

Type: string[]
Default: classandclassName`. In HTML, they are case-insensitive.

Attributes whose values are Tailwind classes, such as class in <div class="px-2 py-2">.

Defaults to class and className. In HTML, they are case-insensitive.

`mergeFunctions`^Optional

public readonly mergeFunctions: string[];

Type: string[]
Default: clsx, tw, twMerge, twJoin, cn, cc, cnb`, and

Functions that combine Tailwind classes, such as clsx and cn.

Biome checks every string passed to these functions, like both strings in cn("px-2", "py-2"). When an object is passed, Biome checks its keys: in cn({ "px-2": isActive }), it checks "px-2".

Properties of these functions are checked too, so listing tw also covers tw.div`px-2` and tw.div("px-2").

Defaults to clsx, tw, twMerge, twJoin, cn, cc, cnb, and ctl.

`stylesheet`^Optional

public readonly stylesheet: string;

Type: string

The CSS file that holds your Tailwind CSS configuration, such as "./src/app.css". A relative path starts from the folder of the Biome configuration file.

Biome reads the @theme, @utility, and @custom-variant rules in this file and in the files it imports with @import, so that the Tailwind rules know your theme values, utilities, and variants.

To read the file, Biome scans your project when a Tailwind rule is enabled. Setting this option also turns on css.parser.tailwindDirectives, unless you set that option yourself.

`variantFunctions`^Optional

public readonly variantFunctions: string[];

Type: string[]
Default: cvaandtv`.

Functions that describe a component's styles with an object, such as cva and tv.

Biome checks every string passed directly to these functions. In an object passed to them, Biome checks the classes under these properties:

base, class, and className: classes that always apply.
variants: classes for each version of the component, such as each button size.
slots: classes for each part of the component, such as its icon.
compoundVariants and compoundSlots: only the class and className of each entry.

Other properties, such as defaultVariants, hold names rather than classes, so Biome skips them. For example, Biome checks "rounded", "px-2", and "px-4" here, but not "small":

cva("rounded", {
variants: {
size: { small: "px-2", large: "px-4" },
},
defaultVariants: { size: "small" },
});

Defaults to cva and tv.

VcsConfiguration

Configures how Biome integrates with a version control system.

Initializer

import { javascript } from 'projen'

const vcsConfiguration: javascript.biome_config.VcsConfiguration = { ... }

Properties

Name	Type	Description
`clientKind`	`projen.javascript.biome_config.VcsClientKind`	Selects the version-control client.
`defaultBranch`	`string`	Sets the base branch used by `--changed` when `--since` is not provided.
`enabled`	`boolean`	Enables or disables version-control integration.
`root`	`string`	Sets the directory where Biome looks for version-control files.
`useIgnoreFile`	`boolean`	Controls whether Biome applies patterns from `.gitignore`, Git's local `.git/info/exclude`, and supported `.ignore` files, including nested ignore files. Patterns in the root ignore file are resolved from `vcs.root`. Patterns in nested ignore files are resolved from the directory containing that file. Defaults to `false`.

`clientKind`^Optional

public readonly clientKind: VcsClientKind;

Type: projen.javascript.biome_config.VcsClientKind

Selects the version-control client.

Currently, only git is supported.

`defaultBranch`^Optional

public readonly defaultBranch: string;

Type: string

Sets the base branch used by --changed when --since is not provided.

If neither this option nor --since is set, commands using --changed fail because Biome cannot determine the comparison base.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: false`. Enabling integration

Enables or disables version-control integration.

Defaults to false. Enabling integration requires vcs.clientKind to be set.

`root`^Optional

public readonly root: string;

Type: string
Default: the directory containing biome.json or biome.jsonc. If no configuration is

Sets the directory where Biome looks for version-control files.

A relative value is resolved from the directory containing the current configuration file, while an absolute path is used directly.

Defaults to the directory containing biome.json or biome.jsonc. If no configuration is found, Biome uses the current working directory.

If neither directory is available, Biome disables version control integration and emits a diagnostic.

`useIgnoreFile`^Optional

public readonly useIgnoreFile: boolean;

Type: boolean
Default: false`.

Controls whether Biome applies patterns from .gitignore, Git's local .git/info/exclude, and supported .ignore files, including nested ignore files. Patterns in the root ignore file are resolved from vcs.root. Patterns in nested ignore files are resolved from the directory containing that file. Defaults to false.

YamlConfiguration

Options applied to Yaml files.

Initializer

import { javascript } from 'projen'

const yamlConfiguration: javascript.biome_config.YamlConfiguration = { ... }

Properties

Name	Type	Description
`formatter`	`projen.javascript.biome_config.YamlFormatterConfiguration`	Formatter options.
`linter`	`projen.javascript.biome_config.YamlLinterConfiguration`	No description.

`formatter`^Optional

public readonly formatter: YamlFormatterConfiguration;

Type: projen.javascript.biome_config.YamlFormatterConfiguration

Formatter options.

`linter`^Optional

public readonly linter: YamlLinterConfiguration;

Type: projen.javascript.biome_config.YamlLinterConfiguration

YamlFormatterConfiguration

Options that change how the Yaml formatter behaves.

Initializer

import { javascript } from 'projen'

const yamlFormatterConfiguration: javascript.biome_config.YamlFormatterConfiguration = { ... }

Properties

Name	Type	Description
`bracketSpacing`	`boolean`	Whether to insert spaces inside non-empty flow mappings (`{ key: value }`) and sequences (`[ item ]`) that fit on one line.
`enabled`	`boolean`	Control the formatter for Yaml (and its super languages) files.
`indentWidth`	`number`	The size of the indentation applied to Yaml files.
`lineEnding`	`projen.javascript.biome_config.LineEnding`	The type of line ending applied to Yaml (and its super languages) files.
`lineWidth`	`number`	What's the max width of a line applied to Yaml files.
`quoteStyle`	`projen.javascript.biome_config.QuoteStyle`	The type of quotes used in YAML code.
`trailingNewline`	`boolean`	Whether to add a trailing newline at the end of the file.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean

Whether to insert spaces inside non-empty flow mappings ({ key: value }) and sequences ([ item ]) that fit on one line.

If unset, inherits the global bracket spacing setting. When neither is set, mappings have spaces and sequences do not.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the formatter for Yaml (and its super languages) files.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number
Default: 2.

The size of the indentation applied to Yaml files.

Defaults to 2.

`lineEnding`^Optional

public readonly lineEnding: LineEnding;

Type: projen.javascript.biome_config.LineEnding

The type of line ending applied to Yaml (and its super languages) files.

auto uses CRLF on Windows and LF on other platforms.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number
Default: 80.

What's the max width of a line applied to Yaml files.

Defaults to 80.

`quoteStyle`^Optional

public readonly quoteStyle: QuoteStyle;

Type: projen.javascript.biome_config.QuoteStyle
Default: double`.

The type of quotes used in YAML code.

Defaults to double.

`trailingNewline`^Optional

public readonly trailingNewline: boolean;

Type: boolean
Default: true.

Whether to add a trailing newline at the end of the file.

Setting this option to false is highly discouraged because it could cause many problems with other tools:

Disable the option at your own risk.

Defaults to true.

YamlLinterConfiguration

Options that change how the Yaml linter behaves.

Initializer

import { javascript } from 'projen'

const yamlLinterConfiguration: javascript.biome_config.YamlLinterConfiguration = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Control the linter for Yaml files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the linter for Yaml files.

Enums

ArrowParentheses

Members

Name	Description
`ALWAYS`	Always prints parentheses around arrow-function parameters.
`AS_NEEDED`	Omits parentheses when an arrow function has one parameter and the syntax permits it.

`ALWAYS`

Always prints parentheses around arrow-function parameters.

(always)

`AS_NEEDED`

Omits parentheses when an arrow function has one parameter and the syntax permits it.

(asNeeded)

AttributePosition

Controls attribute placement in HTML-like languages.

Members

Name	Description
`AUTO`	Places attributes automatically and wraps them when needed.
`MULTILINE`	Places each attribute on its own line when an element has multiple attributes.

`AUTO`

Places attributes automatically and wraps them when needed.

(auto)

`MULTILINE`

Places each attribute on its own line when an element has multiple attributes.

(multiline)

Expand

Members

Name	Description
`AUTO`	Objects are expanded when the first property has a leading newline.
`ALWAYS`	Objects and arrays are always expanded.
`NEVER`	Objects and arrays remain on one line if they fit.

`AUTO`

Objects are expanded when the first property has a leading newline.

Arrays remain on one line if they fit. (auto)

`ALWAYS`

Objects and arrays are always expanded.

(always)

`NEVER`

Objects and arrays remain on one line if they fit.

(never)

IndentStyle

Members

Name	Description
`TAB`	Uses tabs for indentation.
`SPACE`	Uses spaces for indentation.

`TAB`

Uses tabs for indentation.

(tab)

`SPACE`

Uses spaces for indentation.

(space)

JsonTrailingCommas

Controls trailing commas in multiline JSON arrays and objects.

Use all only for JSON variants that allow trailing commas, and ensure json.parser.allowTrailingCommas is enabled or automatically detected for those files.

Members

Name	Description
`NONE`	none.
`ALL`	all.

`NONE`

none.

`ALL`

all.

JsTrailingCommas

Print trailing commas wherever possible in multi-line comma-separated syntactic structures for JavaScript/TypeScript files.

Members

Name	Description
`ALL`	all.
`ES5`	es5.
`NONE`	none.

`ALL`

all.

`ES5`

es5.

`NONE`

none.

JsxRuntime

How Biome's analyzer accounts for imports used by JSX.

Members

Name	Description
`TRANSPARENT`	An automatic or native JSX environment that doesn't require an in-scope factory import.
`REACT_CLASSIC`	A classic React environment that requires the React import, or custom JSX factory imports configured in `tsconfig.json`.

`TRANSPARENT`

An automatic or native JSX environment that doesn't require an in-scope factory import.

(transparent)

`REACT_CLASSIC`

A classic React environment that requires the React import, or custom JSX factory imports configured in tsconfig.json.

Corresponds to the react value for the jsx option in TypeScript's tsconfig.json.

This option should only be necessary if you cannot upgrade to a React version that supports the new JSX runtime. For more information about the old vs. new JSX runtime, please see: https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html (reactClassic)

LineEnding

Members

Name	Description
`LF`	Line Feed only (\n), common on Linux and macOS as well as inside git repos (lf).
`CRLF`	Carriage Return + Line Feed characters (\r\n), common on Windows (crlf).
`CR`	Carriage Return character only (\r), used very rarely (cr).
`AUTO`	Automatically use CRLF on Windows and LF on other platforms (auto).

`LF`

Line Feed only (\n), common on Linux and macOS as well as inside git repos (lf).

`CRLF`

Carriage Return + Line Feed characters (\r\n), common on Windows (crlf).

`CR`

Carriage Return character only (\r), used very rarely (cr).

`AUTO`

Automatically use CRLF on Windows and LF on other platforms (auto).

OperatorLinebreak

Members

Name	Description
`AFTER`	The operator is placed after the expression (after).
`BEFORE`	The operator is placed before the expression (before).

`AFTER`

The operator is placed after the expression (after).

`BEFORE`

The operator is placed before the expression (before).

PresetConfig

A preset configuration for enabling a set of rules.

Members

Name	Description
`RECOMMENDED`	recommended.
`ALL`	all.
`NONE`	none.

`RECOMMENDED`

recommended.

`ALL`

all.

`NONE`

none.

ProseWrap

Controls whether Biome keeps, adds, or removes line breaks in Markdown paragraphs.

Manual line breaks are always kept. In Markdown, a manual line break is created by ending a line with two spaces or a backslash.

Members

Name	Description
`PRESERVE`	Keep line breaks as written in the source file.
`ALWAYS`	Wrap paragraphs to fit the configured `lineWidth`.
`NEVER`	Remove line breaks from paragraphs so that each paragraph is on one line.

`PRESERVE`

Keep line breaks as written in the source file.

This is the default. (preserve)

`ALWAYS`

Wrap paragraphs to fit the configured lineWidth.

(always)

`NEVER`

Remove line breaks from paragraphs so that each paragraph is on one line.

(never)

QuoteProperties

Members

Name	Description
`AS_NEEDED`	Removes quotes when the property name is valid without them.
`PRESERVE`	Preserves quotes around property names that were quoted in the input.

`AS_NEEDED`

Removes quotes when the property name is valid without them.

(asNeeded)

`PRESERVE`

Preserves quotes around property names that were quoted in the input.

(preserve)

QuoteStyle

Members

Name	Description
`DOUBLE`	double.
`SINGLE`	single.

`DOUBLE`

double.

`SINGLE`

single.

RuleDomainValue

Members

Name	Description
`ALL`	Enables all rules in the domain.
`NONE`	Disables the domain.
`RECOMMENDED`	Enables the domain's recommended non-nursery rules.

`ALL`

Enables all rules in the domain.

(all)

`NONE`

Disables the domain.

(none)

`RECOMMENDED`

Enables the domain's recommended non-nursery rules.

(recommended)

SelfCloseVoidElements

Controls whether HTML void elements such as <img> and <input> include a slash before >.

Members

Name	Description
`NEVER`	Removes the slash, for example `<img src="image.png">`. (never).
`ALWAYS`	Adds the slash, for example `<img src="image.png" />`. (always).

`NEVER`

Removes the slash, for example <img src="image.png">. (never).

`ALWAYS`

Adds the slash, for example <img src="image.png" />. (always).

Semicolons

Members

Name	Description
`ALWAYS`	always.
`AS_NEEDED`	asNeeded.

`ALWAYS`

always.

`AS_NEEDED`

asNeeded.

VcsClientKind

Integration with Git as the version control client.

Members

Name	Description
`GIT`	git.

`GIT`

git.

WhitespaceSensitivity

Controls how the formatter treats whitespace around text and child elements in HTML, Vue, Svelte, and Astro markup.

The following two cases won't produce the same output:

	html	output
with spaces	`1<b> 2 </b>3`	1 2 3
without spaces	`1<b>2</b>3`	123

This happens because whitespace is significant in inline elements.

As a consequence of this, the formatter must format blocks that look like this (assume a small line width, <20):

<span>really long content</span>

as this, where the content hugs the tags:

<span
>really long content</span
>

Note that this is only necessary for inline elements. Block elements do not have this restriction.

Members

Name	Description
`CSS`	Treats whitespace as significant for elements that browsers display inline by default.
`STRICT`	Treats leading and trailing whitespace as significant for every element.
`IGNORE`	Treats whitespace as insignificant, allowing the formatter to add or remove it.

`CSS`

Treats whitespace as significant for elements that browsers display inline by default.

(css)

`STRICT`

Treats leading and trailing whitespace as significant for every element.

Existing whitespace is preserved as at least one character and absent whitespace is not added.

Example of text hugging the tags:

<b
>content</b
>
``` (strict)

---


##### `IGNORE` <a name="IGNORE" id="projen.javascript.biome_config.WhitespaceSensitivity.IGNORE"></a>

Treats whitespace as insignificant, allowing the formatter to add or remove it.

Use this only
when whitespace cannot affect rendered output. (ignore)

---

Structs ​

Actions ​

Initializer ​

Properties ​

presetOptional ​

recommendedOptional ​

sourceOptional ​

AssistConfiguration ​

Initializer ​

Properties ​

actionsOptional ​

enabledOptional ​

includesOptional ​

BiomeConfiguration ​

Initializer ​

Properties ​

assistOptional ​

cssOptional ​

extendsOptional ​

filesOptional ​

formatterOptional ​

graphqlOptional ​

gritOptional ​

htmlOptional ​

javascriptOptional ​

jsonOptional ​

linterOptional ​

markdownOptional ​

overridesOptional ​

pluginsOptional ​

rootOptional ​

schemaOptional ​

tailwindOptional ​

vcsOptional ​

yamlOptional ​

CssAssistConfiguration ​

Initializer ​

Properties ​

enabledOptional ​

CssConfiguration ​

Initializer ​

Properties ​

assistOptional ​

formatterOptional ​

globalsOptional ​

linterOptional ​

parserOptional ​

CssFormatterConfiguration ​

Initializer ​

Properties ​

delimiterSpacingOptional ​

enabledOptional ​

indentStyleOptional ​

indentWidthOptional ​

lineEndingOptional ​

lineWidthOptional ​

quoteStyleOptional ​

trailingNewlineOptional ​

CssLinterConfiguration ​

Initializer ​

Properties ​

enabledOptional ​

CssParserConfiguration ​

Initializer ​

Properties ​

allowWrongLineCommentsOptional ​

cssModulesOptional ​

tailwindDirectivesOptional ​

FilesConfiguration ​

Initializer ​

Properties ​

experimentalScannerIgnoresOptional ​

ignoreUnknownOptional ​

includesOptional ​

maxSizeOptional ​

FormatterConfiguration ​

Initializer ​

Properties ​

attributePositionOptional ​

bracketSameLineOptional ​

Structs

Actions

Initializer

Properties

`preset`^Optional

`recommended`^Optional

`source`^Optional

AssistConfiguration

Initializer

Properties

`actions`^Optional

`enabled`^Optional

`includes`^Optional

BiomeConfiguration

Initializer

Properties

`assist`^Optional

`css`^Optional

`extends`^Optional

`files`^Optional

`formatter`^Optional

`graphql`^Optional

`grit`^Optional

`html`^Optional

`javascript`^Optional

`json`^Optional

`linter`^Optional

`markdown`^Optional

`overrides`^Optional

`plugins`^Optional

`root`^Optional

`schema`^Optional

`tailwind`^Optional

`vcs`^Optional

`yaml`^Optional

CssAssistConfiguration

Initializer

Properties

`enabled`^Optional

CssConfiguration

Initializer

Properties

`assist`^Optional

`formatter`^Optional

`globals`^Optional

`linter`^Optional

`parser`^Optional

CssFormatterConfiguration

Initializer

Properties

`delimiterSpacing`^Optional

`enabled`^Optional

`indentStyle`^Optional

`indentWidth`^Optional

`lineEnding`^Optional

`lineWidth`^Optional

`quoteStyle`^Optional

`trailingNewline`^Optional

CssLinterConfiguration

Initializer

Properties

`enabled`^Optional

CssParserConfiguration

Initializer

Properties

`allowWrongLineComments`^Optional

`cssModules`^Optional

`tailwindDirectives`^Optional

FilesConfiguration

Initializer

Properties

`experimentalScannerIgnores`^Optional

`ignoreUnknown`^Optional

`includes`^Optional

`maxSize`^Optional

FormatterConfiguration

Initializer

Properties

`attributePosition`^Optional

`bracketSameLine`^Optional