projen 0.104.14 → 0.104.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (169) hide show
  1. package/.jsii +1712 -603
  2. package/lib/ai-instructions.js +2 -2
  3. package/lib/awscdk/auto-discover.js +6 -6
  4. package/lib/awscdk/awscdk-app-java.js +1 -1
  5. package/lib/awscdk/awscdk-app-py.js +1 -1
  6. package/lib/awscdk/awscdk-app-ts.js +1 -1
  7. package/lib/awscdk/awscdk-construct.js +1 -1
  8. package/lib/awscdk/awscdk-deps-java.js +1 -1
  9. package/lib/awscdk/awscdk-deps-js.js +1 -1
  10. package/lib/awscdk/awscdk-deps-py.js +1 -1
  11. package/lib/awscdk/awscdk-deps.js +1 -1
  12. package/lib/awscdk/cdk-config.d.ts +7 -0
  13. package/lib/awscdk/cdk-config.js +5 -4
  14. package/lib/awscdk/cdk-tasks.js +1 -1
  15. package/lib/awscdk/integration-test.js +1 -1
  16. package/lib/awscdk/lambda-extension.js +1 -1
  17. package/lib/awscdk/lambda-function.js +2 -2
  18. package/lib/build/build-workflow.js +1 -1
  19. package/lib/cdk/auto-discover-base.js +2 -2
  20. package/lib/cdk/construct-lib.js +1 -1
  21. package/lib/cdk/integration-test-base.js +1 -1
  22. package/lib/cdk/jsii-build.js +1 -1
  23. package/lib/cdk/jsii-docgen.js +1 -1
  24. package/lib/cdk/jsii-project.js +1 -1
  25. package/lib/cdk8s/auto-discover.js +2 -2
  26. package/lib/cdk8s/cdk8s-app-py.js +1 -1
  27. package/lib/cdk8s/cdk8s-app-ts.js +1 -1
  28. package/lib/cdk8s/cdk8s-construct.js +1 -1
  29. package/lib/cdk8s/cdk8s-deps-py.js +1 -1
  30. package/lib/cdk8s/cdk8s-deps.js +1 -1
  31. package/lib/cdk8s/integration-test.js +1 -1
  32. package/lib/cdktf/cdktf-construct.js +1 -1
  33. package/lib/cdktn/cdktn-app-ts.js +1 -1
  34. package/lib/cdktn/cdktn-config.js +1 -1
  35. package/lib/cdktn/cdktn-construct.js +1 -1
  36. package/lib/cdktn/cdktn-deps.js +1 -1
  37. package/lib/cdktn/cdktn-tasks.js +1 -1
  38. package/lib/circleci/circleci.js +1 -1
  39. package/lib/component.js +2 -2
  40. package/lib/dependencies.js +1 -1
  41. package/lib/dev-env.js +1 -1
  42. package/lib/docker-compose/docker-compose-service.js +1 -1
  43. package/lib/docker-compose/docker-compose.js +1 -1
  44. package/lib/file.js +1 -1
  45. package/lib/gitattributes.js +1 -1
  46. package/lib/github/actions-provider.js +1 -1
  47. package/lib/github/actions.const.js +1 -1
  48. package/lib/github/auto-approve.js +1 -1
  49. package/lib/github/auto-merge.js +1 -1
  50. package/lib/github/auto-queue.js +1 -1
  51. package/lib/github/dependabot.js +1 -1
  52. package/lib/github/dependency-review.js +1 -1
  53. package/lib/github/github-credentials.js +1 -1
  54. package/lib/github/github-project.js +1 -1
  55. package/lib/github/github.js +1 -1
  56. package/lib/github/merge-queue.js +1 -1
  57. package/lib/github/mergify.js +1 -1
  58. package/lib/github/pr-template.js +1 -1
  59. package/lib/github/pull-request-backport.js +1 -1
  60. package/lib/github/pull-request-lint.js +1 -1
  61. package/lib/github/pull-request-source.js +1 -1
  62. package/lib/github/stale.js +1 -1
  63. package/lib/github/task-workflow-job.js +1 -1
  64. package/lib/github/task-workflow.js +1 -1
  65. package/lib/github/workflow-actions.js +1 -1
  66. package/lib/github/workflow-jobs.js +1 -1
  67. package/lib/github/workflow-steps.js +1 -1
  68. package/lib/github/workflows.js +1 -1
  69. package/lib/gitlab/configuration.js +1 -1
  70. package/lib/gitlab/gitlab-configuration.js +1 -1
  71. package/lib/gitlab/nested-configuration.js +1 -1
  72. package/lib/gitpod.js +1 -1
  73. package/lib/ignore-file.js +1 -1
  74. package/lib/ini.js +1 -1
  75. package/lib/java/java-project.js +1 -1
  76. package/lib/java/junit.js +1 -1
  77. package/lib/java/maven-compile.js +1 -1
  78. package/lib/java/maven-packaging.js +1 -1
  79. package/lib/java/maven-sample.js +1 -1
  80. package/lib/java/pom.d.ts +12 -0
  81. package/lib/java/pom.js +9 -3
  82. package/lib/java/projenrc.js +1 -1
  83. package/lib/javascript/biome/biome-config.d.ts +826 -224
  84. package/lib/javascript/biome/biome-config.js +207 -31
  85. package/lib/javascript/biome/biome.js +1 -1
  86. package/lib/javascript/bundler.js +1 -1
  87. package/lib/javascript/eslint.js +1 -1
  88. package/lib/javascript/jest.js +4 -4
  89. package/lib/javascript/license-checker.js +1 -1
  90. package/lib/javascript/node-config-file.js +1 -1
  91. package/lib/javascript/node-native-test-runner.js +2 -2
  92. package/lib/javascript/node-package.js +1 -1
  93. package/lib/javascript/node-project.js +1 -1
  94. package/lib/javascript/npm-config.js +1 -1
  95. package/lib/javascript/pnpm-workspace-config.js +2 -2
  96. package/lib/javascript/pnpm-workspace.js +1 -1
  97. package/lib/javascript/prettier.js +1 -1
  98. package/lib/javascript/projenrc.js +1 -1
  99. package/lib/javascript/typescript-config.js +2 -2
  100. package/lib/javascript/upgrade-dependencies.js +2 -2
  101. package/lib/javascript/yarnrc.js +1 -1
  102. package/lib/json-patch.js +1 -1
  103. package/lib/json.js +1 -1
  104. package/lib/license.js +1 -1
  105. package/lib/logger.js +1 -1
  106. package/lib/makefile.js +1 -1
  107. package/lib/object-file.js +1 -1
  108. package/lib/polaris/coverity-go.js +1 -1
  109. package/lib/polaris/coverity-java.js +1 -1
  110. package/lib/polaris/coverity-javascript.js +1 -1
  111. package/lib/polaris/coverity.js +1 -1
  112. package/lib/project-build.js +1 -1
  113. package/lib/project-tree.js +1 -1
  114. package/lib/project.js +1 -1
  115. package/lib/projects.js +1 -1
  116. package/lib/projenrc-json.js +1 -1
  117. package/lib/projenrc.js +1 -1
  118. package/lib/properties-file.js +1 -1
  119. package/lib/python/pip.js +1 -1
  120. package/lib/python/poetry.js +2 -2
  121. package/lib/python/projenrc.js +1 -1
  122. package/lib/python/pyproject-toml-file.js +1 -1
  123. package/lib/python/pytest-sample.js +1 -1
  124. package/lib/python/pytest.js +1 -1
  125. package/lib/python/python-project.js +1 -1
  126. package/lib/python/python-sample.js +1 -1
  127. package/lib/python/requirements-file.js +1 -1
  128. package/lib/python/setuppy.js +1 -1
  129. package/lib/python/setuptools.js +1 -1
  130. package/lib/python/uv-config.js +1 -1
  131. package/lib/python/uv.js +1 -1
  132. package/lib/python/venv.js +1 -1
  133. package/lib/readme.js +1 -1
  134. package/lib/release/publisher.js +1 -1
  135. package/lib/release/release-trigger.js +1 -1
  136. package/lib/release/release.js +1 -1
  137. package/lib/renovatebot.js +1 -1
  138. package/lib/run-task.cjs +1 -1
  139. package/lib/sample-file.js +2 -2
  140. package/lib/script-runner.js +1 -1
  141. package/lib/sonarqube/javascript.js +1 -1
  142. package/lib/sonarqube/rust.js +1 -1
  143. package/lib/sonarqube/sonarqube.js +1 -1
  144. package/lib/sonarqube/typescript.js +1 -1
  145. package/lib/source-code.js +1 -1
  146. package/lib/task-shell.js +1 -1
  147. package/lib/task.js +1 -1
  148. package/lib/tasks.js +1 -1
  149. package/lib/testing.js +1 -1
  150. package/lib/textfile.js +1 -1
  151. package/lib/toml.js +1 -1
  152. package/lib/typescript/projenrc-ts.js +1 -1
  153. package/lib/typescript/projenrc.js +1 -1
  154. package/lib/typescript/typescript-runner.js +1 -1
  155. package/lib/typescript/typescript-typedoc.js +1 -1
  156. package/lib/typescript/typescript.js +5 -5
  157. package/lib/version.js +2 -2
  158. package/lib/vscode/devcontainer.js +1 -1
  159. package/lib/vscode/extensions.js +1 -1
  160. package/lib/vscode/launch-config.js +1 -1
  161. package/lib/vscode/settings.js +1 -1
  162. package/lib/vscode/vscode.js +1 -1
  163. package/lib/web/next.js +3 -3
  164. package/lib/web/postcss.js +1 -1
  165. package/lib/web/react.js +3 -3
  166. package/lib/web/tailwind.js +1 -1
  167. package/lib/xmlfile.js +1 -1
  168. package/lib/yaml.js +1 -1
  169. package/package.json +1 -1
@@ -1,11 +1,13 @@
1
1
  /**
2
- * The configuration contained in `biome.json`.
2
+ * The configuration contained in `biome.json` or `biome.jsonc`.
3
3
  *
4
4
  * @schema BiomeConfiguration
5
5
  */
6
6
  export interface BiomeConfiguration {
7
7
  /**
8
- * A field for the JSON schema specification: https://json-schema.org/
8
+ * The JSON Schema used to validate the configuration and provide editor completion. Biome
9
+ * emits a diagnostic when a `biomejs.dev` schema URL specifies a version that differs from the
10
+ * running CLI version.
9
11
  *
10
12
  * @schema BiomeConfiguration#$schema
11
13
  */
@@ -23,19 +25,24 @@ export interface BiomeConfiguration {
23
25
  */
24
26
  readonly css?: CssConfiguration;
25
27
  /**
26
- * A list of paths to other JSON files, used to extend the current configuration.
28
+ * Extends the current configuration with settings from one or more other Biome configurations.
29
+ * Use `"//"` in a nested configuration to extend the root configuration at any nesting depth.
30
+ * Use an array to extend configurations by relative path or installed package specifier.
31
+ *
32
+ * Biome merges configurations from left to right. Later configurations take precedence for
33
+ * single-value options, list entries are combined, and the current file is applied last.
27
34
  *
28
35
  * @schema BiomeConfiguration#extends
29
36
  */
30
- readonly extends?: string[];
37
+ readonly extends?: any;
31
38
  /**
32
- * The file handling configuration.
39
+ * Configures which files Biome can discover and process.
33
40
  *
34
41
  * @schema BiomeConfiguration#files
35
42
  */
36
43
  readonly files?: FilesConfiguration;
37
44
  /**
38
- * The formatter configuration.
45
+ * Configures formatting for selected files.
39
46
  *
40
47
  * @schema BiomeConfiguration#formatter
41
48
  */
@@ -77,30 +84,54 @@ export interface BiomeConfiguration {
77
84
  */
78
85
  readonly linter?: LinterConfiguration;
79
86
  /**
80
- * A list of granular patterns applied only to a subset of files.
87
+ * Configuration specific to Markdown.
88
+ *
89
+ * @schema BiomeConfiguration#markdown
90
+ */
91
+ readonly markdown?: MarkdownConfiguration;
92
+ /**
93
+ * Configures settings for files selected by each override. When multiple overrides configure
94
+ * the same single-value setting, the last matching override takes precedence.
81
95
  *
82
96
  * @schema BiomeConfiguration#overrides
83
97
  */
84
98
  readonly overrides?: OverridePattern[];
85
99
  /**
86
- * List of plugins to load.
100
+ * A list of GritQL plugins to load.
87
101
  *
88
102
  * @schema BiomeConfiguration#plugins
89
103
  */
90
104
  readonly plugins?: any[];
91
105
  /**
92
- * Indicates whether this configuration file is at the root of a Biome
93
- * project. By default, this is `true`.
106
+ * Marks whether this file is the root configuration for a Biome project. The root configuration
107
+ * establishes the project's base settings, while `false` marks a configuration found inside the
108
+ * project as nested rather than a second project root.
109
+ *
110
+ * Defaults to `true`. Biome implicitly treats `root` as `false` when a nested configuration uses
111
+ * `"extends": "//"`. All other nested configurations must explicitly set `root` to `false`.
94
112
  *
113
+ * @default true`. Biome implicitly treats `root` as `false` when a nested configuration uses
95
114
  * @schema BiomeConfiguration#root
96
115
  */
97
116
  readonly root?: boolean;
117
+ /**
118
+ * Configures how Biome recognizes Tailwind class strings.
119
+ *
120
+ * @schema BiomeConfiguration#tailwind
121
+ */
122
+ readonly tailwind?: TailwindConfiguration;
98
123
  /**
99
124
  * The version control integration configuration.
100
125
  *
101
126
  * @schema BiomeConfiguration#vcs
102
127
  */
103
128
  readonly vcs?: VcsConfiguration;
129
+ /**
130
+ * Configuration specific to YAML.
131
+ *
132
+ * @schema BiomeConfiguration#yaml
133
+ */
134
+ readonly yaml?: YamlConfiguration;
104
135
  }
105
136
  /**
106
137
  * Converts an object of type 'BiomeConfiguration' to JSON representation.
@@ -112,20 +143,22 @@ export declare function toJson_BiomeConfiguration(obj: BiomeConfiguration | unde
112
143
  */
113
144
  export interface AssistConfiguration {
114
145
  /**
115
- * Whether Biome should fail in CLI if the assist were not applied to the code.
146
+ * The assist-action configuration.
116
147
  *
117
148
  * @schema AssistConfiguration#actions
118
149
  */
119
150
  readonly actions?: Actions;
120
151
  /**
121
- * Whether Biome should enable assist via LSP and CLI.
152
+ * Enables configured assist actions in the CLI and editor integrations. Defaults to `true`.
122
153
  *
154
+ * @default true`.
123
155
  * @schema AssistConfiguration#enabled
124
156
  */
125
157
  readonly enabled?: boolean;
126
158
  /**
127
- * A list of glob patterns. Biome will include files/folders that will
128
- * match these patterns.
159
+ * A list of glob patterns selecting files on which assist actions can run. If omitted, all files
160
+ * selected by `files.includes` remain eligible for assist actions. An empty list selects no
161
+ * files. This option can only narrow the files selected by `files.includes`.
129
162
  *
130
163
  * @schema AssistConfiguration#includes
131
164
  */
@@ -137,7 +170,10 @@ export interface AssistConfiguration {
137
170
  */
138
171
  export declare function toJson_AssistConfiguration(obj: AssistConfiguration | undefined): Record<string, any> | undefined;
139
172
  /**
140
- * Options applied to CSS files.
173
+ * Options applied to CSS and languages that extend it.
174
+ *
175
+ * Language-specific settings take precedence over corresponding global settings. Global settings
176
+ * apply when their language-specific counterparts are omitted, unless stated otherwise.
141
177
  *
142
178
  * @schema CssConfiguration
143
179
  */
@@ -155,7 +191,7 @@ export interface CssConfiguration {
155
191
  */
156
192
  readonly formatter?: CssFormatterConfiguration;
157
193
  /**
158
- * CSS globals.
194
+ * Reserved for future CSS analyzer support. This option currently has no effect.
159
195
  *
160
196
  * @schema CssConfiguration#globals
161
197
  */
@@ -188,27 +224,38 @@ export interface FilesConfiguration {
188
224
  * **Deprecated:** Please use _force-ignore syntax_ in `files.includes`
189
225
  * instead: <https://biomejs.dev/reference/configuration/#filesincludes>
190
226
  *
191
- * Set of file and folder names that should be unconditionally ignored by
192
- * Biome's scanner.
227
+ * File or directory names that the scanner ignores unconditionally while crawling. Each value
228
+ * matches a complete path component, not a glob. Ignored files are not added to the module graph,
229
+ * so types are not inferred from them.
193
230
  *
194
231
  * @schema FilesConfiguration#experimentalScannerIgnores
195
232
  */
196
233
  readonly experimentalScannerIgnores?: string[];
197
234
  /**
198
- * Prevents Biome from emitting diagnostics for unrecognized file types.
235
+ * Prevents Biome from emitting diagnostics for unrecognized file types. Defaults to `false`.
199
236
  *
237
+ * @default false`.
200
238
  * @schema FilesConfiguration#ignoreUnknown
201
239
  */
202
240
  readonly ignoreUnknown?: boolean;
203
241
  /**
204
- * A list of glob patterns. Biome handles only files and directories that match these
205
- * patterns.
242
+ * A list of glob patterns selecting which files and directories Biome can process. If omitted,
243
+ * this option does not further restrict the supported files Biome can process. An empty list
244
+ * selects no files. Biome ignores files under `node_modules` even when they match a pattern.
245
+ *
246
+ * The scanner uses these patterns and, when enabled, VCS ignore files while discovering nested
247
+ * configuration and ignore files. When enabled rules use the `project` or `types` domains, it
248
+ * also indexes source files and project dependencies. It may still discover required metadata or
249
+ * index excluded source files needed for analysis. A pattern beginning with `!!` prevents the
250
+ * scanner from indexing matching paths. Patterns are evaluated in order, and a pattern beginning
251
+ * with `!` excludes matches.
206
252
  *
207
253
  * @schema FilesConfiguration#includes
208
254
  */
209
255
  readonly includes?: string[];
210
256
  /**
211
- * The maximum source file size in bytes. Biome ignores larger files. Defaults to `1 MiB`.
257
+ * The maximum source-file size in bytes. Biome skips larger files and emits a warning
258
+ * diagnostic. Defaults to `1 MiB`.
212
259
  *
213
260
  * @default 1 MiB`.
214
261
  * @schema FilesConfiguration#maxSize
@@ -221,7 +268,7 @@ export interface FilesConfiguration {
221
268
  */
222
269
  export declare function toJson_FilesConfiguration(obj: FilesConfiguration | undefined): Record<string, any> | undefined;
223
270
  /**
224
- * Generic options applied to all files
271
+ * Configures formatting for selected files.
225
272
  *
226
273
  * @schema FormatterConfiguration
227
274
  */
@@ -234,15 +281,18 @@ export interface FormatterConfiguration {
234
281
  */
235
282
  readonly attributePosition?: AttributePosition;
236
283
  /**
237
- * Places the `>` of a multiline HTML or JSX element at the end of the last line instead of on
238
- * the next line. Self-closing elements are unaffected. Defaults to `false`.
284
+ * Controls the placement of the closing bracket for multiline HTML and JSX opening tags. Biome
285
+ * places the bracket at the end of the last attribute line when enabled and on its own line when
286
+ * disabled. This also affects self-closing HTML elements, but self-closing JSX elements are
287
+ * unaffected. Defaults to `false`.
239
288
  *
240
289
  * @default false`.
241
290
  * @schema FormatterConfiguration#bracketSameLine
242
291
  */
243
292
  readonly bracketSameLine?: boolean;
244
293
  /**
245
- * Whether to insert spaces inside braces in object literals. Defaults to `true`.
294
+ * Controls spaces inside braces in supported single-line structures. The affected structures
295
+ * vary by language. Defaults to `true`.
246
296
  *
247
297
  * @default true`.
248
298
  * @schema FormatterConfiguration#bracketSpacing
@@ -259,6 +309,9 @@ export interface FormatterConfiguration {
259
309
  */
260
310
  readonly delimiterSpacing?: boolean;
261
311
  /**
312
+ * Enables or disables the formatter. Defaults to `true`.
313
+ *
314
+ * @default true`.
262
315
  * @schema FormatterConfiguration#enabled
263
316
  */
264
317
  readonly enabled?: boolean;
@@ -288,8 +341,9 @@ export interface FormatterConfiguration {
288
341
  */
289
342
  readonly formatWithErrors?: boolean;
290
343
  /**
291
- * A list of glob patterns. The formatter will include files/folders that will
292
- * match these patterns.
344
+ * A list of glob patterns selecting files to format. If omitted, all files selected by
345
+ * `files.includes` remain eligible for formatting. An empty list selects no files. This option
346
+ * can only narrow the files selected by `files.includes`.
293
347
  *
294
348
  * @schema FormatterConfiguration#includes
295
349
  */
@@ -302,7 +356,10 @@ export interface FormatterConfiguration {
302
356
  */
303
357
  readonly indentStyle?: IndentStyle;
304
358
  /**
305
- * The indentation width. Defaults to `2`.
359
+ * Sets the indentation width. With space indentation, this is the number of spaces emitted per
360
+ * indentation level. With tab indentation, Biome emits one tab per level and uses this value as
361
+ * the tab's display width when calculating line length. Accepted values are `0` through `24`.
362
+ * Defaults to `2`.
306
363
  *
307
364
  * @default 2`.
308
365
  * @schema FormatterConfiguration#indentWidth
@@ -316,23 +373,28 @@ export interface FormatterConfiguration {
316
373
  */
317
374
  readonly lineEnding?: LineEnding;
318
375
  /**
319
- * The maximum line width. Defaults to `80`.
376
+ * Sets the preferred maximum line width used when deciding where to wrap code. Some content,
377
+ * such as long unbreakable strings, may still exceed this width. Accepted values are `1` through
378
+ * `320`. Defaults to `80`.
320
379
  *
321
380
  * @default 80`.
322
381
  * @schema FormatterConfiguration#lineWidth
323
382
  */
324
383
  readonly lineWidth?: number;
325
384
  /**
326
- * Whether to add a trailing newline at the end of the file. Defaults to `true`; disabling
385
+ * Whether to add a trailing newline at the end of the file. Defaults to `true`. Disabling
327
386
  * this option can cause compatibility problems with other tools.
328
387
  *
329
- * @default true`; disabling
388
+ * @default true`. Disabling
330
389
  * @schema FormatterConfiguration#trailingNewline
331
390
  */
332
391
  readonly trailingNewline?: boolean;
333
392
  /**
334
- * Uses `.editorconfig` files to configure the formatter. Settings in `biome.json` or
335
- * `biome.jsonc` override `.editorconfig` settings. Defaults to `false`.
393
+ * Controls whether Biome loads formatter settings from an `.editorconfig` file. Biome reads
394
+ * `indent_style`, `indent_size`, `end_of_line`, and `insert_final_newline`. Settings in
395
+ * `biome.json` or `biome.jsonc` take precedence. Biome loads only one `.editorconfig`. Nested
396
+ * cascading configurations and the EditorConfig `root` property are not supported. Defaults to
397
+ * `false`.
336
398
  *
337
399
  * @default false`.
338
400
  * @schema FormatterConfiguration#useEditorconfig
@@ -347,6 +409,9 @@ export declare function toJson_FormatterConfiguration(obj: FormatterConfiguratio
347
409
  /**
348
410
  * Options applied to GraphQL files.
349
411
  *
412
+ * Language-specific settings take precedence over corresponding global settings. Global settings
413
+ * apply when their language-specific counterparts are omitted, unless stated otherwise.
414
+ *
350
415
  * @schema GraphqlConfiguration
351
416
  */
352
417
  export interface GraphqlConfiguration {
@@ -377,6 +442,9 @@ export declare function toJson_GraphqlConfiguration(obj: GraphqlConfiguration |
377
442
  /**
378
443
  * Options applied to GritQL files.
379
444
  *
445
+ * Language-specific settings take precedence over corresponding global settings. Global settings
446
+ * apply when their language-specific counterparts are omitted, unless stated otherwise.
447
+ *
380
448
  * @schema GritConfiguration
381
449
  */
382
450
  export interface GritConfiguration {
@@ -405,7 +473,13 @@ export interface GritConfiguration {
405
473
  */
406
474
  export declare function toJson_GritConfiguration(obj: GritConfiguration | undefined): Record<string, any> | undefined;
407
475
  /**
408
- * Options applied to HTML files.
476
+ * Options applied to HTML and languages that extend it.
477
+ *
478
+ * Full HTML support and the HTML formatter are experimental. Biome aims to minimize breaking
479
+ * changes, but bug fixes and new features may change formatting output or diagnostics.
480
+ *
481
+ * Language-specific settings take precedence over corresponding global settings. Global settings
482
+ * apply when their language-specific counterparts are omitted, unless stated otherwise.
409
483
  *
410
484
  * @schema HtmlConfiguration
411
485
  */
@@ -417,8 +491,17 @@ export interface HtmlConfiguration {
417
491
  */
418
492
  readonly assist?: HtmlAssistConfiguration;
419
493
  /**
420
- * Enables full support for HTML, Vue, Svelte, and Astro files.
494
+ * Enables Biome's experimental full support for `.html`, `.vue`, `.svelte`, and `.astro` files.
495
+ * In this mode, Biome parses the complete document and can analyze or format its markup and
496
+ * supported embedded languages.
497
+ *
498
+ * When disabled, `.vue`, `.svelte`, and `.astro` files use legacy handling, which extracts their
499
+ * JavaScript or TypeScript portions and leaves the rest unchanged. This option selects how
500
+ * these files are processed. It does not enable the HTML formatter. Set
501
+ * `html.formatter.enabled` to `true` to format complete HTML, Vue, Svelte, and Astro files.
502
+ * Defaults to `false`.
421
503
  *
504
+ * @default false`.
422
505
  * @schema HtmlConfiguration#experimentalFullSupportEnabled
423
506
  */
424
507
  readonly experimentalFullSupportEnabled?: boolean;
@@ -447,57 +530,71 @@ export interface HtmlConfiguration {
447
530
  */
448
531
  export declare function toJson_HtmlConfiguration(obj: HtmlConfiguration | undefined): Record<string, any> | undefined;
449
532
  /**
450
- * A set of options applied to the JavaScript files
533
+ * Options applied to JavaScript, TypeScript, JSX, TSX, and supported languages that embed
534
+ * JavaScript.
535
+ *
536
+ * Language-specific settings take precedence over corresponding global settings. Global settings
537
+ * apply when their language-specific counterparts are omitted, unless stated otherwise.
451
538
  *
452
539
  * @schema JsConfiguration
453
540
  */
454
541
  export interface JsConfiguration {
455
542
  /**
456
- * Assist options
543
+ * JavaScript assist options.
457
544
  *
458
545
  * @schema JsConfiguration#assist
459
546
  */
460
547
  readonly assist?: JsAssistConfiguration;
461
548
  /**
462
- * Enables support for embedding snippets.
549
+ * Enables experimental parsing, formatting, linting, diagnostics, and fixes for CSS and
550
+ * GraphQL snippets embedded in JavaScript and TypeScript template literals.
551
+ *
552
+ * Biome recognizes CSS in `css` and `styled` templates and GraphQL in `gql` and `graphql`
553
+ * templates or calls. Templates containing interpolations are not currently supported.
554
+ * Defaults to `false`.
463
555
  *
556
+ * @default false`.
464
557
  * @schema JsConfiguration#experimentalEmbeddedSnippetsEnabled
465
558
  */
466
559
  readonly experimentalEmbeddedSnippetsEnabled?: boolean;
467
560
  /**
468
- * Formatting options
561
+ * JavaScript formatter options.
469
562
  *
470
563
  * @schema JsConfiguration#formatter
471
564
  */
472
565
  readonly formatter?: JsFormatterConfiguration;
473
566
  /**
474
- * A list of global bindings that should be ignored by the analyzers
567
+ * A list of additional names that Biome's JavaScript linter treats as predefined global
568
+ * bindings.
475
569
  *
476
- * If defined here, they should not emit diagnostics.
570
+ * Use this for globals supplied by a runtime, framework, or external script that are not
571
+ * declared in the source file.
477
572
  *
478
573
  * @schema JsConfiguration#globals
479
574
  */
480
575
  readonly globals?: string[];
481
576
  /**
482
- * Indicates the type of runtime or transformation used for interpreting JSX.
577
+ * Configures how the analyzer accounts for imports used by JSX. This option does not transform
578
+ * JSX or select a runtime for a build tool. Defaults to `transparent`.
483
579
  *
580
+ * @default transparent`.
484
581
  * @schema JsConfiguration#jsxRuntime
485
582
  */
486
583
  readonly jsxRuntime?: JsxRuntime;
487
584
  /**
488
- * Linter options
585
+ * JavaScript linter options.
489
586
  *
490
587
  * @schema JsConfiguration#linter
491
588
  */
492
589
  readonly linter?: JsLinterConfiguration;
493
590
  /**
494
- * Parsing options
591
+ * JavaScript parser options.
495
592
  *
496
593
  * @schema JsConfiguration#parser
497
594
  */
498
595
  readonly parser?: JsParserConfiguration;
499
596
  /**
500
- * Module/dependency resolver options
597
+ * JavaScript module and dependency resolver options.
501
598
  *
502
599
  * @schema JsConfiguration#resolver
503
600
  */
@@ -509,7 +606,10 @@ export interface JsConfiguration {
509
606
  */
510
607
  export declare function toJson_JsConfiguration(obj: JsConfiguration | undefined): Record<string, any> | undefined;
511
608
  /**
512
- * Options applied to JSON files
609
+ * Options applied to JSON, JSONC, and recognized JSON-based configuration files.
610
+ *
611
+ * Language-specific settings take precedence over corresponding global settings. Global settings
612
+ * apply when their language-specific counterparts are omitted, unless stated otherwise.
513
613
  *
514
614
  * @schema JsonConfiguration
515
615
  */
@@ -549,26 +649,31 @@ export declare function toJson_JsonConfiguration(obj: JsonConfiguration | undefi
549
649
  */
550
650
  export interface LinterConfiguration {
551
651
  /**
552
- * An object where the keys are the names of the domains, and the values are `all`, `recommended`, or `none`.
652
+ * Configures rules associated with a framework, library, project-wide analysis, or type
653
+ * analysis. Keys are domain names and values are `all`, `recommended`, or `none`.
654
+ * Enabling rules from the `project` or `types` domains activates project and dependency
655
+ * scanning. The `types` domain also enables type-aware resolution.
553
656
  *
554
657
  * @schema LinterConfiguration#domains
555
658
  */
556
659
  readonly domains?: RuleDomains;
557
660
  /**
558
- * if `false`, it disables the feature and the linter won't be executed. `true` by default
661
+ * Enables or disables the linter. Defaults to `true`.
559
662
  *
663
+ * @default true`.
560
664
  * @schema LinterConfiguration#enabled
561
665
  */
562
666
  readonly enabled?: boolean;
563
667
  /**
564
- * A list of glob patterns. The analyzer will handle only those files/folders that will
565
- * match these patterns.
668
+ * A list of glob patterns selecting files to lint. If omitted, all files selected by
669
+ * `files.includes` remain eligible for linting. An empty list selects no files. This option can
670
+ * only narrow the files selected by `files.includes`.
566
671
  *
567
672
  * @schema LinterConfiguration#includes
568
673
  */
569
674
  readonly includes?: string[];
570
675
  /**
571
- * List of rules
676
+ * The lint-rule configuration.
572
677
  *
573
678
  * @schema LinterConfiguration#rules
574
679
  */
@@ -579,83 +684,133 @@ export interface LinterConfiguration {
579
684
  * @internal
580
685
  */
581
686
  export declare function toJson_LinterConfiguration(obj: LinterConfiguration | undefined): Record<string, any> | undefined;
687
+ /**
688
+ * Options applied to Markdown files
689
+ *
690
+ * @schema MarkdownConfiguration
691
+ */
692
+ export interface MarkdownConfiguration {
693
+ /**
694
+ * Runs the linter and assist actions on the code inside fenced code blocks, frontmatter, and
695
+ * HTML blocks, with the rules and actions of the code's language. Defaults to `false`.
696
+ *
697
+ * @default false`.
698
+ * @schema MarkdownConfiguration#analyzeEmbeds
699
+ */
700
+ readonly analyzeEmbeds?: boolean;
701
+ /**
702
+ * Formatter options
703
+ *
704
+ * @schema MarkdownConfiguration#formatter
705
+ */
706
+ readonly formatter?: MarkdownFormatterConfiguration;
707
+ /**
708
+ * Linter options
709
+ *
710
+ * @schema MarkdownConfiguration#linter
711
+ */
712
+ readonly linter?: MarkdownLinterConfiguration;
713
+ /**
714
+ * Parsing options
715
+ *
716
+ * @schema MarkdownConfiguration#parser
717
+ */
718
+ readonly parser?: MarkdownParserConfiguration;
719
+ }
720
+ /**
721
+ * Converts an object of type 'MarkdownConfiguration' to JSON representation.
722
+ * @internal
723
+ */
724
+ export declare function toJson_MarkdownConfiguration(obj: MarkdownConfiguration | undefined): Record<string, any> | undefined;
582
725
  /**
583
726
  * @schema OverridePattern
584
727
  */
585
728
  export interface OverridePattern {
586
729
  /**
587
- * Specific configuration for the Json language
730
+ * Assist settings for matched files.
588
731
  *
589
732
  * @schema OverridePattern#assist
590
733
  */
591
734
  readonly assist?: OverrideAssistConfiguration;
592
735
  /**
593
- * Specific configuration for the CSS language
736
+ * CSS-specific settings for matched files.
594
737
  *
595
738
  * @schema OverridePattern#css
596
739
  */
597
740
  readonly css?: CssConfiguration;
598
741
  /**
599
- * Specific configuration for the filesystem
742
+ * File-handling settings for matched files.
600
743
  *
601
744
  * @schema OverridePattern#files
602
745
  */
603
746
  readonly files?: OverrideFilesConfiguration;
604
747
  /**
605
- * Specific configuration for the Json language
748
+ * Formatter settings for matched files.
606
749
  *
607
750
  * @schema OverridePattern#formatter
608
751
  */
609
752
  readonly formatter?: OverrideFormatterConfiguration;
610
753
  /**
611
- * Specific configuration for the Graphql language
754
+ * GraphQL-specific settings for matched files.
612
755
  *
613
756
  * @schema OverridePattern#graphql
614
757
  */
615
758
  readonly graphql?: GraphqlConfiguration;
616
759
  /**
617
- * Specific configuration for the GritQL language
760
+ * GritQL-specific settings for matched files.
618
761
  *
619
762
  * @schema OverridePattern#grit
620
763
  */
621
764
  readonly grit?: GritConfiguration;
622
765
  /**
623
- * Specific configuration for the GritQL language
766
+ * HTML-specific settings for matched files.
624
767
  *
625
768
  * @schema OverridePattern#html
626
769
  */
627
770
  readonly html?: HtmlConfiguration;
628
771
  /**
629
- * A list of glob patterns. Biome will include files/folders that will
630
- * match these patterns.
772
+ * A list of glob patterns selecting the files to which this override applies. If omitted, the
773
+ * override applies to every file. An empty list applies to no files.
631
774
  *
632
775
  * @schema OverridePattern#includes
633
776
  */
634
777
  readonly includes?: string[];
635
778
  /**
636
- * Specific configuration for the JavaScript language
779
+ * JavaScript-specific settings for matched files.
637
780
  *
638
781
  * @schema OverridePattern#javascript
639
782
  */
640
783
  readonly javascript?: JsConfiguration;
641
784
  /**
642
- * Specific configuration for the Json language
785
+ * JSON-specific settings for matched files.
643
786
  *
644
787
  * @schema OverridePattern#json
645
788
  */
646
789
  readonly json?: JsonConfiguration;
647
790
  /**
648
- * Specific configuration for the Json language
791
+ * Linter settings for matched files.
649
792
  *
650
793
  * @schema OverridePattern#linter
651
794
  */
652
795
  readonly linter?: OverrideLinterConfiguration;
653
796
  /**
654
- * Specific configuration for additional plugins
797
+ * Specific configuration for the Markdown language
798
+ *
799
+ * @schema OverridePattern#markdown
800
+ */
801
+ readonly markdown?: MarkdownConfiguration;
802
+ /**
803
+ * Additional plugins for matched files.
655
804
  *
656
805
  * @schema OverridePattern#plugins
657
806
  */
658
807
  readonly plugins?: any[];
808
+ /**
809
+ * Specific configuration for the YAML language
810
+ *
811
+ * @schema OverridePattern#yaml
812
+ */
813
+ readonly yaml?: YamlConfiguration;
659
814
  }
660
815
  /**
661
816
  * Converts an object of type 'OverridePattern' to JSON representation.
@@ -663,31 +818,126 @@ export interface OverridePattern {
663
818
  */
664
819
  export declare function toJson_OverridePattern(obj: OverridePattern | undefined): Record<string, any> | undefined;
665
820
  /**
666
- * Settings for integrating Biome with version control.
821
+ * Tells Biome where your code lists Tailwind CSS classes, so the Tailwind
822
+ * lint rules know which strings to check.
823
+ *
824
+ * @schema TailwindConfiguration
825
+ */
826
+ export interface TailwindConfiguration {
827
+ /**
828
+ * Attributes whose values are Tailwind classes, such as `class` in
829
+ * `<div class="px-2 py-2">`.
830
+ *
831
+ * Defaults to `class` and `className`. In HTML, they are case-insensitive.
832
+ *
833
+ * @default class` and `className`. In HTML, they are case-insensitive.
834
+ * @schema TailwindConfiguration#attributes
835
+ */
836
+ readonly attributes?: string[];
837
+ /**
838
+ * Functions that combine Tailwind classes, such as `clsx` and `cn`.
839
+ *
840
+ * Biome checks every string passed to these functions, like both strings
841
+ * in `cn("px-2", "py-2")`. When an object is passed, Biome checks its
842
+ * keys: in `cn({ "px-2": isActive })`, it checks `"px-2"`.
843
+ *
844
+ * Properties of these functions are checked too, so listing `tw` also
845
+ * covers `` tw.div`px-2` `` and `tw.div("px-2")`.
846
+ *
847
+ * Defaults to `clsx`, `tw`, `twMerge`, `twJoin`, `cn`, `cc`, `cnb`, and
848
+ * `ctl`.
849
+ *
850
+ * @default clsx`, `tw`, `twMerge`, `twJoin`, `cn`, `cc`, `cnb`, and
851
+ * @schema TailwindConfiguration#mergeFunctions
852
+ */
853
+ readonly mergeFunctions?: string[];
854
+ /**
855
+ * The CSS file that holds your Tailwind CSS configuration, such as
856
+ * `"./src/app.css"`. A relative path starts from the folder of the Biome
857
+ * configuration file.
858
+ *
859
+ * Biome reads the `@theme`, `@utility`, and `@custom-variant` rules in
860
+ * this file and in the files it imports with `@import`, so that the
861
+ * Tailwind rules know your theme values, utilities, and variants.
862
+ *
863
+ * To read the file, Biome scans your project when a Tailwind rule is
864
+ * enabled. Setting this option also turns on `css.parser.tailwindDirectives`,
865
+ * unless you set that option yourself.
866
+ *
867
+ * @schema TailwindConfiguration#stylesheet
868
+ */
869
+ readonly stylesheet?: string;
870
+ /**
871
+ * Functions that describe a component's styles with an object, such as
872
+ * `cva` and `tv`.
873
+ *
874
+ * Biome checks every string passed directly to these functions. In an
875
+ * object passed to them, Biome checks the classes under these properties:
876
+ *
877
+ * - `base`, `class`, and `className`: classes that always apply.
878
+ * - `variants`: classes for each version of the component, such as each
879
+ * button size.
880
+ * - `slots`: classes for each part of the component, such as its icon.
881
+ * - `compoundVariants` and `compoundSlots`: only the `class` and
882
+ * `className` of each entry.
883
+ *
884
+ * Other properties, such as `defaultVariants`, hold names rather than
885
+ * classes, so Biome skips them. For example, Biome checks `"rounded"`,
886
+ * `"px-2"`, and `"px-4"` here, but not `"small"`:
887
+ *
888
+ * ```js
889
+ * cva("rounded", {
890
+ * variants: {
891
+ * size: { small: "px-2", large: "px-4" },
892
+ * },
893
+ * defaultVariants: { size: "small" },
894
+ * });
895
+ * ```
896
+ *
897
+ * Defaults to `cva` and `tv`.
898
+ *
899
+ * @default cva` and `tv`.
900
+ * @schema TailwindConfiguration#variantFunctions
901
+ */
902
+ readonly variantFunctions?: string[];
903
+ }
904
+ /**
905
+ * Converts an object of type 'TailwindConfiguration' to JSON representation.
906
+ * @internal
907
+ */
908
+ export declare function toJson_TailwindConfiguration(obj: TailwindConfiguration | undefined): Record<string, any> | undefined;
909
+ /**
910
+ * Configures how Biome integrates with a version control system.
667
911
  *
668
912
  * @schema VcsConfiguration
669
913
  */
670
914
  export interface VcsConfiguration {
671
915
  /**
672
- * The version control client.
916
+ * Selects the version-control client. Currently, only `git` is supported.
673
917
  *
674
918
  * @schema VcsConfiguration#clientKind
675
919
  */
676
920
  readonly clientKind?: VcsClientKind;
677
921
  /**
678
- * The project's default branch.
922
+ * Sets the base branch used by `--changed` when `--since` is not provided. If neither this option
923
+ * nor `--since` is set, commands using `--changed` fail because Biome cannot determine the
924
+ * comparison base.
679
925
  *
680
926
  * @schema VcsConfiguration#defaultBranch
681
927
  */
682
928
  readonly defaultBranch?: string;
683
929
  /**
684
- * Whether Biome should integrate with the version control client.
930
+ * Enables or disables version-control integration. Defaults to `false`. Enabling integration
931
+ * requires `vcs.clientKind` to be set.
685
932
  *
933
+ * @default false`. Enabling integration
686
934
  * @schema VcsConfiguration#enabled
687
935
  */
688
936
  readonly enabled?: boolean;
689
937
  /**
690
- * Sets the directory where Biome checks for version control files.
938
+ * Sets the directory where Biome looks for version-control files. A relative value is resolved
939
+ * from the directory containing the current configuration file, while an absolute path is used
940
+ * directly.
691
941
  *
692
942
  * Defaults to the directory containing `biome.json` or `biome.jsonc`. If no configuration is
693
943
  * found, Biome uses the current working directory.
@@ -700,9 +950,12 @@ export interface VcsConfiguration {
700
950
  */
701
951
  readonly root?: string;
702
952
  /**
703
- * When `true`, Biome ignores files listed in `.gitignore`, `.ignore`, and Git's local
704
- * exclude file.
953
+ * Controls whether Biome applies patterns from `.gitignore`, Git's local `.git/info/exclude`,
954
+ * and supported `.ignore` files, including nested ignore files. Patterns in the root ignore file
955
+ * are resolved from `vcs.root`. Patterns in nested ignore files are resolved from the directory
956
+ * containing that file. Defaults to `false`.
705
957
  *
958
+ * @default false`.
706
959
  * @schema VcsConfiguration#useIgnoreFile
707
960
  */
708
961
  readonly useIgnoreFile?: boolean;
@@ -712,23 +965,53 @@ export interface VcsConfiguration {
712
965
  * @internal
713
966
  */
714
967
  export declare function toJson_VcsConfiguration(obj: VcsConfiguration | undefined): Record<string, any> | undefined;
968
+ /**
969
+ * Options applied to Yaml files
970
+ *
971
+ * @schema YamlConfiguration
972
+ */
973
+ export interface YamlConfiguration {
974
+ /**
975
+ * Formatter options
976
+ *
977
+ * @schema YamlConfiguration#formatter
978
+ */
979
+ readonly formatter?: YamlFormatterConfiguration;
980
+ /**
981
+ * @schema YamlConfiguration#linter
982
+ */
983
+ readonly linter?: YamlLinterConfiguration;
984
+ }
985
+ /**
986
+ * Converts an object of type 'YamlConfiguration' to JSON representation.
987
+ * @internal
988
+ */
989
+ export declare function toJson_YamlConfiguration(obj: YamlConfiguration | undefined): Record<string, any> | undefined;
715
990
  /**
716
991
  * @schema Actions
717
992
  */
718
993
  export interface Actions {
719
994
  /**
720
- * The actions preset to use.
995
+ * Selects the baseline set of assist actions. `recommended` enables Biome's
996
+ * recommended actions, `all` enables all actions, and `none` starts with no actions
997
+ * enabled. Group presets and explicit action settings override this preset.
998
+ * Defaults to `recommended`.
721
999
  *
1000
+ * @default recommended`.
722
1001
  * @schema Actions#preset
723
1002
  */
724
1003
  readonly preset?: PresetConfig;
725
1004
  /**
726
- * It enables the assist actions recommended by Biome. `true` by default.
1005
+ * Enables or disables Biome's recommended assist actions across all action groups.
1006
+ * Defaults to `true`.
727
1007
  *
1008
+ * @default true`.
728
1009
  * @schema Actions#recommended
729
1010
  */
730
1011
  readonly recommended?: boolean;
731
1012
  /**
1013
+ * 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.
1014
+ *
732
1015
  * @schema Actions#source
733
1016
  */
734
1017
  readonly source?: Source;
@@ -745,7 +1028,7 @@ export declare function toJson_Actions(obj: Actions | undefined): Record<string,
745
1028
  */
746
1029
  export interface CssAssistConfiguration {
747
1030
  /**
748
- * Controls assist actions for CSS files.
1031
+ * Enables or disables assist actions for CSS.
749
1032
  *
750
1033
  * @schema CssAssistConfiguration#enabled
751
1034
  */
@@ -773,7 +1056,7 @@ export interface CssFormatterConfiguration {
773
1056
  */
774
1057
  readonly delimiterSpacing?: boolean;
775
1058
  /**
776
- * Controls the formatter for CSS and languages that extend it.
1059
+ * Enables or disables the formatter for CSS and languages that extend it.
777
1060
  *
778
1061
  * @schema CssFormatterConfiguration#enabled
779
1062
  */
@@ -800,14 +1083,16 @@ export interface CssFormatterConfiguration {
800
1083
  */
801
1084
  readonly lineEnding?: LineEnding;
802
1085
  /**
803
- * The maximum line width for CSS and languages that extend it. If unset, inherits the global
804
- * line width.
1086
+ * The preferred maximum line width for CSS and languages that extend it. If unset, inherits
1087
+ * the global line width.
805
1088
  *
806
1089
  * @schema CssFormatterConfiguration#lineWidth
807
1090
  */
808
1091
  readonly lineWidth?: number;
809
1092
  /**
810
- * The type of quotes used in CSS code. Defaults to `double`.
1093
+ * Selects the preferred quote style for CSS strings. Biome may use the alternate quote when
1094
+ * that avoids additional escaping. Quotes in `@charset` rules are currently preserved.
1095
+ * Defaults to `double`.
811
1096
  *
812
1097
  * @default double`.
813
1098
  * @schema CssFormatterConfiguration#quoteStyle
@@ -833,7 +1118,7 @@ export declare function toJson_CssFormatterConfiguration(obj: CssFormatterConfig
833
1118
  */
834
1119
  export interface CssLinterConfiguration {
835
1120
  /**
836
- * Controls the linter for CSS files.
1121
+ * Enables or disables the linter for CSS.
837
1122
  *
838
1123
  * @schema CssLinterConfiguration#enabled
839
1124
  */
@@ -851,21 +1136,28 @@ export declare function toJson_CssLinterConfiguration(obj: CssLinterConfiguratio
851
1136
  */
852
1137
  export interface CssParserConfiguration {
853
1138
  /**
854
- * Allows comments to appear on incorrect lines in `.css` files.
1139
+ * Enables `//` line comments in plain CSS. Standard CSS treats `//` as delimiter characters
1140
+ * rather than as a comment, and SCSS accepts `//` comments independently of this option.
1141
+ * Defaults to `false`.
855
1142
  *
1143
+ * @default false`.
856
1144
  * @schema CssParserConfiguration#allowWrongLineComments
857
1145
  */
858
1146
  readonly allowWrongLineComments?: boolean;
859
1147
  /**
860
- * Enables parsing of CSS Modules-specific features. Enable this feature only
861
- * when your files don't end in `.module.css`.
1148
+ * Enables CSS Modules-specific syntax such as `:local`, `:global`, `composes`, and `@value`.
1149
+ * When unset, Biome enables this syntax automatically for files whose names end in
1150
+ * `.module.css` or `.module.scss; otherwise, it defaults to `false`. Enable it explicitly when CSS Module files
1151
+ * use another naming convention.
862
1152
  *
863
1153
  * @schema CssParserConfiguration#cssModules
864
1154
  */
865
1155
  readonly cssModules?: boolean;
866
1156
  /**
867
- * Enables parsing of Tailwind CSS 4.0 directives and functions.
1157
+ * Enables parsing Tailwind CSS 4.0 directives and functions, including `@theme`, `@utility`,
1158
+ * `@variant`, `@source`, and `@apply`. Defaults to `false`.
868
1159
  *
1160
+ * @default false`.
869
1161
  * @schema CssParserConfiguration#tailwindDirectives
870
1162
  */
871
1163
  readonly tailwindDirectives?: boolean;
@@ -876,12 +1168,14 @@ export interface CssParserConfiguration {
876
1168
  */
877
1169
  export declare function toJson_CssParserConfiguration(obj: CssParserConfiguration | undefined): Record<string, any> | undefined;
878
1170
  /**
1171
+ * Controls attribute placement in HTML-like languages.
1172
+ *
879
1173
  * @schema AttributePosition
880
1174
  */
881
1175
  export declare enum AttributePosition {
882
- /** auto */
1176
+ /** Places attributes automatically and wraps them when needed. (auto) */
883
1177
  AUTO = "auto",
884
- /** multiline */
1178
+ /** Places each attribute on its own line when an element has multiple attributes. (multiline) */
885
1179
  MULTILINE = "multiline"
886
1180
  }
887
1181
  /**
@@ -900,9 +1194,9 @@ export declare enum Expand {
900
1194
  * @schema IndentStyle
901
1195
  */
902
1196
  export declare enum IndentStyle {
903
- /** Indent with Tab (tab) */
1197
+ /** Uses tabs for indentation. (tab) */
904
1198
  TAB = "tab",
905
- /** Indent with Space (space) */
1199
+ /** Uses spaces for indentation. (space) */
906
1200
  SPACE = "space"
907
1201
  }
908
1202
  /**
@@ -925,8 +1219,9 @@ export declare enum LineEnding {
925
1219
  */
926
1220
  export interface GraphqlAssistConfiguration {
927
1221
  /**
928
- * Controls assist actions for GraphQL files.
1222
+ * Enables or disables assist actions for GraphQL. Defaults to `false`.
929
1223
  *
1224
+ * @default false`.
930
1225
  * @schema GraphqlAssistConfiguration#enabled
931
1226
  */
932
1227
  readonly enabled?: boolean;
@@ -943,14 +1238,15 @@ export declare function toJson_GraphqlAssistConfiguration(obj: GraphqlAssistConf
943
1238
  */
944
1239
  export interface GraphqlFormatterConfiguration {
945
1240
  /**
946
- * Whether to insert spaces inside braces in object literals. If unset, inherits the global
947
- * bracket spacing setting.
1241
+ * Controls spaces inside the braces of single-line GraphQL object values. Biome formats
1242
+ * `{name: "Biome"}` when disabled and `{ name: "Biome" }` when enabled. If unset, inherits the
1243
+ * global bracket spacing setting.
948
1244
  *
949
1245
  * @schema GraphqlFormatterConfiguration#bracketSpacing
950
1246
  */
951
1247
  readonly bracketSpacing?: boolean;
952
1248
  /**
953
- * Controls the formatter for GraphQL files.
1249
+ * Enables or disables the formatter for GraphQL.
954
1250
  *
955
1251
  * @schema GraphqlFormatterConfiguration#enabled
956
1252
  */
@@ -975,15 +1271,16 @@ export interface GraphqlFormatterConfiguration {
975
1271
  */
976
1272
  readonly lineEnding?: LineEnding;
977
1273
  /**
978
- * The maximum line width for GraphQL files. If unset, inherits the global line width.
1274
+ * The preferred maximum line width for GraphQL files. If unset, inherits the global line
1275
+ * width.
979
1276
  *
980
1277
  * @schema GraphqlFormatterConfiguration#lineWidth
981
1278
  */
982
1279
  readonly lineWidth?: number;
983
1280
  /**
984
- * The type of quotes used in GraphQL code. Defaults to `double`.
1281
+ * Reserved for future formatter support. The current formatter preserves standard
1282
+ * double-quoted GraphQL strings and does not use this setting.
985
1283
  *
986
- * @default double`.
987
1284
  * @schema GraphqlFormatterConfiguration#quoteStyle
988
1285
  */
989
1286
  readonly quoteStyle?: QuoteStyle;
@@ -1007,7 +1304,7 @@ export declare function toJson_GraphqlFormatterConfiguration(obj: GraphqlFormatt
1007
1304
  */
1008
1305
  export interface GraphqlLinterConfiguration {
1009
1306
  /**
1010
- * Controls the linter for GraphQL files.
1307
+ * Enables or disables the linter for GraphQL.
1011
1308
  *
1012
1309
  * @schema GraphqlLinterConfiguration#enabled
1013
1310
  */
@@ -1025,7 +1322,7 @@ export declare function toJson_GraphqlLinterConfiguration(obj: GraphqlLinterConf
1025
1322
  */
1026
1323
  export interface GritAssistConfiguration {
1027
1324
  /**
1028
- * Controls assist actions for GritQL files.
1325
+ * Enables or disables assist actions for GritQL.
1029
1326
  *
1030
1327
  * @schema GritAssistConfiguration#enabled
1031
1328
  */
@@ -1043,7 +1340,7 @@ export declare function toJson_GritAssistConfiguration(obj: GritAssistConfigurat
1043
1340
  */
1044
1341
  export interface GritFormatterConfiguration {
1045
1342
  /**
1046
- * Controls the formatter for GritQL files.
1343
+ * Enables or disables the formatter for GritQL.
1047
1344
  *
1048
1345
  * @schema GritFormatterConfiguration#enabled
1049
1346
  */
@@ -1068,7 +1365,7 @@ export interface GritFormatterConfiguration {
1068
1365
  */
1069
1366
  readonly lineEnding?: LineEnding;
1070
1367
  /**
1071
- * The maximum line width for GritQL files. If unset, inherits the global line width.
1368
+ * The preferred maximum line width for GritQL files. If unset, inherits the global line width.
1072
1369
  *
1073
1370
  * @schema GritFormatterConfiguration#lineWidth
1074
1371
  */
@@ -1093,7 +1390,7 @@ export declare function toJson_GritFormatterConfiguration(obj: GritFormatterConf
1093
1390
  */
1094
1391
  export interface GritLinterConfiguration {
1095
1392
  /**
1096
- * Controls the linter for GritQL files.
1393
+ * Enables or disables the linter for GritQL.
1097
1394
  *
1098
1395
  * @schema GritLinterConfiguration#enabled
1099
1396
  */
@@ -1111,7 +1408,7 @@ export declare function toJson_GritLinterConfiguration(obj: GritLinterConfigurat
1111
1408
  */
1112
1409
  export interface HtmlAssistConfiguration {
1113
1410
  /**
1114
- * Controls assist actions for HTML and languages that extend it.
1411
+ * Enables or disables assist actions for HTML and languages that extend it.
1115
1412
  *
1116
1413
  * @schema HtmlAssistConfiguration#enabled
1117
1414
  */
@@ -1136,21 +1433,25 @@ export interface HtmlFormatterConfiguration {
1136
1433
  */
1137
1434
  readonly attributePosition?: AttributePosition;
1138
1435
  /**
1139
- * Whether to place the closing bracket of a multiline HTML tag at the end of the last line
1140
- * instead of on its own line. If unset, inherits the global `bracketSameLine` setting.
1436
+ * Controls the placement of the closing bracket for multiline HTML opening tags. Biome places
1437
+ * the bracket at the end of the last attribute line when enabled and on its own line after the
1438
+ * last attribute when disabled. This option also affects self-closing HTML elements. If unset,
1439
+ * inherits the global `bracketSameLine` setting.
1141
1440
  *
1142
1441
  * @schema HtmlFormatterConfiguration#bracketSameLine
1143
1442
  */
1144
1443
  readonly bracketSameLine?: boolean;
1145
1444
  /**
1146
- * Controls the formatter for HTML and languages that extend it.
1445
+ * Enables or disables the formatter for HTML and languages that extend it. The formatter is
1446
+ * experimental and disabled by default. Formatting complete HTML, Vue, Svelte, and Astro files
1447
+ * requires `html.experimentalFullSupportEnabled` to be `true`.
1147
1448
  *
1148
1449
  * @schema HtmlFormatterConfiguration#enabled
1149
1450
  */
1150
1451
  readonly enabled?: boolean;
1151
1452
  /**
1152
- * Whether to indent `<script>` and `<style>` tags in HTML and languages that extend it.
1153
- * Defaults to `false`.
1453
+ * Controls whether the content of `<script>` and `<style>` tags is indented by one level in
1454
+ * HTML, Vue, Svelte, and Astro files. Defaults to `false`.
1154
1455
  *
1155
1456
  * @default false`.
1156
1457
  * @schema HtmlFormatterConfiguration#indentScriptAndStyle
@@ -1178,8 +1479,8 @@ export interface HtmlFormatterConfiguration {
1178
1479
  */
1179
1480
  readonly lineEnding?: LineEnding;
1180
1481
  /**
1181
- * The maximum line width for HTML and languages that extend it. If unset, inherits the global
1182
- * line width.
1482
+ * The preferred maximum line width for HTML and languages that extend it. If unset, inherits
1483
+ * the global line width.
1183
1484
  *
1184
1485
  * @schema HtmlFormatterConfiguration#lineWidth
1185
1486
  */
@@ -1200,8 +1501,9 @@ export interface HtmlFormatterConfiguration {
1200
1501
  */
1201
1502
  readonly trailingNewline?: boolean;
1202
1503
  /**
1203
- * Whether to account for whitespace sensitivity when formatting HTML and languages that
1204
- * extend it. Defaults to `css`.
1504
+ * Controls how the formatter treats whitespace around text and child elements in HTML, Vue,
1505
+ * Svelte, and Astro markup. The `ignore` setting should be used only when whitespace cannot
1506
+ * affect rendered output. Defaults to `css`.
1205
1507
  *
1206
1508
  * @default css`.
1207
1509
  * @schema HtmlFormatterConfiguration#whitespaceSensitivity
@@ -1220,7 +1522,7 @@ export declare function toJson_HtmlFormatterConfiguration(obj: HtmlFormatterConf
1220
1522
  */
1221
1523
  export interface HtmlLinterConfiguration {
1222
1524
  /**
1223
- * Controls the linter for HTML and languages that extend it.
1525
+ * Enables or disables the linter for HTML and languages that extend it.
1224
1526
  *
1225
1527
  * @schema HtmlLinterConfiguration#enabled
1226
1528
  */
@@ -1238,8 +1540,10 @@ export declare function toJson_HtmlLinterConfiguration(obj: HtmlLinterConfigurat
1238
1540
  */
1239
1541
  export interface HtmlParserConfiguration {
1240
1542
  /**
1241
- * Enables parsing double text expressions such as `{{ expression }}` inside `.html` files.
1543
+ * Enables double-curly interpolation expressions such as `{{ expression }}` in `.html` files.
1544
+ * Defaults to `false`.
1242
1545
  *
1546
+ * @default false`.
1243
1547
  * @schema HtmlParserConfiguration#interpolation
1244
1548
  */
1245
1549
  readonly interpolation?: boolean;
@@ -1249,8 +1553,9 @@ export interface HtmlParserConfiguration {
1249
1553
  *
1250
1554
  * Biome will already automatically enable Vue parsing in `.vue` files, so you probably don't need
1251
1555
  * to enable this option. This only affects `.html` files, and does not change how `.vue`, `.svelte`,
1252
- * or `.astro` files are parsed.
1556
+ * or `.astro` files are parsed. Defaults to `false`.
1253
1557
  *
1558
+ * @default false`.
1254
1559
  * @schema HtmlParserConfiguration#vue
1255
1560
  */
1256
1561
  readonly vue?: boolean;
@@ -1267,7 +1572,7 @@ export declare function toJson_HtmlParserConfiguration(obj: HtmlParserConfigurat
1267
1572
  */
1268
1573
  export interface JsAssistConfiguration {
1269
1574
  /**
1270
- * Controls assist actions for JavaScript and languages that extend it.
1575
+ * Enables or disables assist actions for JavaScript and languages that extend it.
1271
1576
  *
1272
1577
  * @schema JsAssistConfiguration#enabled
1273
1578
  */
@@ -1279,13 +1584,15 @@ export interface JsAssistConfiguration {
1279
1584
  */
1280
1585
  export declare function toJson_JsAssistConfiguration(obj: JsAssistConfiguration | undefined): Record<string, any> | undefined;
1281
1586
  /**
1282
- * Formatting options specific to the JavaScript files
1587
+ * Formatting options specific to JavaScript and languages that extend it.
1283
1588
  *
1284
1589
  * @schema JsFormatterConfiguration
1285
1590
  */
1286
1591
  export interface JsFormatterConfiguration {
1287
1592
  /**
1288
- * Whether to add parentheses around arrow function parameters. Defaults to `always`.
1593
+ * Controls parentheses around arrow-function parameters. `always` always prints parentheses,
1594
+ * while `asNeeded` omits them when an arrow function has one parameter and the syntax permits
1595
+ * it. Defaults to `always`.
1289
1596
  *
1290
1597
  * @default always`.
1291
1598
  * @schema JsFormatterConfiguration#arrowParentheses
@@ -1299,28 +1606,31 @@ export interface JsFormatterConfiguration {
1299
1606
  */
1300
1607
  readonly attributePosition?: AttributePosition;
1301
1608
  /**
1302
- * Whether to hug the closing bracket of multiline HTML/JSX tags to the end of the last line,
1303
- * rather than being alone on the following line. If unset, inherits the global bracket
1304
- * placement setting.
1609
+ * Controls the placement of the closing bracket for multiline JSX opening tags. Biome places
1610
+ * the bracket at the end of the last attribute line when enabled and on its own line after the
1611
+ * last attribute when disabled. Self-closing JSX elements are unaffected. If unset, inherits
1612
+ * the global bracket placement setting.
1305
1613
  *
1306
1614
  * @schema JsFormatterConfiguration#bracketSameLine
1307
1615
  */
1308
1616
  readonly bracketSameLine?: boolean;
1309
1617
  /**
1310
- * Whether to insert spaces inside braces in object literals. If unset, inherits the global
1311
- * bracket spacing setting.
1618
+ * Controls spaces inside the braces of single-line object literals. Biome formats `{value: 1}`
1619
+ * when disabled and `{ value: 1 }` when enabled. If unset, inherits the global bracket spacing
1620
+ * setting.
1312
1621
  *
1313
1622
  * @schema JsFormatterConfiguration#bracketSpacing
1314
1623
  */
1315
1624
  readonly bracketSpacing?: boolean;
1316
1625
  /**
1317
1626
  * Controls spaces immediately inside supported JavaScript and TypeScript delimiters when their
1318
- * content fits on one line. It doesn't add spaces before opening delimiters or inside empty
1319
- * delimiters.
1627
+ * content fits on one line. This affects parentheses, square brackets, template
1628
+ * interpolations, TypeScript angle brackets, and JSX expression braces. Empty delimiters are
1629
+ * unchanged.
1320
1630
  *
1321
- * It affects parentheses, square brackets, template interpolations, TypeScript angle brackets,
1322
- * JSX expression braces, and logical NOT. In operator chains, only the final operator receives
1323
- * a following space.
1631
+ * It also controls spacing after logical NOT operators. In a chain of logical NOT operators,
1632
+ * only the final operator receives a following space. Biome doesn't add spaces before opening
1633
+ * delimiters.
1324
1634
  *
1325
1635
  * If unset, inherits the global delimiter spacing setting.
1326
1636
  *
@@ -1328,7 +1638,7 @@ export interface JsFormatterConfiguration {
1328
1638
  */
1329
1639
  readonly delimiterSpacing?: boolean;
1330
1640
  /**
1331
- * Controls the formatter for JavaScript and languages that extend it.
1641
+ * Enables or disables the formatter for JavaScript and languages that extend it.
1332
1642
  *
1333
1643
  * @schema JsFormatterConfiguration#enabled
1334
1644
  */
@@ -1356,7 +1666,7 @@ export interface JsFormatterConfiguration {
1356
1666
  */
1357
1667
  readonly indentWidth?: number;
1358
1668
  /**
1359
- * The type of quotes used in JSX. Defaults to `double`.
1669
+ * Selects the preferred quote style for JSX attribute values. Defaults to `double`.
1360
1670
  *
1361
1671
  * @default double`.
1362
1672
  * @schema JsFormatterConfiguration#jsxQuoteStyle
@@ -1370,8 +1680,8 @@ export interface JsFormatterConfiguration {
1370
1680
  */
1371
1681
  readonly lineEnding?: LineEnding;
1372
1682
  /**
1373
- * The maximum line width applied to JavaScript and languages that extend it. If unset,
1374
- * inherits the global line width.
1683
+ * The preferred maximum line width applied to JavaScript and languages that extend it. If
1684
+ * unset, inherits the global line width.
1375
1685
  *
1376
1686
  * @schema JsFormatterConfiguration#lineWidth
1377
1687
  */
@@ -1385,7 +1695,9 @@ export interface JsFormatterConfiguration {
1385
1695
  */
1386
1696
  readonly operatorLinebreak?: OperatorLinebreak;
1387
1697
  /**
1388
- * Controls when object properties are quoted. Defaults to `asNeeded` in configuration
1698
+ * Controls whether quotes around object property names are preserved. `asNeeded` removes
1699
+ * quotes when the property name is valid without them, while `preserve` keeps quotes around
1700
+ * property names that were quoted in the input. Defaults to `asNeeded` in configuration
1389
1701
  * (`as-needed` on the CLI).
1390
1702
  *
1391
1703
  * @default asNeeded` in configuration
@@ -1393,7 +1705,8 @@ export interface JsFormatterConfiguration {
1393
1705
  */
1394
1706
  readonly quoteProperties?: QuoteProperties;
1395
1707
  /**
1396
- * The type of quotes used in JavaScript code. Defaults to `double`.
1708
+ * Selects the preferred quote style for JavaScript and TypeScript string literals. Biome may
1709
+ * use the alternate quote when that avoids additional escaping. Defaults to `double`.
1397
1710
  *
1398
1711
  * @default double`.
1399
1712
  * @schema JsFormatterConfiguration#quoteStyle
@@ -1408,8 +1721,11 @@ export interface JsFormatterConfiguration {
1408
1721
  */
1409
1722
  readonly semicolons?: Semicolons;
1410
1723
  /**
1411
- * Prints trailing commas wherever possible in multiline comma-separated structures. Defaults
1412
- * to `all`.
1724
+ * Controls trailing commas in multiline comma-separated structures. `all` adds trailing commas
1725
+ * wherever syntax permits, including function parameters and calls. `es5` adds them only in
1726
+ * constructs supported by ES5, such as array and object literals, and excludes function
1727
+ * parameters, function calls, and TypeScript type parameters. `none` removes trailing commas.
1728
+ * Defaults to `all`.
1413
1729
  *
1414
1730
  * @default all`.
1415
1731
  * @schema JsFormatterConfiguration#trailingCommas
@@ -1429,15 +1745,15 @@ export interface JsFormatterConfiguration {
1429
1745
  */
1430
1746
  export declare function toJson_JsFormatterConfiguration(obj: JsFormatterConfiguration | undefined): Record<string, any> | undefined;
1431
1747
  /**
1432
- * Indicates the type of runtime or transformation used for interpreting JSX.
1748
+ * How Biome's analyzer accounts for imports used by JSX.
1433
1749
  *
1434
1750
  * @schema JsxRuntime
1435
1751
  */
1436
1752
  export declare enum JsxRuntime {
1437
- /** Indicates a modern or native JSX environment, that doesn't require
1438
- special handling by Biome. (transparent) */
1753
+ /** An automatic or native JSX environment that doesn't require an in-scope factory import. (transparent) */
1439
1754
  TRANSPARENT = "transparent",
1440
- /** Indicates a classic React environment that requires the `React` import.
1755
+ /** A classic React environment that requires the React import, or custom JSX factory imports
1756
+ configured in `tsconfig.json`.
1441
1757
 
1442
1758
  Corresponds to the `react` value for the `jsx` option in TypeScript's
1443
1759
  `tsconfig.json`.
@@ -1455,7 +1771,7 @@ export declare enum JsxRuntime {
1455
1771
  */
1456
1772
  export interface JsLinterConfiguration {
1457
1773
  /**
1458
- * Controls the linter for JavaScript and languages that extend it.
1774
+ * Enables or disables the linter for JavaScript and languages that extend it.
1459
1775
  *
1460
1776
  * @schema JsLinterConfiguration#enabled
1461
1777
  */
@@ -1473,26 +1789,18 @@ export declare function toJson_JsLinterConfiguration(obj: JsLinterConfiguration
1473
1789
  */
1474
1790
  export interface JsParserConfiguration {
1475
1791
  /**
1476
- * Enables parsing of Grit metavariables.
1477
- * Defaults to `false`.
1478
- *
1479
- * @default false`.
1480
- * @schema JsParserConfiguration#gritMetavariables
1481
- */
1482
- readonly gritMetavariables?: boolean;
1483
- /**
1484
- * When enabled, files such as `.js`, `.mjs`, and `.cjs` may contain JSX syntax. Defaults to
1485
- * `true`.
1792
+ * Controls whether `.js`, `.mjs`, and `.cjs` files may contain JSX syntax. Disabling this
1793
+ * option causes JSX in those files to raise a diagnostic. Defaults to `true`.
1486
1794
  *
1487
1795
  * @default true`.
1488
1796
  * @schema JsParserConfiguration#jsxEverywhere
1489
1797
  */
1490
1798
  readonly jsxEverywhere?: boolean;
1491
1799
  /**
1492
- * It enables the experimental and unsafe parsing of parameter decorators
1493
- *
1494
- * These decorators belong to an old proposal, and they are subject to change.
1800
+ * Enables parsing decorators on class parameters. This syntax belongs to an old experimental
1801
+ * proposal and may change. Defaults to `false`.
1495
1802
  *
1803
+ * @default false`.
1496
1804
  * @schema JsParserConfiguration#unsafeParameterDecoratorsEnabled
1497
1805
  */
1498
1806
  readonly unsafeParameterDecoratorsEnabled?: boolean;
@@ -1550,7 +1858,7 @@ export declare function toJson_JsResolverConfiguration(obj: JsResolverConfigurat
1550
1858
  */
1551
1859
  export interface JsonAssistConfiguration {
1552
1860
  /**
1553
- * Controls assist actions for JSON and languages that extend it.
1861
+ * Enables or disables assist actions for JSON and languages that extend it.
1554
1862
  *
1555
1863
  * @schema JsonAssistConfiguration#enabled
1556
1864
  */
@@ -1582,7 +1890,7 @@ export interface JsonFormatterConfiguration {
1582
1890
  */
1583
1891
  readonly delimiterSpacing?: boolean;
1584
1892
  /**
1585
- * Controls the formatter for JSON and languages that extend it.
1893
+ * Enables or disables the formatter for JSON and languages that extend it.
1586
1894
  *
1587
1895
  * @schema JsonFormatterConfiguration#enabled
1588
1896
  */
@@ -1619,15 +1927,17 @@ export interface JsonFormatterConfiguration {
1619
1927
  */
1620
1928
  readonly lineEnding?: LineEnding;
1621
1929
  /**
1622
- * The maximum line width applied to JSON and languages that extend it. If unset, inherits the
1623
- * global line width.
1930
+ * The preferred maximum line width applied to JSON and languages that extend it. If unset,
1931
+ * inherits the global line width.
1624
1932
  *
1625
1933
  * @schema JsonFormatterConfiguration#lineWidth
1626
1934
  */
1627
1935
  readonly lineWidth?: number;
1628
1936
  /**
1629
- * Prints trailing commas wherever possible in multiline comma-separated structures. Defaults
1630
- * to `none`.
1937
+ * Controls trailing commas in multiline JSON arrays and objects. `none` removes trailing
1938
+ * commas, while `all` adds them wherever the JSON formatter supports them. Use `all` only for
1939
+ * JSON variants that allow trailing commas, and ensure `json.parser.allowTrailingCommas` is
1940
+ * enabled or automatically detected for those files. Defaults to `none`.
1631
1941
  *
1632
1942
  * @default none`.
1633
1943
  * @schema JsonFormatterConfiguration#trailingCommas
@@ -1653,7 +1963,7 @@ export declare function toJson_JsonFormatterConfiguration(obj: JsonFormatterConf
1653
1963
  */
1654
1964
  export interface JsonLinterConfiguration {
1655
1965
  /**
1656
- * Controls the linter for JSON and languages that extend it.
1966
+ * Enables or disables the linter for JSON and languages that extend it.
1657
1967
  *
1658
1968
  * @schema JsonLinterConfiguration#enabled
1659
1969
  */
@@ -1671,13 +1981,17 @@ export declare function toJson_JsonLinterConfiguration(obj: JsonLinterConfigurat
1671
1981
  */
1672
1982
  export interface JsonParserConfiguration {
1673
1983
  /**
1674
- * Allows parsing comments in `.json` files.
1984
+ * Controls whether comments are allowed in files parsed as JSON. When unset, Biome follows the
1985
+ * file type's default behavior. An explicit value overrides that behavior, except that
1986
+ * `biome.jsonc` always allows comments.
1675
1987
  *
1676
1988
  * @schema JsonParserConfiguration#allowComments
1677
1989
  */
1678
1990
  readonly allowComments?: boolean;
1679
1991
  /**
1680
- * Allows parsing trailing commas in `.json` files.
1992
+ * Controls whether trailing commas are allowed in files parsed as JSON. When unset, Biome
1993
+ * follows the file type's default behavior. An explicit value overrides that behavior, except
1994
+ * that `biome.jsonc` always allows trailing commas.
1681
1995
  *
1682
1996
  * @schema JsonParserConfiguration#allowTrailingCommas
1683
1997
  */
@@ -1783,14 +2097,22 @@ export interface Rules {
1783
2097
  */
1784
2098
  readonly performance?: any;
1785
2099
  /**
1786
- * The rule presets to use.
2100
+ * Selects the baseline set of lint rules. `recommended` enables Biome's recommended
2101
+ * non-nursery rules, `all` enables all non-nursery rules, and `none` starts with no
2102
+ * rules enabled. Group-level settings and explicit rule settings override this
2103
+ * preset. Defaults to `recommended`.
1787
2104
  *
2105
+ * @default recommended`.
1788
2106
  * @schema Rules#preset
1789
2107
  */
1790
2108
  readonly preset?: PresetConfig;
1791
2109
  /**
1792
- * It enables the lint rules recommended by Biome. `true` by default.
2110
+ * Enables or disables Biome's recommended non-nursery rules. Defaults to `true`.
1793
2111
  *
2112
+ * **Deprecated:** This option will be removed in the next major version. Use
2113
+ * `linter.rules.preset` instead, or run `biome migrate` to update the configuration.
2114
+ *
2115
+ * @default true`.
1794
2116
  * @schema Rules#recommended
1795
2117
  */
1796
2118
  readonly recommended?: boolean;
@@ -1812,18 +2134,171 @@ export interface Rules {
1812
2134
  * @internal
1813
2135
  */
1814
2136
  export declare function toJson_Rules(obj: Rules | undefined): Record<string, any> | undefined;
2137
+ /**
2138
+ * Options that change how the Markdown formatter behaves
2139
+ *
2140
+ * @schema MarkdownFormatterConfiguration
2141
+ */
2142
+ export interface MarkdownFormatterConfiguration {
2143
+ /**
2144
+ * Control the formatter for Markdown (and its super languages) files.
2145
+ *
2146
+ * @schema MarkdownFormatterConfiguration#enabled
2147
+ */
2148
+ readonly enabled?: boolean;
2149
+ /**
2150
+ * Formats the code inside fenced code blocks, frontmatter, and HTML blocks with the formatter
2151
+ * of the code's language. Defaults to `true`.
2152
+ *
2153
+ * A block with a syntax error stays as written, and Biome still formats the rest of the file.
2154
+ *
2155
+ * When this option is `false`, Biome keeps every block as written.
2156
+ *
2157
+ * @default true`.
2158
+ * @schema MarkdownFormatterConfiguration#formatEmbeds
2159
+ */
2160
+ readonly formatEmbeds?: boolean;
2161
+ /**
2162
+ * The indent style applied to Markdown files.
2163
+ *
2164
+ * @schema MarkdownFormatterConfiguration#indentStyle
2165
+ */
2166
+ readonly indentStyle?: IndentStyle;
2167
+ /**
2168
+ * The size of the indentation applied to Markdown files. Defaults to 2.
2169
+ *
2170
+ * @default 2.
2171
+ * @schema MarkdownFormatterConfiguration#indentWidth
2172
+ */
2173
+ readonly indentWidth?: number;
2174
+ /**
2175
+ * The type of line ending applied to Markdown (and its super languages) files. `auto` uses CRLF on Windows and LF on other platforms.
2176
+ *
2177
+ * @schema MarkdownFormatterConfiguration#lineEnding
2178
+ */
2179
+ readonly lineEnding?: LineEnding;
2180
+ /**
2181
+ * What's the max width of a line applied to Markdown files. Defaults to 80.
2182
+ *
2183
+ * @default 80.
2184
+ * @schema MarkdownFormatterConfiguration#lineWidth
2185
+ */
2186
+ readonly lineWidth?: number;
2187
+ /**
2188
+ * Controls whether Biome keeps, adds, or removes line breaks in Markdown paragraphs.
2189
+ *
2190
+ * Manual line breaks are always kept. In Markdown, a manual line break is created by ending a
2191
+ * line with two spaces or a backslash.
2192
+ *
2193
+ * @schema MarkdownFormatterConfiguration#proseWrap
2194
+ */
2195
+ readonly proseWrap?: ProseWrap;
2196
+ /**
2197
+ * Whether to add a trailing newline at the end of the file.
2198
+ *
2199
+ * Setting this option to `false` is **highly discouraged** because it could cause many problems with other tools:
2200
+ * - https://thoughtbot.com/blog/no-newline-at-end-of-file
2201
+ * - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
2202
+ * - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
2203
+ *
2204
+ * Disable the option at your own risk.
2205
+ *
2206
+ * Defaults to true.
2207
+ *
2208
+ * @default true.
2209
+ * @schema MarkdownFormatterConfiguration#trailingNewline
2210
+ */
2211
+ readonly trailingNewline?: boolean;
2212
+ }
2213
+ /**
2214
+ * Converts an object of type 'MarkdownFormatterConfiguration' to JSON representation.
2215
+ * @internal
2216
+ */
2217
+ export declare function toJson_MarkdownFormatterConfiguration(obj: MarkdownFormatterConfiguration | undefined): Record<string, any> | undefined;
2218
+ /**
2219
+ * Options that change how the Markdown linter behaves
2220
+ *
2221
+ * @schema MarkdownLinterConfiguration
2222
+ */
2223
+ export interface MarkdownLinterConfiguration {
2224
+ /**
2225
+ * Control the linter for Markdown files.
2226
+ *
2227
+ * @schema MarkdownLinterConfiguration#enabled
2228
+ */
2229
+ readonly enabled?: boolean;
2230
+ }
2231
+ /**
2232
+ * Converts an object of type 'MarkdownLinterConfiguration' to JSON representation.
2233
+ * @internal
2234
+ */
2235
+ export declare function toJson_MarkdownLinterConfiguration(obj: MarkdownLinterConfiguration | undefined): Record<string, any> | undefined;
2236
+ /**
2237
+ * Options that change how the Markdown parser behaves
2238
+ *
2239
+ * @schema MarkdownParserConfiguration
2240
+ */
2241
+ export interface MarkdownParserConfiguration {
2242
+ /**
2243
+ * Recognizes bold, italic, and strikethrough markers placed directly next to Chinese, Japanese, or Korean text. Defaults to `false`.
2244
+ *
2245
+ * Standard Markdown doesn't treat `**テスト。**テスト` as bold text, because the closing `**`
2246
+ * is between a punctuation mark and a letter with no space around it. Languages that don't
2247
+ * put spaces between words run into this often. When enabled, Biome follows the
2248
+ * [CommonMark CJK-friendly amendments](https://github.com/tats-u/markdown-cjk-friendly/blob/main/specification.md)
2249
+ * and treats such text as bold or italic. The option applies to `*`, `_`, and `~~` markers.
2250
+ * After a variation selector (an invisible character that picks a glyph style for the
2251
+ * character before it), Biome classifies a marker by the character before the selector.
2252
+ *
2253
+ * The option can also change markers that aren't next to Chinese, Japanese, or Korean text,
2254
+ * because a marker that can now open or close formatting can take another marker's partner
2255
+ * in the same paragraph, heading, or table cell. For example, standard Markdown shows
2256
+ * `**テスト。**テスト a**` with `テスト a` in bold. With the option enabled, `テスト。` is bold
2257
+ * and the last `**` is shown as written.
2258
+ *
2259
+ * The formatter and the linter both use this reading of the document. Enable the option only
2260
+ * when the tool that renders your Markdown also supports these amendments. Otherwise, Biome
2261
+ * treats as bold some text that your renderer shows with literal `**`, and formatting can
2262
+ * change what your renderer shows. For example, the option makes `__` after a variation
2263
+ * selector a bold marker, and the formatter rewrites it as `**`, which standard Markdown
2264
+ * shows as bold even where it showed the original `__` as written.
2265
+ *
2266
+ * @default false`.
2267
+ * @schema MarkdownParserConfiguration#cjkFriendlyEmphasis
2268
+ */
2269
+ readonly cjkFriendlyEmphasis?: boolean;
2270
+ /**
2271
+ * Enables parsing frontmatter at the start of the file. Defaults to `false`.
2272
+ *
2273
+ * @default false`.
2274
+ * @schema MarkdownParserConfiguration#frontmatter
2275
+ */
2276
+ readonly frontmatter?: boolean;
2277
+ /**
2278
+ * Enables GitHub Flavored Markdown extensions. Defaults to `true`.
2279
+ *
2280
+ * @default true`.
2281
+ * @schema MarkdownParserConfiguration#gfm
2282
+ */
2283
+ readonly gfm?: boolean;
2284
+ }
2285
+ /**
2286
+ * Converts an object of type 'MarkdownParserConfiguration' to JSON representation.
2287
+ * @internal
2288
+ */
2289
+ export declare function toJson_MarkdownParserConfiguration(obj: MarkdownParserConfiguration | undefined): Record<string, any> | undefined;
1815
2290
  /**
1816
2291
  * @schema OverrideAssistConfiguration
1817
2292
  */
1818
2293
  export interface OverrideAssistConfiguration {
1819
2294
  /**
1820
- * List of actions
2295
+ * The assist-action configuration for matched files.
1821
2296
  *
1822
2297
  * @schema OverrideAssistConfiguration#actions
1823
2298
  */
1824
2299
  readonly actions?: Actions;
1825
2300
  /**
1826
- * if `false`, it disables the feature and the assist won't be executed. `true` by default
2301
+ * Enables or disables assist actions for matched files.
1827
2302
  *
1828
2303
  * @schema OverrideAssistConfiguration#enabled
1829
2304
  */
@@ -1839,7 +2314,7 @@ export declare function toJson_OverrideAssistConfiguration(obj: OverrideAssistCo
1839
2314
  */
1840
2315
  export interface OverrideFilesConfiguration {
1841
2316
  /**
1842
- * File size limit in bytes
2317
+ * The maximum source-file size in bytes for matched files.
1843
2318
  *
1844
2319
  * @schema OverrideFilesConfiguration#maxSize
1845
2320
  */
@@ -1855,21 +2330,24 @@ export declare function toJson_OverrideFilesConfiguration(obj: OverrideFilesConf
1855
2330
  */
1856
2331
  export interface OverrideFormatterConfiguration {
1857
2332
  /**
1858
- * The attribute position style.
2333
+ * The attribute position style in HTML-like languages.
1859
2334
  *
1860
2335
  * @schema OverrideFormatterConfiguration#attributePosition
1861
2336
  */
1862
2337
  readonly attributePosition?: AttributePosition;
1863
2338
  /**
1864
- * Put the `>` of a multi-line HTML or JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).
2339
+ * Controls the placement of the closing bracket for multiline HTML and JSX opening tags. Biome
2340
+ * places the bracket at the end of the last attribute line when enabled and on its own line when
2341
+ * disabled. This also affects self-closing HTML elements, but self-closing JSX elements are
2342
+ * unaffected.
1865
2343
  *
1866
2344
  * @schema OverrideFormatterConfiguration#bracketSameLine
1867
2345
  */
1868
2346
  readonly bracketSameLine?: boolean;
1869
2347
  /**
1870
- * Whether to insert spaces around brackets in object literals. Defaults to true.
2348
+ * Controls spaces inside braces in supported single-line structures. The affected structures
2349
+ * vary by language.
1871
2350
  *
1872
- * @default true.
1873
2351
  * @schema OverrideFormatterConfiguration#bracketSpacing
1874
2352
  */
1875
2353
  readonly bracketSpacing?: boolean;
@@ -1883,6 +2361,8 @@ export interface OverrideFormatterConfiguration {
1883
2361
  */
1884
2362
  readonly delimiterSpacing?: boolean;
1885
2363
  /**
2364
+ * Enables or disables the formatter for matched files.
2365
+ *
1886
2366
  * @schema OverrideFormatterConfiguration#enabled
1887
2367
  */
1888
2368
  readonly enabled?: boolean;
@@ -1904,62 +2384,56 @@ export interface OverrideFormatterConfiguration {
1904
2384
  */
1905
2385
  readonly expand?: Expand;
1906
2386
  /**
1907
- * Stores whether formatting should be allowed to proceed if a given file
1908
- * has syntax errors
2387
+ * Allows formatting matched files that contain syntax errors.
1909
2388
  *
1910
2389
  * @schema OverrideFormatterConfiguration#formatWithErrors
1911
2390
  */
1912
2391
  readonly formatWithErrors?: boolean;
1913
2392
  /**
1914
- * The size of the indentation, 2 by default (deprecated, use `indent-width`)
2393
+ * The indentation width. Deprecated, use `indentWidth` instead.
1915
2394
  *
1916
2395
  * @schema OverrideFormatterConfiguration#indentSize
1917
2396
  */
1918
2397
  readonly indentSize?: number;
1919
2398
  /**
1920
- * The indent style.
2399
+ * Uses tabs or spaces for indentation.
1921
2400
  *
1922
2401
  * @schema OverrideFormatterConfiguration#indentStyle
1923
2402
  */
1924
2403
  readonly indentStyle?: IndentStyle;
1925
2404
  /**
1926
- * The size of the indentation, 2 by default
2405
+ * Sets the indentation width. With space indentation, this is the number of spaces emitted per
2406
+ * indentation level. With tab indentation, Biome emits one tab per level and uses this value as
2407
+ * the tab's display width when calculating line length. Accepted values are `0` through `24`.
1927
2408
  *
1928
2409
  * @schema OverrideFormatterConfiguration#indentWidth
1929
2410
  */
1930
2411
  readonly indentWidth?: number;
1931
2412
  /**
1932
- * The type of line ending.
2413
+ * The line ending.
1933
2414
  *
1934
2415
  * @schema OverrideFormatterConfiguration#lineEnding
1935
2416
  */
1936
2417
  readonly lineEnding?: LineEnding;
1937
2418
  /**
1938
- * What's the max width of a line. Defaults to 80.
2419
+ * Sets the preferred maximum line width used when deciding where to wrap code. Some content,
2420
+ * such as long unbreakable strings, may still exceed this width. Accepted values are `1` through
2421
+ * `320`.
1939
2422
  *
1940
- * @default 80.
1941
2423
  * @schema OverrideFormatterConfiguration#lineWidth
1942
2424
  */
1943
2425
  readonly lineWidth?: number;
1944
2426
  /**
1945
- * Print trailing commas wherever possible in multi-line comma-separated syntactic structures.
2427
+ * Prints trailing commas wherever possible in multiline comma-separated structures. This is a
2428
+ * legacy override option. Prefer `javascript.formatter.trailingCommas`.
1946
2429
  *
1947
2430
  * @schema OverrideFormatterConfiguration#trailingCommas
1948
2431
  */
1949
2432
  readonly trailingCommas?: JsTrailingCommas;
1950
2433
  /**
1951
- * Whether to add a trailing newline at the end of the file.
2434
+ * Whether to add a trailing newline at the end of matched files. Disabling this option can
2435
+ * cause compatibility problems with other tools.
1952
2436
  *
1953
- * Setting this option to `false` is **highly discouraged** because it could cause many problems with other tools:
1954
- * - https://thoughtbot.com/blog/no-newline-at-end-of-file
1955
- * - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
1956
- * - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
1957
- *
1958
- * Disable the option at your own risk.
1959
- *
1960
- * Defaults to true.
1961
- *
1962
- * @default true.
1963
2437
  * @schema OverrideFormatterConfiguration#trailingNewline
1964
2438
  */
1965
2439
  readonly trailingNewline?: boolean;
@@ -1974,19 +2448,19 @@ export declare function toJson_OverrideFormatterConfiguration(obj: OverrideForma
1974
2448
  */
1975
2449
  export interface OverrideLinterConfiguration {
1976
2450
  /**
1977
- * List of rules
2451
+ * The lint-domain configuration for matched files.
1978
2452
  *
1979
2453
  * @schema OverrideLinterConfiguration#domains
1980
2454
  */
1981
2455
  readonly domains?: RuleDomains;
1982
2456
  /**
1983
- * if `false`, it disables the feature and the linter won't be executed. `true` by default
2457
+ * Enables or disables the linter for matched files.
1984
2458
  *
1985
2459
  * @schema OverrideLinterConfiguration#enabled
1986
2460
  */
1987
2461
  readonly enabled?: boolean;
1988
2462
  /**
1989
- * List of rules
2463
+ * The lint-rule configuration for matched files.
1990
2464
  *
1991
2465
  * @schema OverrideLinterConfiguration#rules
1992
2466
  */
@@ -2006,6 +2480,94 @@ export declare enum VcsClientKind {
2006
2480
  /** git */
2007
2481
  GIT = "git"
2008
2482
  }
2483
+ /**
2484
+ * Options that change how the Yaml formatter behaves
2485
+ *
2486
+ * @schema YamlFormatterConfiguration
2487
+ */
2488
+ export interface YamlFormatterConfiguration {
2489
+ /**
2490
+ * Whether to insert spaces inside non-empty flow mappings (`{ key: value }`)
2491
+ * and sequences (`[ item ]`) that fit on one line. If unset, inherits the
2492
+ * global bracket spacing setting. When neither is set, mappings have spaces
2493
+ * and sequences do not.
2494
+ *
2495
+ * @schema YamlFormatterConfiguration#bracketSpacing
2496
+ */
2497
+ readonly bracketSpacing?: boolean;
2498
+ /**
2499
+ * Control the formatter for Yaml (and its super languages) files.
2500
+ *
2501
+ * @schema YamlFormatterConfiguration#enabled
2502
+ */
2503
+ readonly enabled?: boolean;
2504
+ /**
2505
+ * The size of the indentation applied to Yaml files. Defaults to 2.
2506
+ *
2507
+ * @default 2.
2508
+ * @schema YamlFormatterConfiguration#indentWidth
2509
+ */
2510
+ readonly indentWidth?: number;
2511
+ /**
2512
+ * The type of line ending applied to Yaml (and its super languages) files. `auto` uses CRLF on Windows and LF on other platforms.
2513
+ *
2514
+ * @schema YamlFormatterConfiguration#lineEnding
2515
+ */
2516
+ readonly lineEnding?: LineEnding;
2517
+ /**
2518
+ * What's the max width of a line applied to Yaml files. Defaults to 80.
2519
+ *
2520
+ * @default 80.
2521
+ * @schema YamlFormatterConfiguration#lineWidth
2522
+ */
2523
+ readonly lineWidth?: number;
2524
+ /**
2525
+ * The type of quotes used in YAML code. Defaults to `double`.
2526
+ *
2527
+ * @default double`.
2528
+ * @schema YamlFormatterConfiguration#quoteStyle
2529
+ */
2530
+ readonly quoteStyle?: QuoteStyle;
2531
+ /**
2532
+ * Whether to add a trailing newline at the end of the file.
2533
+ *
2534
+ * Setting this option to `false` is **highly discouraged** because it could cause many problems with other tools:
2535
+ * - https://thoughtbot.com/blog/no-newline-at-end-of-file
2536
+ * - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
2537
+ * - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
2538
+ *
2539
+ * Disable the option at your own risk.
2540
+ *
2541
+ * Defaults to true.
2542
+ *
2543
+ * @default true.
2544
+ * @schema YamlFormatterConfiguration#trailingNewline
2545
+ */
2546
+ readonly trailingNewline?: boolean;
2547
+ }
2548
+ /**
2549
+ * Converts an object of type 'YamlFormatterConfiguration' to JSON representation.
2550
+ * @internal
2551
+ */
2552
+ export declare function toJson_YamlFormatterConfiguration(obj: YamlFormatterConfiguration | undefined): Record<string, any> | undefined;
2553
+ /**
2554
+ * Options that change how the Yaml linter behaves
2555
+ *
2556
+ * @schema YamlLinterConfiguration
2557
+ */
2558
+ export interface YamlLinterConfiguration {
2559
+ /**
2560
+ * Control the linter for Yaml files.
2561
+ *
2562
+ * @schema YamlLinterConfiguration#enabled
2563
+ */
2564
+ readonly enabled?: boolean;
2565
+ }
2566
+ /**
2567
+ * Converts an object of type 'YamlLinterConfiguration' to JSON representation.
2568
+ * @internal
2569
+ */
2570
+ export declare function toJson_YamlLinterConfiguration(obj: YamlLinterConfiguration | undefined): Record<string, any> | undefined;
2009
2571
  /**
2010
2572
  * A preset configuration for enabling a set of rules.
2011
2573
  *
@@ -2020,60 +2582,85 @@ export declare enum PresetConfig {
2020
2582
  NONE = "none"
2021
2583
  }
2022
2584
  /**
2023
- * A list of rules that belong to this group
2585
+ * Configures one group of assist actions.
2024
2586
  *
2025
2587
  * @schema Source
2026
2588
  */
2027
2589
  export interface Source {
2028
2590
  /**
2029
- * Remove duplicate CSS classes.
2591
+ * Remove repeated CSS class names from HTML class attributes.
2030
2592
  * See https://biomejs.dev/assist/actions/no-duplicate-classes
2031
2593
  *
2032
2594
  * @schema Source#noDuplicateClasses
2033
2595
  */
2034
2596
  readonly noDuplicateClasses?: any;
2035
2597
  /**
2036
- * Sorts imports and exports in your JavaScript and TypeScript files.
2598
+ * Organize imports and exports in JavaScript and TypeScript files.
2037
2599
  * See https://biomejs.dev/assist/actions/organize-imports
2038
2600
  *
2039
2601
  * @schema Source#organizeImports
2040
2602
  */
2041
2603
  readonly organizeImports?: any;
2042
2604
  /**
2043
- * Enables a particular rule preset
2605
+ * Selects the baseline set of assist actions for this group. `recommended` enables
2606
+ * the group's recommended actions, `all` enables all actions in the group, and
2607
+ * `none` starts with no actions enabled in the group. Explicit action settings
2608
+ * override this group preset, which overrides `assist.actions.preset` for the group.
2044
2609
  *
2045
2610
  * @schema Source#preset
2046
2611
  */
2047
2612
  readonly preset?: PresetConfig;
2048
2613
  /**
2049
- * Enables the recommended rules for this group
2614
+ * Enables or disables the recommended actions in this group. The group's `preset`
2615
+ * setting takes precedence when both options are set.
2050
2616
  *
2051
2617
  * @schema Source#recommended
2052
2618
  */
2053
2619
  readonly recommended?: boolean;
2054
2620
  /**
2055
- * Enforce attribute sorting in HTML elements.
2621
+ * Sort the arguments of GraphQL fields and directives in natural order.
2622
+ * See https://biomejs.dev/assist/actions/use-graphql-sorted-arguments
2623
+ *
2624
+ * @schema Source#useGraphqlSortedArguments
2625
+ */
2626
+ readonly useGraphqlSortedArguments?: any;
2627
+ /**
2628
+ * Sort the named definitions in a GraphQL document.
2629
+ * See https://biomejs.dev/assist/actions/use-graphql-sorted-definitions
2630
+ *
2631
+ * @schema Source#useGraphqlSortedDefinitions
2632
+ */
2633
+ readonly useGraphqlSortedDefinitions?: any;
2634
+ /**
2635
+ * Sort the variable definitions of GraphQL operations in natural order.
2636
+ * See https://biomejs.dev/assist/actions/use-graphql-sorted-variables
2637
+ *
2638
+ * @schema Source#useGraphqlSortedVariables
2639
+ */
2640
+ readonly useGraphqlSortedVariables?: any;
2641
+ /**
2642
+ * Sort HTML attributes and framework directives into a consistent order.
2056
2643
  * See https://biomejs.dev/assist/actions/use-sorted-attributes
2057
2644
  *
2058
2645
  * @schema Source#useSortedAttributes
2059
2646
  */
2060
2647
  readonly useSortedAttributes?: any;
2061
2648
  /**
2062
- * Sort the members of an enum in natural order.
2649
+ * Sort GraphQL enum values in natural order.
2063
2650
  * See https://biomejs.dev/assist/actions/use-sorted-enum-members
2064
2651
  *
2065
2652
  * @schema Source#useSortedEnumMembers
2066
2653
  */
2067
2654
  readonly useSortedEnumMembers?: any;
2068
2655
  /**
2069
- * Sort interface members by key.
2656
+ * Sort named members of a TypeScript interface.
2070
2657
  * See https://biomejs.dev/assist/actions/use-sorted-interface-members
2071
2658
  *
2072
2659
  * @schema Source#useSortedInterfaceMembers
2073
2660
  */
2074
2661
  readonly useSortedInterfaceMembers?: any;
2075
2662
  /**
2076
- * Sort the keys of a JSON object in natural order.
2663
+ * Sort keys in a JSON object.
2077
2664
  * See https://biomejs.dev/assist/actions/use-sorted-keys
2078
2665
  *
2079
2666
  * @schema Source#useSortedKeys
@@ -2087,21 +2674,21 @@ export interface Source {
2087
2674
  */
2088
2675
  readonly useSortedPackageJson?: any;
2089
2676
  /**
2090
- * Enforce ordering of CSS properties and nested rules.
2677
+ * Sort CSS properties and nested rules into a consistent order.
2091
2678
  * See https://biomejs.dev/assist/actions/use-sorted-properties
2092
2679
  *
2093
2680
  * @schema Source#useSortedProperties
2094
2681
  */
2095
2682
  readonly useSortedProperties?: any;
2096
2683
  /**
2097
- * Sort GraphQL selection sets.
2684
+ * Sort selections inside GraphQL operations and fragments.
2098
2685
  * See https://biomejs.dev/assist/actions/use-sorted-selection-set
2099
2686
  *
2100
2687
  * @schema Source#useSortedSelectionSet
2101
2688
  */
2102
2689
  readonly useSortedSelectionSet?: any;
2103
2690
  /**
2104
- * Sort fields in GraphQL type definitions alphabetically.
2691
+ * Sort fields in GraphQL type definitions by name.
2105
2692
  * See https://biomejs.dev/assist/actions/use-sorted-type-fields
2106
2693
  *
2107
2694
  * @schema Source#useSortedTypeFields
@@ -2123,18 +2710,19 @@ export declare enum QuoteStyle {
2123
2710
  SINGLE = "single"
2124
2711
  }
2125
2712
  /**
2126
- * Controls whether void-elements should be self closed
2713
+ * Controls whether HTML void elements such as `<img>` and `<input>` include a slash before `>`.
2127
2714
  *
2128
2715
  * @schema SelfCloseVoidElements
2129
2716
  */
2130
2717
  export declare enum SelfCloseVoidElements {
2131
- /** The `/` inside void elements is removed by the formatter (never) */
2718
+ /** Removes the slash, for example `<img src="image.png">`. (never) */
2132
2719
  NEVER = "never",
2133
- /** The `/` inside void elements is always added (always) */
2720
+ /** Adds the slash, for example `<img src="image.png" />`. (always) */
2134
2721
  ALWAYS = "always"
2135
2722
  }
2136
2723
  /**
2137
- * Whitespace sensitivity for HTML formatting.
2724
+ * Controls how the formatter treats whitespace around text and child elements in HTML, Vue,
2725
+ * Svelte, and Astro markup.
2138
2726
  *
2139
2727
  * The following two cases won't produce the same output:
2140
2728
  *
@@ -2161,13 +2749,10 @@ export declare enum SelfCloseVoidElements {
2161
2749
  * @schema WhitespaceSensitivity
2162
2750
  */
2163
2751
  export declare enum WhitespaceSensitivity {
2164
- /** The formatter considers whitespace significant for elements that have an "inline" display style by default in
2165
- browser's user agent style sheets. (css) */
2752
+ /** Treats whitespace as significant for elements that browsers display inline by default. (css) */
2166
2753
  CSS = "css",
2167
- /** Leading and trailing whitespace in content is considered significant for all elements.
2168
-
2169
- The formatter should leave at least one whitespace character if whitespace is present.
2170
- Otherwise, if there is no whitespace, it should not add any after `>` or before `<`. In other words, if there's no whitespace, the text content should hug the tags.
2754
+ /** Treats leading and trailing whitespace as significant for every element. Existing whitespace
2755
+ is preserved as at least one character and absent whitespace is not added.
2171
2756
 
2172
2757
  Example of text hugging the tags:
2173
2758
  ```html
@@ -2176,16 +2761,17 @@ export declare enum WhitespaceSensitivity {
2176
2761
  >
2177
2762
  ``` (strict) */
2178
2763
  STRICT = "strict",
2179
- /** Whitespace is considered insignificant. The formatter is free to remove or add whitespace as it sees fit. (ignore) */
2764
+ /** Treats whitespace as insignificant, allowing the formatter to add or remove it. Use this only
2765
+ when whitespace cannot affect rendered output. (ignore) */
2180
2766
  IGNORE = "ignore"
2181
2767
  }
2182
2768
  /**
2183
2769
  * @schema ArrowParentheses
2184
2770
  */
2185
2771
  export declare enum ArrowParentheses {
2186
- /** always */
2772
+ /** Always prints parentheses around arrow-function parameters. (always) */
2187
2773
  ALWAYS = "always",
2188
- /** asNeeded */
2774
+ /** Omits parentheses when an arrow function has one parameter and the syntax permits it. (asNeeded) */
2189
2775
  AS_NEEDED = "asNeeded"
2190
2776
  }
2191
2777
  /**
@@ -2201,9 +2787,9 @@ export declare enum OperatorLinebreak {
2201
2787
  * @schema QuoteProperties
2202
2788
  */
2203
2789
  export declare enum QuoteProperties {
2204
- /** asNeeded */
2790
+ /** Removes quotes when the property name is valid without them. (asNeeded) */
2205
2791
  AS_NEEDED = "asNeeded",
2206
- /** preserve */
2792
+ /** Preserves quotes around property names that were quoted in the input. (preserve) */
2207
2793
  PRESERVE = "preserve"
2208
2794
  }
2209
2795
  /**
@@ -2229,7 +2815,7 @@ export declare enum JsTrailingCommas {
2229
2815
  NONE = "none"
2230
2816
  }
2231
2817
  /**
2232
- * Print trailing commas wherever possible in multi-line comma-separated syntactic structures for JSON files.
2818
+ * 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.
2233
2819
  *
2234
2820
  * @schema JsonTrailingCommas
2235
2821
  */
@@ -2243,10 +2829,26 @@ export declare enum JsonTrailingCommas {
2243
2829
  * @schema RuleDomainValue
2244
2830
  */
2245
2831
  export declare enum RuleDomainValue {
2246
- /** Enables all the rules that belong to this domain (all) */
2832
+ /** Enables all rules in the domain. (all) */
2247
2833
  ALL = "all",
2248
- /** Disables all the rules that belong to this domain (none) */
2834
+ /** Disables the domain. (none) */
2249
2835
  NONE = "none",
2250
- /** Enables only the recommended rules for this domain (recommended) */
2836
+ /** Enables the domain's recommended non-nursery rules. (recommended) */
2251
2837
  RECOMMENDED = "recommended"
2252
2838
  }
2839
+ /**
2840
+ * Controls whether Biome keeps, adds, or removes line breaks in Markdown paragraphs.
2841
+ *
2842
+ * Manual line breaks are always kept. In Markdown, a manual line break is created by ending a
2843
+ * line with two spaces or a backslash.
2844
+ *
2845
+ * @schema ProseWrap
2846
+ */
2847
+ export declare enum ProseWrap {
2848
+ /** Keep line breaks as written in the source file. This is the default. (preserve) */
2849
+ PRESERVE = "preserve",
2850
+ /** Wrap paragraphs to fit the configured `lineWidth`. (always) */
2851
+ ALWAYS = "always",
2852
+ /** Remove line breaks from paragraphs so that each paragraph is on one line. (never) */
2853
+ NEVER = "never"
2854
+ }