projen 0.101.26 → 0.101.28
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.
- package/.jsii +1065 -735
- package/lib/ai-instructions.js +2 -2
- package/lib/awscdk/auto-discover.js +6 -6
- package/lib/awscdk/awscdk-app-java.js +1 -1
- package/lib/awscdk/awscdk-app-py.js +1 -1
- package/lib/awscdk/awscdk-app-ts.js +1 -1
- package/lib/awscdk/awscdk-construct.js +1 -1
- package/lib/awscdk/awscdk-deps-java.js +1 -1
- package/lib/awscdk/awscdk-deps-js.js +1 -1
- package/lib/awscdk/awscdk-deps-py.js +1 -1
- package/lib/awscdk/awscdk-deps.js +1 -1
- package/lib/awscdk/cdk-config.js +3 -3
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/lambda-extension.js +1 -1
- package/lib/awscdk/lambda-function.js +2 -2
- package/lib/build/build-workflow.js +1 -1
- package/lib/cdk/auto-discover-base.js +2 -2
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/integration-test-base.js +1 -1
- package/lib/cdk/jsii-build.js +1 -1
- package/lib/cdk/jsii-docgen.js +1 -1
- package/lib/cdk/jsii-project.js +1 -1
- package/lib/cdk8s/auto-discover.js +2 -2
- package/lib/cdk8s/cdk8s-app-py.js +1 -1
- package/lib/cdk8s/cdk8s-app-ts.js +1 -1
- package/lib/cdk8s/cdk8s-construct.js +1 -1
- package/lib/cdk8s/cdk8s-deps-py.js +1 -1
- package/lib/cdk8s/cdk8s-deps.js +1 -1
- package/lib/cdk8s/integration-test.js +1 -1
- package/lib/cdktf/cdktf-construct.js +1 -1
- package/lib/circleci/circleci.js +1 -1
- package/lib/cli/task-runtime.js +2 -2
- package/lib/component.js +2 -2
- package/lib/dependencies.js +1 -1
- package/lib/dev-env.js +1 -1
- package/lib/docker-compose/docker-compose-service.js +1 -1
- package/lib/docker-compose/docker-compose.js +1 -1
- package/lib/file.js +1 -1
- package/lib/gitattributes.js +1 -1
- package/lib/github/actions-provider.js +1 -1
- package/lib/github/auto-approve.js +1 -1
- package/lib/github/auto-merge.js +1 -1
- package/lib/github/auto-queue.js +1 -1
- package/lib/github/dependabot.js +1 -1
- package/lib/github/dependency-review.js +1 -1
- package/lib/github/github-credentials.js +1 -1
- package/lib/github/github-project.js +1 -1
- package/lib/github/github.js +1 -1
- package/lib/github/merge-queue.js +1 -1
- package/lib/github/mergify.js +1 -1
- package/lib/github/pr-template.js +1 -1
- package/lib/github/pull-request-backport.js +1 -1
- package/lib/github/pull-request-lint.js +1 -1
- package/lib/github/stale.js +1 -1
- package/lib/github/task-workflow-job.js +1 -1
- package/lib/github/task-workflow.js +1 -1
- package/lib/github/workflow-actions.js +1 -1
- package/lib/github/workflow-jobs.js +1 -1
- package/lib/github/workflow-steps.js +1 -1
- package/lib/github/workflows.js +1 -1
- package/lib/gitlab/configuration.js +1 -1
- package/lib/gitlab/gitlab-configuration.js +1 -1
- package/lib/gitlab/nested-configuration.js +1 -1
- package/lib/gitpod.js +1 -1
- package/lib/ignore-file.js +1 -1
- package/lib/ini.js +1 -1
- package/lib/java/java-project.js +1 -1
- package/lib/java/junit.js +1 -1
- package/lib/java/maven-compile.js +1 -1
- package/lib/java/maven-packaging.js +1 -1
- package/lib/java/maven-sample.js +1 -1
- package/lib/java/pom.js +2 -2
- package/lib/java/projenrc.js +1 -1
- package/lib/javascript/biome/biome-config.d.ts +292 -322
- package/lib/javascript/biome/biome-config.js +5 -5
- package/lib/javascript/biome/biome.js +1 -1
- package/lib/javascript/bundler.js +1 -1
- package/lib/javascript/eslint.js +1 -1
- package/lib/javascript/jest.js +4 -4
- package/lib/javascript/license-checker.js +1 -1
- package/lib/javascript/node-package.d.ts +57 -4
- package/lib/javascript/node-package.js +46 -6
- package/lib/javascript/node-project.js +1 -1
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/pnpm-workspace-config.js +2 -2
- package/lib/javascript/pnpm-workspace.js +1 -1
- package/lib/javascript/prettier.js +1 -1
- package/lib/javascript/projenrc.js +1 -1
- package/lib/javascript/typescript-config.js +2 -2
- package/lib/javascript/upgrade-dependencies.js +7 -3
- package/lib/javascript/yarnrc.d.ts +51 -3
- package/lib/javascript/yarnrc.js +22 -4
- package/lib/json-patch.js +1 -1
- package/lib/json.js +1 -1
- package/lib/license.js +1 -1
- package/lib/logger.js +1 -1
- package/lib/makefile.js +1 -1
- package/lib/object-file.js +1 -1
- package/lib/project-build.js +1 -1
- package/lib/project-tree.js +1 -1
- package/lib/project.js +1 -1
- package/lib/projects.js +1 -1
- package/lib/projenrc-json.js +1 -1
- package/lib/projenrc.js +1 -1
- package/lib/python/pip.js +1 -1
- package/lib/python/poetry.js +2 -2
- package/lib/python/projenrc.js +1 -1
- package/lib/python/pyproject-toml-file.js +1 -1
- package/lib/python/pytest-sample.js +1 -1
- package/lib/python/pytest.js +1 -1
- package/lib/python/python-project.js +1 -1
- package/lib/python/python-sample.js +1 -1
- package/lib/python/requirements-file.js +1 -1
- package/lib/python/setuppy.js +1 -1
- package/lib/python/setuptools.js +1 -1
- package/lib/python/uv-config.js +1 -1
- package/lib/python/uv.js +1 -1
- package/lib/python/venv.js +1 -1
- package/lib/readme.js +1 -1
- package/lib/release/publisher.js +1 -1
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.js +1 -1
- package/lib/renovatebot.js +1 -1
- package/lib/run-task.cjs +61 -42
- package/lib/sample-file.js +2 -2
- package/lib/script-runner.js +1 -1
- package/lib/source-code.js +1 -1
- package/lib/task-shell.js +1 -1
- package/lib/task.js +1 -1
- package/lib/tasks.js +1 -1
- package/lib/testing.js +1 -1
- package/lib/textfile.js +1 -1
- package/lib/toml.js +1 -1
- package/lib/typescript/projenrc-ts.js +1 -1
- package/lib/typescript/projenrc.js +1 -1
- package/lib/typescript/typescript-runner.js +1 -1
- package/lib/typescript/typescript-typedoc.js +1 -1
- package/lib/typescript/typescript.js +5 -5
- package/lib/util/dax.d.ts +1 -0
- package/lib/util/dax.js +21 -0
- package/lib/util/exec.js +2 -2
- package/lib/util/node-compat.d.ts +23 -0
- package/lib/util/node-compat.js +40 -0
- package/lib/version.js +2 -2
- package/lib/vscode/devcontainer.js +1 -1
- package/lib/vscode/extensions.js +1 -1
- package/lib/vscode/launch-config.js +1 -1
- package/lib/vscode/settings.js +1 -1
- package/lib/vscode/vscode.js +1 -1
- package/lib/web/next.js +3 -3
- package/lib/web/postcss.js +1 -1
- package/lib/web/react.js +3 -3
- package/lib/web/tailwind.js +1 -1
- package/lib/xmlfile.js +1 -1
- package/lib/yaml.js +1 -1
- package/node_modules/js-yaml/dist/js-yaml.js +5 -2
- package/node_modules/js-yaml/dist/js-yaml.js.map +1 -1
- package/node_modules/js-yaml/dist/js-yaml.min.js +1 -1
- package/node_modules/js-yaml/dist/js-yaml.min.js.map +1 -1
- package/node_modules/js-yaml/dist/js-yaml.mjs +3 -3
- package/node_modules/js-yaml/dist/js-yaml.mjs.map +1 -1
- package/node_modules/js-yaml/lib/type/omap.js +3 -3
- package/node_modules/js-yaml/package.json +1 -1
- package/package.json +3 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* The configuration
|
|
2
|
+
* The configuration contained in `biome.json`.
|
|
3
3
|
*
|
|
4
4
|
* @schema BiomeConfiguration
|
|
5
5
|
*/
|
|
@@ -11,13 +11,13 @@ export interface BiomeConfiguration {
|
|
|
11
11
|
*/
|
|
12
12
|
readonly schema?: string;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* The assist configuration.
|
|
15
15
|
*
|
|
16
16
|
* @schema BiomeConfiguration#assist
|
|
17
17
|
*/
|
|
18
18
|
readonly assist?: AssistConfiguration;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Configuration specific to CSS.
|
|
21
21
|
*
|
|
22
22
|
* @schema BiomeConfiguration#css
|
|
23
23
|
*/
|
|
@@ -29,55 +29,55 @@ export interface BiomeConfiguration {
|
|
|
29
29
|
*/
|
|
30
30
|
readonly extends?: string[];
|
|
31
31
|
/**
|
|
32
|
-
* The
|
|
32
|
+
* The file handling configuration.
|
|
33
33
|
*
|
|
34
34
|
* @schema BiomeConfiguration#files
|
|
35
35
|
*/
|
|
36
36
|
readonly files?: FilesConfiguration;
|
|
37
37
|
/**
|
|
38
|
-
* The configuration
|
|
38
|
+
* The formatter configuration.
|
|
39
39
|
*
|
|
40
40
|
* @schema BiomeConfiguration#formatter
|
|
41
41
|
*/
|
|
42
42
|
readonly formatter?: FormatterConfiguration;
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
44
|
+
* Configuration specific to GraphQL.
|
|
45
45
|
*
|
|
46
46
|
* @schema BiomeConfiguration#graphql
|
|
47
47
|
*/
|
|
48
48
|
readonly graphql?: GraphqlConfiguration;
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* Configuration specific to GritQL.
|
|
51
51
|
*
|
|
52
52
|
* @schema BiomeConfiguration#grit
|
|
53
53
|
*/
|
|
54
54
|
readonly grit?: GritConfiguration;
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
56
|
+
* Configuration specific to HTML.
|
|
57
57
|
*
|
|
58
58
|
* @schema BiomeConfiguration#html
|
|
59
59
|
*/
|
|
60
60
|
readonly html?: HtmlConfiguration;
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* Configuration specific to JavaScript.
|
|
63
63
|
*
|
|
64
64
|
* @schema BiomeConfiguration#javascript
|
|
65
65
|
*/
|
|
66
66
|
readonly javascript?: JsConfiguration;
|
|
67
67
|
/**
|
|
68
|
-
*
|
|
68
|
+
* Configuration specific to JSON.
|
|
69
69
|
*
|
|
70
70
|
* @schema BiomeConfiguration#json
|
|
71
71
|
*/
|
|
72
72
|
readonly json?: JsonConfiguration;
|
|
73
73
|
/**
|
|
74
|
-
* The configuration
|
|
74
|
+
* The linter configuration.
|
|
75
75
|
*
|
|
76
76
|
* @schema BiomeConfiguration#linter
|
|
77
77
|
*/
|
|
78
78
|
readonly linter?: LinterConfiguration;
|
|
79
79
|
/**
|
|
80
|
-
* A list of granular patterns
|
|
80
|
+
* A list of granular patterns applied only to a subset of files.
|
|
81
81
|
*
|
|
82
82
|
* @schema BiomeConfiguration#overrides
|
|
83
83
|
*/
|
|
@@ -96,7 +96,7 @@ export interface BiomeConfiguration {
|
|
|
96
96
|
*/
|
|
97
97
|
readonly root?: boolean;
|
|
98
98
|
/**
|
|
99
|
-
* The
|
|
99
|
+
* The version control integration configuration.
|
|
100
100
|
*
|
|
101
101
|
* @schema BiomeConfiguration#vcs
|
|
102
102
|
*/
|
|
@@ -137,37 +137,37 @@ export interface AssistConfiguration {
|
|
|
137
137
|
*/
|
|
138
138
|
export declare function toJson_AssistConfiguration(obj: AssistConfiguration | undefined): Record<string, any> | undefined;
|
|
139
139
|
/**
|
|
140
|
-
* Options applied to CSS files
|
|
140
|
+
* Options applied to CSS files.
|
|
141
141
|
*
|
|
142
142
|
* @schema CssConfiguration
|
|
143
143
|
*/
|
|
144
144
|
export interface CssConfiguration {
|
|
145
145
|
/**
|
|
146
|
-
* CSS assist options
|
|
146
|
+
* CSS assist options.
|
|
147
147
|
*
|
|
148
148
|
* @schema CssConfiguration#assist
|
|
149
149
|
*/
|
|
150
150
|
readonly assist?: CssAssistConfiguration;
|
|
151
151
|
/**
|
|
152
|
-
* CSS formatter options
|
|
152
|
+
* CSS formatter options.
|
|
153
153
|
*
|
|
154
154
|
* @schema CssConfiguration#formatter
|
|
155
155
|
*/
|
|
156
156
|
readonly formatter?: CssFormatterConfiguration;
|
|
157
157
|
/**
|
|
158
|
-
* CSS globals
|
|
158
|
+
* CSS globals.
|
|
159
159
|
*
|
|
160
160
|
* @schema CssConfiguration#globals
|
|
161
161
|
*/
|
|
162
162
|
readonly globals?: string[];
|
|
163
163
|
/**
|
|
164
|
-
* CSS linter options
|
|
164
|
+
* CSS linter options.
|
|
165
165
|
*
|
|
166
166
|
* @schema CssConfiguration#linter
|
|
167
167
|
*/
|
|
168
168
|
readonly linter?: CssLinterConfiguration;
|
|
169
169
|
/**
|
|
170
|
-
* CSS parsing options
|
|
170
|
+
* CSS parsing options.
|
|
171
171
|
*
|
|
172
172
|
* @schema CssConfiguration#parser
|
|
173
173
|
*/
|
|
@@ -179,7 +179,7 @@ export interface CssConfiguration {
|
|
|
179
179
|
*/
|
|
180
180
|
export declare function toJson_CssConfiguration(obj: CssConfiguration | undefined): Record<string, any> | undefined;
|
|
181
181
|
/**
|
|
182
|
-
* The
|
|
182
|
+
* The file handling configuration.
|
|
183
183
|
*
|
|
184
184
|
* @schema FilesConfiguration
|
|
185
185
|
*/
|
|
@@ -195,23 +195,22 @@ export interface FilesConfiguration {
|
|
|
195
195
|
*/
|
|
196
196
|
readonly experimentalScannerIgnores?: string[];
|
|
197
197
|
/**
|
|
198
|
-
*
|
|
198
|
+
* Prevents Biome from emitting diagnostics for unrecognized file types.
|
|
199
199
|
*
|
|
200
200
|
* @schema FilesConfiguration#ignoreUnknown
|
|
201
201
|
*/
|
|
202
202
|
readonly ignoreUnknown?: boolean;
|
|
203
203
|
/**
|
|
204
|
-
* A list of glob patterns. Biome
|
|
205
|
-
*
|
|
204
|
+
* A list of glob patterns. Biome handles only files and directories that match these
|
|
205
|
+
* patterns.
|
|
206
206
|
*
|
|
207
207
|
* @schema FilesConfiguration#includes
|
|
208
208
|
*/
|
|
209
209
|
readonly includes?: string[];
|
|
210
210
|
/**
|
|
211
|
-
* The maximum
|
|
212
|
-
* this limit will be ignored for performance reasons. Defaults to 1 MiB
|
|
211
|
+
* The maximum source file size in bytes. Biome ignores larger files. Defaults to `1 MiB`.
|
|
213
212
|
*
|
|
214
|
-
* @default 1 MiB
|
|
213
|
+
* @default 1 MiB`.
|
|
215
214
|
* @schema FilesConfiguration#maxSize
|
|
216
215
|
*/
|
|
217
216
|
readonly maxSize?: number;
|
|
@@ -228,33 +227,34 @@ export declare function toJson_FilesConfiguration(obj: FilesConfiguration | unde
|
|
|
228
227
|
*/
|
|
229
228
|
export interface FormatterConfiguration {
|
|
230
229
|
/**
|
|
231
|
-
* The attribute position style in HTML-
|
|
230
|
+
* The attribute position style in HTML-like languages. Defaults to `auto`.
|
|
232
231
|
*
|
|
233
|
-
* @default auto
|
|
232
|
+
* @default auto`.
|
|
234
233
|
* @schema FormatterConfiguration#attributePosition
|
|
235
234
|
*/
|
|
236
235
|
readonly attributePosition?: AttributePosition;
|
|
237
236
|
/**
|
|
238
|
-
*
|
|
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`.
|
|
239
239
|
*
|
|
240
|
+
* @default false`.
|
|
240
241
|
* @schema FormatterConfiguration#bracketSameLine
|
|
241
242
|
*/
|
|
242
243
|
readonly bracketSameLine?: boolean;
|
|
243
244
|
/**
|
|
244
|
-
* Whether to insert spaces
|
|
245
|
+
* Whether to insert spaces inside braces in object literals. Defaults to `true`.
|
|
245
246
|
*
|
|
246
|
-
* @default true
|
|
247
|
+
* @default true`.
|
|
247
248
|
* @schema FormatterConfiguration#bracketSpacing
|
|
248
249
|
*/
|
|
249
250
|
readonly bracketSpacing?: boolean;
|
|
250
251
|
/**
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
* delimiters affected depend on the language. Defaults to false.
|
|
252
|
+
* Controls spaces immediately inside supported delimiters when their content fits on one line.
|
|
253
|
+
* It doesn't add spaces before opening delimiters or inside empty delimiters.
|
|
254
|
+
*
|
|
255
|
+
* The affected delimiters vary by language. Defaults to `false`.
|
|
256
256
|
*
|
|
257
|
-
* @default false
|
|
257
|
+
* @default false`.
|
|
258
258
|
* @schema FormatterConfiguration#delimiterSpacing
|
|
259
259
|
*/
|
|
260
260
|
readonly delimiterSpacing?: boolean;
|
|
@@ -263,21 +263,27 @@ export interface FormatterConfiguration {
|
|
|
263
263
|
*/
|
|
264
264
|
readonly enabled?: boolean;
|
|
265
265
|
/**
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
*
|
|
266
|
+
* Controls whether arrays and objects are formatted on one line or multiple lines.
|
|
267
|
+
*
|
|
268
|
+
* `auto` formats objects on multiple lines if the first property has a newline, and arrays on
|
|
269
|
+
* one line if they fit.
|
|
270
|
+
*
|
|
271
|
+
* `always` formats arrays and objects on multiple lines.
|
|
272
|
+
*
|
|
273
|
+
* `never` formats arrays and objects on one line if they fit.
|
|
274
|
+
*
|
|
275
|
+
* Defaults to `auto`.
|
|
272
276
|
*
|
|
273
|
-
*
|
|
277
|
+
* When formatting `package.json`, Biome uses `always` unless configured otherwise.
|
|
278
|
+
*
|
|
279
|
+
* @default auto`.
|
|
274
280
|
* @schema FormatterConfiguration#expand
|
|
275
281
|
*/
|
|
276
282
|
readonly expand?: Expand;
|
|
277
283
|
/**
|
|
278
|
-
*
|
|
279
|
-
* has syntax errors
|
|
284
|
+
* Allows formatting files that contain syntax errors when set to `true`. Defaults to `false`.
|
|
280
285
|
*
|
|
286
|
+
* @default false`.
|
|
281
287
|
* @schema FormatterConfiguration#formatWithErrors
|
|
282
288
|
*/
|
|
283
289
|
readonly formatWithErrors?: boolean;
|
|
@@ -289,52 +295,46 @@ export interface FormatterConfiguration {
|
|
|
289
295
|
*/
|
|
290
296
|
readonly includes?: string[];
|
|
291
297
|
/**
|
|
292
|
-
*
|
|
298
|
+
* Uses tabs or spaces for indentation. Defaults to `tab`.
|
|
293
299
|
*
|
|
300
|
+
* @default tab`.
|
|
294
301
|
* @schema FormatterConfiguration#indentStyle
|
|
295
302
|
*/
|
|
296
303
|
readonly indentStyle?: IndentStyle;
|
|
297
304
|
/**
|
|
298
|
-
* The
|
|
305
|
+
* The indentation width. Defaults to `2`.
|
|
299
306
|
*
|
|
307
|
+
* @default 2`.
|
|
300
308
|
* @schema FormatterConfiguration#indentWidth
|
|
301
309
|
*/
|
|
302
310
|
readonly indentWidth?: number;
|
|
303
311
|
/**
|
|
304
|
-
*
|
|
312
|
+
* Selects the line ending. `auto` uses the platform convention. Defaults to `lf`.
|
|
305
313
|
*
|
|
314
|
+
* @default lf`.
|
|
306
315
|
* @schema FormatterConfiguration#lineEnding
|
|
307
316
|
*/
|
|
308
317
|
readonly lineEnding?: LineEnding;
|
|
309
318
|
/**
|
|
310
|
-
*
|
|
319
|
+
* The maximum line width. Defaults to `80`.
|
|
311
320
|
*
|
|
312
|
-
* @default 80
|
|
321
|
+
* @default 80`.
|
|
313
322
|
* @schema FormatterConfiguration#lineWidth
|
|
314
323
|
*/
|
|
315
324
|
readonly lineWidth?: number;
|
|
316
325
|
/**
|
|
317
|
-
* Whether to add a trailing newline at the end of the file.
|
|
318
|
-
*
|
|
319
|
-
* Setting this option to `false` is **highly discouraged** because it could cause many problems with other tools:
|
|
320
|
-
* - https://thoughtbot.com/blog/no-newline-at-end-of-file
|
|
321
|
-
* - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
|
|
322
|
-
* - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
|
|
323
|
-
*
|
|
324
|
-
* Disable the option at your own risk.
|
|
325
|
-
*
|
|
326
|
-
* Defaults to true.
|
|
326
|
+
* Whether to add a trailing newline at the end of the file. Defaults to `true`; disabling
|
|
327
|
+
* this option can cause compatibility problems with other tools.
|
|
327
328
|
*
|
|
328
|
-
* @default true
|
|
329
|
+
* @default true`; disabling
|
|
329
330
|
* @schema FormatterConfiguration#trailingNewline
|
|
330
331
|
*/
|
|
331
332
|
readonly trailingNewline?: boolean;
|
|
332
333
|
/**
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
*
|
|
336
|
-
* Default: `false`.
|
|
334
|
+
* Uses `.editorconfig` files to configure the formatter. Settings in `biome.json` or
|
|
335
|
+
* `biome.jsonc` override `.editorconfig` settings. Defaults to `false`.
|
|
337
336
|
*
|
|
337
|
+
* @default false`.
|
|
338
338
|
* @schema FormatterConfiguration#useEditorconfig
|
|
339
339
|
*/
|
|
340
340
|
readonly useEditorconfig?: boolean;
|
|
@@ -345,24 +345,26 @@ export interface FormatterConfiguration {
|
|
|
345
345
|
*/
|
|
346
346
|
export declare function toJson_FormatterConfiguration(obj: FormatterConfiguration | undefined): Record<string, any> | undefined;
|
|
347
347
|
/**
|
|
348
|
-
* Options applied to GraphQL files
|
|
348
|
+
* Options applied to GraphQL files.
|
|
349
349
|
*
|
|
350
350
|
* @schema GraphqlConfiguration
|
|
351
351
|
*/
|
|
352
352
|
export interface GraphqlConfiguration {
|
|
353
353
|
/**
|
|
354
|
-
*
|
|
354
|
+
* GraphQL assist options.
|
|
355
355
|
*
|
|
356
356
|
* @schema GraphqlConfiguration#assist
|
|
357
357
|
*/
|
|
358
358
|
readonly assist?: GraphqlAssistConfiguration;
|
|
359
359
|
/**
|
|
360
|
-
* GraphQL formatter options
|
|
360
|
+
* GraphQL formatter options.
|
|
361
361
|
*
|
|
362
362
|
* @schema GraphqlConfiguration#formatter
|
|
363
363
|
*/
|
|
364
364
|
readonly formatter?: GraphqlFormatterConfiguration;
|
|
365
365
|
/**
|
|
366
|
+
* GraphQL linter options.
|
|
367
|
+
*
|
|
366
368
|
* @schema GraphqlConfiguration#linter
|
|
367
369
|
*/
|
|
368
370
|
readonly linter?: GraphqlLinterConfiguration;
|
|
@@ -373,25 +375,25 @@ export interface GraphqlConfiguration {
|
|
|
373
375
|
*/
|
|
374
376
|
export declare function toJson_GraphqlConfiguration(obj: GraphqlConfiguration | undefined): Record<string, any> | undefined;
|
|
375
377
|
/**
|
|
376
|
-
* Options applied to GritQL files
|
|
378
|
+
* Options applied to GritQL files.
|
|
377
379
|
*
|
|
378
380
|
* @schema GritConfiguration
|
|
379
381
|
*/
|
|
380
382
|
export interface GritConfiguration {
|
|
381
383
|
/**
|
|
382
|
-
*
|
|
384
|
+
* GritQL assist options.
|
|
383
385
|
*
|
|
384
386
|
* @schema GritConfiguration#assist
|
|
385
387
|
*/
|
|
386
388
|
readonly assist?: GritAssistConfiguration;
|
|
387
389
|
/**
|
|
388
|
-
*
|
|
390
|
+
* GritQL formatter options.
|
|
389
391
|
*
|
|
390
392
|
* @schema GritConfiguration#formatter
|
|
391
393
|
*/
|
|
392
394
|
readonly formatter?: GritFormatterConfiguration;
|
|
393
395
|
/**
|
|
394
|
-
*
|
|
396
|
+
* GritQL linter options.
|
|
395
397
|
*
|
|
396
398
|
* @schema GritConfiguration#linter
|
|
397
399
|
*/
|
|
@@ -403,35 +405,37 @@ export interface GritConfiguration {
|
|
|
403
405
|
*/
|
|
404
406
|
export declare function toJson_GritConfiguration(obj: GritConfiguration | undefined): Record<string, any> | undefined;
|
|
405
407
|
/**
|
|
406
|
-
* Options applied to HTML files
|
|
408
|
+
* Options applied to HTML files.
|
|
407
409
|
*
|
|
408
410
|
* @schema HtmlConfiguration
|
|
409
411
|
*/
|
|
410
412
|
export interface HtmlConfiguration {
|
|
411
413
|
/**
|
|
414
|
+
* HTML assist options.
|
|
415
|
+
*
|
|
412
416
|
* @schema HtmlConfiguration#assist
|
|
413
417
|
*/
|
|
414
418
|
readonly assist?: HtmlAssistConfiguration;
|
|
415
419
|
/**
|
|
416
|
-
* Enables full support for HTML, Vue, Svelte and Astro files.
|
|
420
|
+
* Enables full support for HTML, Vue, Svelte, and Astro files.
|
|
417
421
|
*
|
|
418
422
|
* @schema HtmlConfiguration#experimentalFullSupportEnabled
|
|
419
423
|
*/
|
|
420
424
|
readonly experimentalFullSupportEnabled?: boolean;
|
|
421
425
|
/**
|
|
422
|
-
* HTML formatter options
|
|
426
|
+
* HTML formatter options.
|
|
423
427
|
*
|
|
424
428
|
* @schema HtmlConfiguration#formatter
|
|
425
429
|
*/
|
|
426
430
|
readonly formatter?: HtmlFormatterConfiguration;
|
|
427
431
|
/**
|
|
428
|
-
* HTML linter options
|
|
432
|
+
* HTML linter options.
|
|
429
433
|
*
|
|
430
434
|
* @schema HtmlConfiguration#linter
|
|
431
435
|
*/
|
|
432
436
|
readonly linter?: HtmlLinterConfiguration;
|
|
433
437
|
/**
|
|
434
|
-
* HTML parsing options
|
|
438
|
+
* HTML parsing options.
|
|
435
439
|
*
|
|
436
440
|
* @schema HtmlConfiguration#parser
|
|
437
441
|
*/
|
|
@@ -661,43 +665,45 @@ export interface OverridePattern {
|
|
|
661
665
|
*/
|
|
662
666
|
export declare function toJson_OverridePattern(obj: OverridePattern | undefined): Record<string, any> | undefined;
|
|
663
667
|
/**
|
|
664
|
-
*
|
|
668
|
+
* Settings for integrating Biome with version control.
|
|
665
669
|
*
|
|
666
670
|
* @schema VcsConfiguration
|
|
667
671
|
*/
|
|
668
672
|
export interface VcsConfiguration {
|
|
669
673
|
/**
|
|
670
|
-
* The
|
|
674
|
+
* The version control client.
|
|
671
675
|
*
|
|
672
676
|
* @schema VcsConfiguration#clientKind
|
|
673
677
|
*/
|
|
674
678
|
readonly clientKind?: VcsClientKind;
|
|
675
679
|
/**
|
|
676
|
-
* The
|
|
680
|
+
* The project's default branch.
|
|
677
681
|
*
|
|
678
682
|
* @schema VcsConfiguration#defaultBranch
|
|
679
683
|
*/
|
|
680
684
|
readonly defaultBranch?: string;
|
|
681
685
|
/**
|
|
682
|
-
* Whether Biome should integrate
|
|
686
|
+
* Whether Biome should integrate with the version control client.
|
|
683
687
|
*
|
|
684
688
|
* @schema VcsConfiguration#enabled
|
|
685
689
|
*/
|
|
686
690
|
readonly enabled?: boolean;
|
|
687
691
|
/**
|
|
688
|
-
*
|
|
689
|
-
* folder where `biome.json` was found.
|
|
692
|
+
* Sets the directory where Biome checks for version control files.
|
|
690
693
|
*
|
|
691
|
-
*
|
|
692
|
-
*
|
|
693
|
-
* will be emitted
|
|
694
|
+
* Defaults to the directory containing `biome.json` or `biome.jsonc`. If no configuration is
|
|
695
|
+
* found, Biome uses the current working directory.
|
|
694
696
|
*
|
|
697
|
+
* If neither directory is available, Biome disables version control integration and emits a
|
|
698
|
+
* diagnostic.
|
|
699
|
+
*
|
|
700
|
+
* @default the directory containing `biome.json` or `biome.jsonc`. If no configuration is
|
|
695
701
|
* @schema VcsConfiguration#root
|
|
696
702
|
*/
|
|
697
703
|
readonly root?: string;
|
|
698
704
|
/**
|
|
699
|
-
*
|
|
700
|
-
*
|
|
705
|
+
* When `true`, Biome ignores files listed in `.gitignore`, `.ignore`, and Git's local
|
|
706
|
+
* exclude file.
|
|
701
707
|
*
|
|
702
708
|
* @schema VcsConfiguration#useIgnoreFile
|
|
703
709
|
*/
|
|
@@ -735,13 +741,13 @@ export interface Actions {
|
|
|
735
741
|
*/
|
|
736
742
|
export declare function toJson_Actions(obj: Actions | undefined): Record<string, any> | undefined;
|
|
737
743
|
/**
|
|
738
|
-
* Options that
|
|
744
|
+
* Options that change how CSS assist behaves.
|
|
739
745
|
*
|
|
740
746
|
* @schema CssAssistConfiguration
|
|
741
747
|
*/
|
|
742
748
|
export interface CssAssistConfiguration {
|
|
743
749
|
/**
|
|
744
|
-
*
|
|
750
|
+
* Controls assist actions for CSS files.
|
|
745
751
|
*
|
|
746
752
|
* @schema CssAssistConfiguration#enabled
|
|
747
753
|
*/
|
|
@@ -753,73 +759,66 @@ export interface CssAssistConfiguration {
|
|
|
753
759
|
*/
|
|
754
760
|
export declare function toJson_CssAssistConfiguration(obj: CssAssistConfiguration | undefined): Record<string, any> | undefined;
|
|
755
761
|
/**
|
|
756
|
-
* Options that
|
|
762
|
+
* Options that change how the CSS formatter behaves.
|
|
757
763
|
*
|
|
758
764
|
* @schema CssFormatterConfiguration
|
|
759
765
|
*/
|
|
760
766
|
export interface CssFormatterConfiguration {
|
|
761
767
|
/**
|
|
762
|
-
*
|
|
763
|
-
*
|
|
764
|
-
*
|
|
765
|
-
*
|
|
768
|
+
* Controls spaces inside CSS parentheses and square brackets when their content fits on one
|
|
769
|
+
* line. When enabled, `rgb(0, 0, 0)` becomes `rgb( 0, 0, 0 )` and `[data-attr]` becomes
|
|
770
|
+
* `[ data-attr ]`. Empty delimiters are unchanged.
|
|
771
|
+
*
|
|
772
|
+
* If unset, inherits the global delimiter spacing setting.
|
|
766
773
|
*
|
|
767
|
-
* @default false.
|
|
768
774
|
* @schema CssFormatterConfiguration#delimiterSpacing
|
|
769
775
|
*/
|
|
770
776
|
readonly delimiterSpacing?: boolean;
|
|
771
777
|
/**
|
|
772
|
-
*
|
|
778
|
+
* Controls the formatter for CSS and languages that extend it.
|
|
773
779
|
*
|
|
774
780
|
* @schema CssFormatterConfiguration#enabled
|
|
775
781
|
*/
|
|
776
782
|
readonly enabled?: boolean;
|
|
777
783
|
/**
|
|
778
|
-
* The indent style applied to CSS
|
|
784
|
+
* The indent style applied to CSS and languages that extend it. If unset, inherits the global
|
|
785
|
+
* indentation style.
|
|
779
786
|
*
|
|
780
787
|
* @schema CssFormatterConfiguration#indentStyle
|
|
781
788
|
*/
|
|
782
789
|
readonly indentStyle?: IndentStyle;
|
|
783
790
|
/**
|
|
784
|
-
* The
|
|
791
|
+
* The indentation width applied to CSS and languages that extend it. If unset, inherits the
|
|
792
|
+
* global indentation width.
|
|
785
793
|
*
|
|
786
|
-
* @default 2.
|
|
787
794
|
* @schema CssFormatterConfiguration#indentWidth
|
|
788
795
|
*/
|
|
789
796
|
readonly indentWidth?: number;
|
|
790
797
|
/**
|
|
791
|
-
* The
|
|
798
|
+
* The line ending applied to CSS and languages that extend it. If unset, inherits the global
|
|
799
|
+
* line ending.
|
|
792
800
|
*
|
|
793
801
|
* @schema CssFormatterConfiguration#lineEnding
|
|
794
802
|
*/
|
|
795
803
|
readonly lineEnding?: LineEnding;
|
|
796
804
|
/**
|
|
797
|
-
*
|
|
805
|
+
* The maximum line width for CSS and languages that extend it. If unset, inherits the global
|
|
806
|
+
* line width.
|
|
798
807
|
*
|
|
799
|
-
* @default 80.
|
|
800
808
|
* @schema CssFormatterConfiguration#lineWidth
|
|
801
809
|
*/
|
|
802
810
|
readonly lineWidth?: number;
|
|
803
811
|
/**
|
|
804
|
-
* The type of quotes used in CSS code. Defaults to double
|
|
812
|
+
* The type of quotes used in CSS code. Defaults to `double`.
|
|
805
813
|
*
|
|
806
|
-
* @default double
|
|
814
|
+
* @default double`.
|
|
807
815
|
* @schema CssFormatterConfiguration#quoteStyle
|
|
808
816
|
*/
|
|
809
817
|
readonly quoteStyle?: QuoteStyle;
|
|
810
818
|
/**
|
|
811
|
-
* Whether to add a trailing newline at the end of the file.
|
|
812
|
-
*
|
|
813
|
-
* Setting this option to `false` is **highly discouraged** because it could cause many problems with other tools:
|
|
814
|
-
* - https://thoughtbot.com/blog/no-newline-at-end-of-file
|
|
815
|
-
* - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
|
|
816
|
-
* - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
|
|
817
|
-
*
|
|
818
|
-
* Disable the option at your own risk.
|
|
819
|
-
*
|
|
820
|
-
* Defaults to true.
|
|
819
|
+
* Whether to add a trailing newline at the end of the file. If unset, inherits the global
|
|
820
|
+
* trailing newline setting.
|
|
821
821
|
*
|
|
822
|
-
* @default true.
|
|
823
822
|
* @schema CssFormatterConfiguration#trailingNewline
|
|
824
823
|
*/
|
|
825
824
|
readonly trailingNewline?: boolean;
|
|
@@ -830,13 +829,13 @@ export interface CssFormatterConfiguration {
|
|
|
830
829
|
*/
|
|
831
830
|
export declare function toJson_CssFormatterConfiguration(obj: CssFormatterConfiguration | undefined): Record<string, any> | undefined;
|
|
832
831
|
/**
|
|
833
|
-
* Options that
|
|
832
|
+
* Options that change how the CSS linter behaves.
|
|
834
833
|
*
|
|
835
834
|
* @schema CssLinterConfiguration
|
|
836
835
|
*/
|
|
837
836
|
export interface CssLinterConfiguration {
|
|
838
837
|
/**
|
|
839
|
-
*
|
|
838
|
+
* Controls the linter for CSS files.
|
|
840
839
|
*
|
|
841
840
|
* @schema CssLinterConfiguration#enabled
|
|
842
841
|
*/
|
|
@@ -848,19 +847,19 @@ export interface CssLinterConfiguration {
|
|
|
848
847
|
*/
|
|
849
848
|
export declare function toJson_CssLinterConfiguration(obj: CssLinterConfiguration | undefined): Record<string, any> | undefined;
|
|
850
849
|
/**
|
|
851
|
-
* Options that
|
|
850
|
+
* Options that change how the CSS parser behaves.
|
|
852
851
|
*
|
|
853
852
|
* @schema CssParserConfiguration
|
|
854
853
|
*/
|
|
855
854
|
export interface CssParserConfiguration {
|
|
856
855
|
/**
|
|
857
|
-
*
|
|
856
|
+
* Allows comments to appear on incorrect lines in `.css` files.
|
|
858
857
|
*
|
|
859
858
|
* @schema CssParserConfiguration#allowWrongLineComments
|
|
860
859
|
*/
|
|
861
860
|
readonly allowWrongLineComments?: boolean;
|
|
862
861
|
/**
|
|
863
|
-
* Enables parsing of CSS Modules
|
|
862
|
+
* Enables parsing of CSS Modules-specific features. Enable this feature only
|
|
864
863
|
* when your files don't end in `.module.css`.
|
|
865
864
|
*
|
|
866
865
|
* @schema CssParserConfiguration#cssModules
|
|
@@ -891,12 +890,12 @@ export declare enum AttributePosition {
|
|
|
891
890
|
* @schema Expand
|
|
892
891
|
*/
|
|
893
892
|
export declare enum Expand {
|
|
894
|
-
/** Objects are expanded when the first property has a leading newline. Arrays
|
|
895
|
-
|
|
893
|
+
/** Objects are expanded when the first property has a leading newline. Arrays remain on one
|
|
894
|
+
line if they fit. (auto) */
|
|
896
895
|
AUTO = "auto",
|
|
897
896
|
/** Objects and arrays are always expanded. (always) */
|
|
898
897
|
ALWAYS = "always",
|
|
899
|
-
/** Objects and arrays
|
|
898
|
+
/** Objects and arrays remain on one line if they fit. (never) */
|
|
900
899
|
NEVER = "never"
|
|
901
900
|
}
|
|
902
901
|
/**
|
|
@@ -922,13 +921,13 @@ export declare enum LineEnding {
|
|
|
922
921
|
AUTO = "auto"
|
|
923
922
|
}
|
|
924
923
|
/**
|
|
925
|
-
* Options that
|
|
924
|
+
* Options that change how GraphQL assist behaves.
|
|
926
925
|
*
|
|
927
926
|
* @schema GraphqlAssistConfiguration
|
|
928
927
|
*/
|
|
929
928
|
export interface GraphqlAssistConfiguration {
|
|
930
929
|
/**
|
|
931
|
-
*
|
|
930
|
+
* Controls assist actions for GraphQL files.
|
|
932
931
|
*
|
|
933
932
|
* @schema GraphqlAssistConfiguration#enabled
|
|
934
933
|
*/
|
|
@@ -940,70 +939,60 @@ export interface GraphqlAssistConfiguration {
|
|
|
940
939
|
*/
|
|
941
940
|
export declare function toJson_GraphqlAssistConfiguration(obj: GraphqlAssistConfiguration | undefined): Record<string, any> | undefined;
|
|
942
941
|
/**
|
|
943
|
-
* Options that
|
|
942
|
+
* Options that change how the GraphQL formatter behaves.
|
|
944
943
|
*
|
|
945
944
|
* @schema GraphqlFormatterConfiguration
|
|
946
945
|
*/
|
|
947
946
|
export interface GraphqlFormatterConfiguration {
|
|
948
947
|
/**
|
|
949
|
-
* Whether to insert spaces
|
|
948
|
+
* Whether to insert spaces inside braces in object literals. If unset, inherits the global
|
|
949
|
+
* bracket spacing setting.
|
|
950
950
|
*
|
|
951
|
-
* @default true.
|
|
952
951
|
* @schema GraphqlFormatterConfiguration#bracketSpacing
|
|
953
952
|
*/
|
|
954
953
|
readonly bracketSpacing?: boolean;
|
|
955
954
|
/**
|
|
956
|
-
*
|
|
955
|
+
* Controls the formatter for GraphQL files.
|
|
957
956
|
*
|
|
958
957
|
* @schema GraphqlFormatterConfiguration#enabled
|
|
959
958
|
*/
|
|
960
959
|
readonly enabled?: boolean;
|
|
961
960
|
/**
|
|
962
|
-
* The indent style applied to GraphQL files.
|
|
961
|
+
* The indent style applied to GraphQL files. If unset, inherits the global indentation style.
|
|
963
962
|
*
|
|
964
963
|
* @schema GraphqlFormatterConfiguration#indentStyle
|
|
965
964
|
*/
|
|
966
965
|
readonly indentStyle?: IndentStyle;
|
|
967
966
|
/**
|
|
968
|
-
* The
|
|
967
|
+
* The indentation width applied to GraphQL files. If unset, inherits the global indentation
|
|
968
|
+
* width.
|
|
969
969
|
*
|
|
970
|
-
* @default 2.
|
|
971
970
|
* @schema GraphqlFormatterConfiguration#indentWidth
|
|
972
971
|
*/
|
|
973
972
|
readonly indentWidth?: number;
|
|
974
973
|
/**
|
|
975
|
-
* The
|
|
974
|
+
* The line ending applied to GraphQL files. If unset, inherits the global line ending.
|
|
976
975
|
*
|
|
977
976
|
* @schema GraphqlFormatterConfiguration#lineEnding
|
|
978
977
|
*/
|
|
979
978
|
readonly lineEnding?: LineEnding;
|
|
980
979
|
/**
|
|
981
|
-
*
|
|
980
|
+
* The maximum line width for GraphQL files. If unset, inherits the global line width.
|
|
982
981
|
*
|
|
983
|
-
* @default 80.
|
|
984
982
|
* @schema GraphqlFormatterConfiguration#lineWidth
|
|
985
983
|
*/
|
|
986
984
|
readonly lineWidth?: number;
|
|
987
985
|
/**
|
|
988
|
-
* The type of quotes used in GraphQL code. Defaults to double
|
|
986
|
+
* The type of quotes used in GraphQL code. Defaults to `double`.
|
|
989
987
|
*
|
|
990
|
-
* @default double
|
|
988
|
+
* @default double`.
|
|
991
989
|
* @schema GraphqlFormatterConfiguration#quoteStyle
|
|
992
990
|
*/
|
|
993
991
|
readonly quoteStyle?: QuoteStyle;
|
|
994
992
|
/**
|
|
995
|
-
* Whether to add a trailing newline at the end of the file.
|
|
993
|
+
* Whether to add a trailing newline at the end of the file. If unset, inherits the global
|
|
994
|
+
* trailing newline setting.
|
|
996
995
|
*
|
|
997
|
-
* Setting this option to `false` is **highly discouraged** because it could cause many problems with other tools:
|
|
998
|
-
* - https://thoughtbot.com/blog/no-newline-at-end-of-file
|
|
999
|
-
* - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
|
|
1000
|
-
* - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
|
|
1001
|
-
*
|
|
1002
|
-
* Disable the option at your own risk.
|
|
1003
|
-
*
|
|
1004
|
-
* Defaults to true.
|
|
1005
|
-
*
|
|
1006
|
-
* @default true.
|
|
1007
996
|
* @schema GraphqlFormatterConfiguration#trailingNewline
|
|
1008
997
|
*/
|
|
1009
998
|
readonly trailingNewline?: boolean;
|
|
@@ -1020,7 +1009,7 @@ export declare function toJson_GraphqlFormatterConfiguration(obj: GraphqlFormatt
|
|
|
1020
1009
|
*/
|
|
1021
1010
|
export interface GraphqlLinterConfiguration {
|
|
1022
1011
|
/**
|
|
1023
|
-
*
|
|
1012
|
+
* Controls the linter for GraphQL files.
|
|
1024
1013
|
*
|
|
1025
1014
|
* @schema GraphqlLinterConfiguration#enabled
|
|
1026
1015
|
*/
|
|
@@ -1032,11 +1021,13 @@ export interface GraphqlLinterConfiguration {
|
|
|
1032
1021
|
*/
|
|
1033
1022
|
export declare function toJson_GraphqlLinterConfiguration(obj: GraphqlLinterConfiguration | undefined): Record<string, any> | undefined;
|
|
1034
1023
|
/**
|
|
1024
|
+
* Options that change how GritQL assist behaves.
|
|
1025
|
+
*
|
|
1035
1026
|
* @schema GritAssistConfiguration
|
|
1036
1027
|
*/
|
|
1037
1028
|
export interface GritAssistConfiguration {
|
|
1038
1029
|
/**
|
|
1039
|
-
*
|
|
1030
|
+
* Controls assist actions for GritQL files.
|
|
1040
1031
|
*
|
|
1041
1032
|
* @schema GritAssistConfiguration#enabled
|
|
1042
1033
|
*/
|
|
@@ -1048,54 +1039,46 @@ export interface GritAssistConfiguration {
|
|
|
1048
1039
|
*/
|
|
1049
1040
|
export declare function toJson_GritAssistConfiguration(obj: GritAssistConfiguration | undefined): Record<string, any> | undefined;
|
|
1050
1041
|
/**
|
|
1042
|
+
* Options that change how the GritQL formatter behaves.
|
|
1043
|
+
*
|
|
1051
1044
|
* @schema GritFormatterConfiguration
|
|
1052
1045
|
*/
|
|
1053
1046
|
export interface GritFormatterConfiguration {
|
|
1054
1047
|
/**
|
|
1055
|
-
*
|
|
1048
|
+
* Controls the formatter for GritQL files.
|
|
1056
1049
|
*
|
|
1057
1050
|
* @schema GritFormatterConfiguration#enabled
|
|
1058
1051
|
*/
|
|
1059
1052
|
readonly enabled?: boolean;
|
|
1060
1053
|
/**
|
|
1061
|
-
* The indent style applied to
|
|
1054
|
+
* The indent style applied to GritQL files. If unset, inherits the global indentation style.
|
|
1062
1055
|
*
|
|
1063
1056
|
* @schema GritFormatterConfiguration#indentStyle
|
|
1064
1057
|
*/
|
|
1065
1058
|
readonly indentStyle?: IndentStyle;
|
|
1066
1059
|
/**
|
|
1067
|
-
* The
|
|
1060
|
+
* The indentation width applied to GritQL files. If unset, inherits the global indentation
|
|
1061
|
+
* width.
|
|
1068
1062
|
*
|
|
1069
|
-
* @default 2.
|
|
1070
1063
|
* @schema GritFormatterConfiguration#indentWidth
|
|
1071
1064
|
*/
|
|
1072
1065
|
readonly indentWidth?: number;
|
|
1073
1066
|
/**
|
|
1074
|
-
* The
|
|
1067
|
+
* The line ending applied to GritQL files. If unset, inherits the global line ending.
|
|
1075
1068
|
*
|
|
1076
1069
|
* @schema GritFormatterConfiguration#lineEnding
|
|
1077
1070
|
*/
|
|
1078
1071
|
readonly lineEnding?: LineEnding;
|
|
1079
1072
|
/**
|
|
1080
|
-
*
|
|
1073
|
+
* The maximum line width for GritQL files. If unset, inherits the global line width.
|
|
1081
1074
|
*
|
|
1082
|
-
* @default 80.
|
|
1083
1075
|
* @schema GritFormatterConfiguration#lineWidth
|
|
1084
1076
|
*/
|
|
1085
1077
|
readonly lineWidth?: number;
|
|
1086
1078
|
/**
|
|
1087
|
-
* Whether to add a trailing newline at the end of the file.
|
|
1088
|
-
*
|
|
1089
|
-
* Setting this option to `false` is **highly discouraged** because it could cause many problems with other tools:
|
|
1090
|
-
* - https://thoughtbot.com/blog/no-newline-at-end-of-file
|
|
1091
|
-
* - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
|
|
1092
|
-
* - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
|
|
1093
|
-
*
|
|
1094
|
-
* Disable the option at your own risk.
|
|
1079
|
+
* Whether to add a trailing newline at the end of the file. If unset, inherits the global
|
|
1080
|
+
* trailing newline setting.
|
|
1095
1081
|
*
|
|
1096
|
-
* Defaults to true.
|
|
1097
|
-
*
|
|
1098
|
-
* @default true.
|
|
1099
1082
|
* @schema GritFormatterConfiguration#trailingNewline
|
|
1100
1083
|
*/
|
|
1101
1084
|
readonly trailingNewline?: boolean;
|
|
@@ -1106,11 +1089,13 @@ export interface GritFormatterConfiguration {
|
|
|
1106
1089
|
*/
|
|
1107
1090
|
export declare function toJson_GritFormatterConfiguration(obj: GritFormatterConfiguration | undefined): Record<string, any> | undefined;
|
|
1108
1091
|
/**
|
|
1092
|
+
* Options that change how the GritQL linter behaves.
|
|
1093
|
+
*
|
|
1109
1094
|
* @schema GritLinterConfiguration
|
|
1110
1095
|
*/
|
|
1111
1096
|
export interface GritLinterConfiguration {
|
|
1112
1097
|
/**
|
|
1113
|
-
*
|
|
1098
|
+
* Controls the linter for GritQL files.
|
|
1114
1099
|
*
|
|
1115
1100
|
* @schema GritLinterConfiguration#enabled
|
|
1116
1101
|
*/
|
|
@@ -1122,13 +1107,13 @@ export interface GritLinterConfiguration {
|
|
|
1122
1107
|
*/
|
|
1123
1108
|
export declare function toJson_GritLinterConfiguration(obj: GritLinterConfiguration | undefined): Record<string, any> | undefined;
|
|
1124
1109
|
/**
|
|
1125
|
-
* Options that
|
|
1110
|
+
* Options that change how HTML assist behaves.
|
|
1126
1111
|
*
|
|
1127
1112
|
* @schema HtmlAssistConfiguration
|
|
1128
1113
|
*/
|
|
1129
1114
|
export interface HtmlAssistConfiguration {
|
|
1130
1115
|
/**
|
|
1131
|
-
*
|
|
1116
|
+
* Controls assist actions for HTML and languages that extend it.
|
|
1132
1117
|
*
|
|
1133
1118
|
* @schema HtmlAssistConfiguration#enabled
|
|
1134
1119
|
*/
|
|
@@ -1140,91 +1125,87 @@ export interface HtmlAssistConfiguration {
|
|
|
1140
1125
|
*/
|
|
1141
1126
|
export declare function toJson_HtmlAssistConfiguration(obj: HtmlAssistConfiguration | undefined): Record<string, any> | undefined;
|
|
1142
1127
|
/**
|
|
1143
|
-
* Options that
|
|
1128
|
+
* Options that change how the HTML formatter behaves.
|
|
1144
1129
|
*
|
|
1145
1130
|
* @schema HtmlFormatterConfiguration
|
|
1146
1131
|
*/
|
|
1147
1132
|
export interface HtmlFormatterConfiguration {
|
|
1148
1133
|
/**
|
|
1149
|
-
* The attribute position style in HTML elements.
|
|
1134
|
+
* The attribute position style in HTML elements. If unset, inherits the global attribute
|
|
1135
|
+
* position setting.
|
|
1150
1136
|
*
|
|
1151
|
-
* @default auto.
|
|
1152
1137
|
* @schema HtmlFormatterConfiguration#attributePosition
|
|
1153
1138
|
*/
|
|
1154
1139
|
readonly attributePosition?: AttributePosition;
|
|
1155
1140
|
/**
|
|
1156
|
-
* Whether to
|
|
1141
|
+
* Whether to place the closing bracket of a multiline HTML tag at the end of the last line
|
|
1142
|
+
* instead of on its own line. If unset, inherits the global `bracketSameLine` setting.
|
|
1157
1143
|
*
|
|
1158
|
-
* @default false.
|
|
1159
1144
|
* @schema HtmlFormatterConfiguration#bracketSameLine
|
|
1160
1145
|
*/
|
|
1161
1146
|
readonly bracketSameLine?: boolean;
|
|
1162
1147
|
/**
|
|
1163
|
-
*
|
|
1148
|
+
* Controls the formatter for HTML and languages that extend it.
|
|
1164
1149
|
*
|
|
1165
1150
|
* @schema HtmlFormatterConfiguration#enabled
|
|
1166
1151
|
*/
|
|
1167
1152
|
readonly enabled?: boolean;
|
|
1168
1153
|
/**
|
|
1169
|
-
* Whether to indent
|
|
1154
|
+
* Whether to indent `<script>` and `<style>` tags in HTML and languages that extend it.
|
|
1155
|
+
* Defaults to `false`.
|
|
1170
1156
|
*
|
|
1171
|
-
* @default false
|
|
1157
|
+
* @default false`.
|
|
1172
1158
|
* @schema HtmlFormatterConfiguration#indentScriptAndStyle
|
|
1173
1159
|
*/
|
|
1174
1160
|
readonly indentScriptAndStyle?: boolean;
|
|
1175
1161
|
/**
|
|
1176
|
-
* The indent style applied to HTML
|
|
1162
|
+
* The indent style applied to HTML and languages that extend it. If unset, inherits the global
|
|
1163
|
+
* indentation style.
|
|
1177
1164
|
*
|
|
1178
1165
|
* @schema HtmlFormatterConfiguration#indentStyle
|
|
1179
1166
|
*/
|
|
1180
1167
|
readonly indentStyle?: IndentStyle;
|
|
1181
1168
|
/**
|
|
1182
|
-
* The
|
|
1169
|
+
* The indentation width applied to HTML and languages that extend it. If unset, inherits the
|
|
1170
|
+
* global indentation width.
|
|
1183
1171
|
*
|
|
1184
|
-
* @default 2.
|
|
1185
1172
|
* @schema HtmlFormatterConfiguration#indentWidth
|
|
1186
1173
|
*/
|
|
1187
1174
|
readonly indentWidth?: number;
|
|
1188
1175
|
/**
|
|
1189
|
-
* The
|
|
1176
|
+
* The line ending applied to HTML and languages that extend it. If unset, inherits the global
|
|
1177
|
+
* line ending.
|
|
1190
1178
|
*
|
|
1191
1179
|
* @schema HtmlFormatterConfiguration#lineEnding
|
|
1192
1180
|
*/
|
|
1193
1181
|
readonly lineEnding?: LineEnding;
|
|
1194
1182
|
/**
|
|
1195
|
-
*
|
|
1183
|
+
* The maximum line width for HTML and languages that extend it. If unset, inherits the global
|
|
1184
|
+
* line width.
|
|
1196
1185
|
*
|
|
1197
|
-
* @default 80.
|
|
1198
1186
|
* @schema HtmlFormatterConfiguration#lineWidth
|
|
1199
1187
|
*/
|
|
1200
1188
|
readonly lineWidth?: number;
|
|
1201
1189
|
/**
|
|
1202
|
-
*
|
|
1190
|
+
* Controls whether void elements are self-closed. Defaults to `never`.
|
|
1203
1191
|
*
|
|
1204
|
-
* @default never
|
|
1192
|
+
* @default never`.
|
|
1205
1193
|
* @schema HtmlFormatterConfiguration#selfCloseVoidElements
|
|
1206
1194
|
*/
|
|
1207
1195
|
readonly selfCloseVoidElements?: SelfCloseVoidElements;
|
|
1208
1196
|
/**
|
|
1209
|
-
* Whether to add a trailing newline at the end of the file.
|
|
1210
|
-
*
|
|
1211
|
-
*
|
|
1212
|
-
* - https://thoughtbot.com/blog/no-newline-at-end-of-file
|
|
1213
|
-
* - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
|
|
1214
|
-
* - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
|
|
1197
|
+
* Whether to add a trailing newline at the end of the file. Unlike other language-specific
|
|
1198
|
+
* trailing newline settings, this option defaults to `true` instead of inheriting the global
|
|
1199
|
+
* setting.
|
|
1215
1200
|
*
|
|
1216
|
-
* Disable the option at your own risk.
|
|
1217
|
-
*
|
|
1218
|
-
* Defaults to true.
|
|
1219
|
-
*
|
|
1220
|
-
* @default true.
|
|
1221
1201
|
* @schema HtmlFormatterConfiguration#trailingNewline
|
|
1222
1202
|
*/
|
|
1223
1203
|
readonly trailingNewline?: boolean;
|
|
1224
1204
|
/**
|
|
1225
|
-
* Whether to account for whitespace sensitivity when formatting HTML
|
|
1205
|
+
* Whether to account for whitespace sensitivity when formatting HTML and languages that
|
|
1206
|
+
* extend it. Defaults to `css`.
|
|
1226
1207
|
*
|
|
1227
|
-
* @default css
|
|
1208
|
+
* @default css`.
|
|
1228
1209
|
* @schema HtmlFormatterConfiguration#whitespaceSensitivity
|
|
1229
1210
|
*/
|
|
1230
1211
|
readonly whitespaceSensitivity?: WhitespaceSensitivity;
|
|
@@ -1235,13 +1216,13 @@ export interface HtmlFormatterConfiguration {
|
|
|
1235
1216
|
*/
|
|
1236
1217
|
export declare function toJson_HtmlFormatterConfiguration(obj: HtmlFormatterConfiguration | undefined): Record<string, any> | undefined;
|
|
1237
1218
|
/**
|
|
1238
|
-
* Options that
|
|
1219
|
+
* Options that change how the HTML linter behaves.
|
|
1239
1220
|
*
|
|
1240
1221
|
* @schema HtmlLinterConfiguration
|
|
1241
1222
|
*/
|
|
1242
1223
|
export interface HtmlLinterConfiguration {
|
|
1243
1224
|
/**
|
|
1244
|
-
*
|
|
1225
|
+
* Controls the linter for HTML and languages that extend it.
|
|
1245
1226
|
*
|
|
1246
1227
|
* @schema HtmlLinterConfiguration#enabled
|
|
1247
1228
|
*/
|
|
@@ -1253,19 +1234,20 @@ export interface HtmlLinterConfiguration {
|
|
|
1253
1234
|
*/
|
|
1254
1235
|
export declare function toJson_HtmlLinterConfiguration(obj: HtmlLinterConfiguration | undefined): Record<string, any> | undefined;
|
|
1255
1236
|
/**
|
|
1256
|
-
* Options that
|
|
1237
|
+
* Options that change how the HTML parser behaves.
|
|
1257
1238
|
*
|
|
1258
1239
|
* @schema HtmlParserConfiguration
|
|
1259
1240
|
*/
|
|
1260
1241
|
export interface HtmlParserConfiguration {
|
|
1261
1242
|
/**
|
|
1262
|
-
* Enables
|
|
1243
|
+
* Enables parsing double text expressions such as `{{ expression }}` inside `.html` files.
|
|
1263
1244
|
*
|
|
1264
1245
|
* @schema HtmlParserConfiguration#interpolation
|
|
1265
1246
|
*/
|
|
1266
1247
|
readonly interpolation?: boolean;
|
|
1267
1248
|
/**
|
|
1268
|
-
* Enables parsing
|
|
1249
|
+
* Enables parsing Vue syntax (`v-if`, `v-bind`, etc.) in `.html` files. Enabling this option
|
|
1250
|
+
* also enables `interpolation` implicitly.
|
|
1269
1251
|
*
|
|
1270
1252
|
* Biome will already automatically enable Vue parsing in `.vue` files, so you probably don't need
|
|
1271
1253
|
* to enable this option. This only affects `.html` files, and does not change how `.vue`, `.svelte`,
|
|
@@ -1287,7 +1269,7 @@ export declare function toJson_HtmlParserConfiguration(obj: HtmlParserConfigurat
|
|
|
1287
1269
|
*/
|
|
1288
1270
|
export interface JsAssistConfiguration {
|
|
1289
1271
|
/**
|
|
1290
|
-
*
|
|
1272
|
+
* Controls assist actions for JavaScript and languages that extend it.
|
|
1291
1273
|
*
|
|
1292
1274
|
* @schema JsAssistConfiguration#enabled
|
|
1293
1275
|
*/
|
|
@@ -1305,146 +1287,140 @@ export declare function toJson_JsAssistConfiguration(obj: JsAssistConfiguration
|
|
|
1305
1287
|
*/
|
|
1306
1288
|
export interface JsFormatterConfiguration {
|
|
1307
1289
|
/**
|
|
1308
|
-
* Whether to add
|
|
1290
|
+
* Whether to add parentheses around arrow function parameters. Defaults to `always`.
|
|
1309
1291
|
*
|
|
1310
|
-
* @default always
|
|
1292
|
+
* @default always`.
|
|
1311
1293
|
* @schema JsFormatterConfiguration#arrowParentheses
|
|
1312
1294
|
*/
|
|
1313
1295
|
readonly arrowParentheses?: ArrowParentheses;
|
|
1314
1296
|
/**
|
|
1315
|
-
* The attribute position style in JSX elements.
|
|
1297
|
+
* The attribute position style in JSX elements. If unset, inherits the global attribute
|
|
1298
|
+
* position setting.
|
|
1316
1299
|
*
|
|
1317
|
-
* @default auto.
|
|
1318
1300
|
* @schema JsFormatterConfiguration#attributePosition
|
|
1319
1301
|
*/
|
|
1320
1302
|
readonly attributePosition?: AttributePosition;
|
|
1321
1303
|
/**
|
|
1322
|
-
* Whether to hug the closing bracket of multiline HTML/JSX tags to the end of the last line,
|
|
1304
|
+
* Whether to hug the closing bracket of multiline HTML/JSX tags to the end of the last line,
|
|
1305
|
+
* rather than being alone on the following line. If unset, inherits the global bracket
|
|
1306
|
+
* placement setting.
|
|
1323
1307
|
*
|
|
1324
|
-
* @default false.
|
|
1325
1308
|
* @schema JsFormatterConfiguration#bracketSameLine
|
|
1326
1309
|
*/
|
|
1327
1310
|
readonly bracketSameLine?: boolean;
|
|
1328
1311
|
/**
|
|
1329
|
-
* Whether to insert spaces
|
|
1312
|
+
* Whether to insert spaces inside braces in object literals. If unset, inherits the global
|
|
1313
|
+
* bracket spacing setting.
|
|
1330
1314
|
*
|
|
1331
|
-
* @default true.
|
|
1332
1315
|
* @schema JsFormatterConfiguration#bracketSpacing
|
|
1333
1316
|
*/
|
|
1334
1317
|
readonly bracketSpacing?: boolean;
|
|
1335
1318
|
/**
|
|
1336
|
-
*
|
|
1337
|
-
*
|
|
1338
|
-
*
|
|
1339
|
-
*
|
|
1340
|
-
*
|
|
1341
|
-
*
|
|
1342
|
-
*
|
|
1343
|
-
*
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1346
|
-
* @default false.
|
|
1319
|
+
* Controls spaces immediately inside supported JavaScript and TypeScript delimiters when their
|
|
1320
|
+
* content fits on one line. It doesn't add spaces before opening delimiters or inside empty
|
|
1321
|
+
* delimiters.
|
|
1322
|
+
*
|
|
1323
|
+
* It affects parentheses, square brackets, template interpolations, TypeScript angle brackets,
|
|
1324
|
+
* JSX expression braces, and logical NOT. In operator chains, only the final operator receives
|
|
1325
|
+
* a following space.
|
|
1326
|
+
*
|
|
1327
|
+
* If unset, inherits the global delimiter spacing setting.
|
|
1328
|
+
*
|
|
1347
1329
|
* @schema JsFormatterConfiguration#delimiterSpacing
|
|
1348
1330
|
*/
|
|
1349
1331
|
readonly delimiterSpacing?: boolean;
|
|
1350
1332
|
/**
|
|
1351
|
-
*
|
|
1333
|
+
* Controls the formatter for JavaScript and languages that extend it.
|
|
1352
1334
|
*
|
|
1353
1335
|
* @schema JsFormatterConfiguration#enabled
|
|
1354
1336
|
*/
|
|
1355
1337
|
readonly enabled?: boolean;
|
|
1356
1338
|
/**
|
|
1357
|
-
*
|
|
1358
|
-
*
|
|
1359
|
-
*
|
|
1360
|
-
* When set to `always`, these literals are formatted on multiple lines, regardless of length of the list.
|
|
1361
|
-
* When set to `never`, these literals are formatted on a single line if it fits in the line.
|
|
1362
|
-
* When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
|
|
1339
|
+
* Uses the same `auto`, `always`, and `never` behavior as the global expansion setting.
|
|
1340
|
+
*
|
|
1341
|
+
* If unset, inherits the global expansion setting.
|
|
1363
1342
|
*
|
|
1364
|
-
* @default auto".
|
|
1365
1343
|
* @schema JsFormatterConfiguration#expand
|
|
1366
1344
|
*/
|
|
1367
1345
|
readonly expand?: Expand;
|
|
1368
1346
|
/**
|
|
1369
|
-
* The indent style applied to JavaScript
|
|
1347
|
+
* The indent style applied to JavaScript and languages that extend it. If unset, inherits the
|
|
1348
|
+
* global indentation style.
|
|
1370
1349
|
*
|
|
1371
1350
|
* @schema JsFormatterConfiguration#indentStyle
|
|
1372
1351
|
*/
|
|
1373
1352
|
readonly indentStyle?: IndentStyle;
|
|
1374
1353
|
/**
|
|
1375
|
-
* The
|
|
1354
|
+
* The indentation width applied to JavaScript and languages that extend it. If unset,
|
|
1355
|
+
* inherits the global indentation width.
|
|
1376
1356
|
*
|
|
1377
|
-
* @default 2.
|
|
1378
1357
|
* @schema JsFormatterConfiguration#indentWidth
|
|
1379
1358
|
*/
|
|
1380
1359
|
readonly indentWidth?: number;
|
|
1381
1360
|
/**
|
|
1382
|
-
* The type of quotes used in JSX. Defaults to double
|
|
1361
|
+
* The type of quotes used in JSX. Defaults to `double`.
|
|
1383
1362
|
*
|
|
1384
|
-
* @default double
|
|
1363
|
+
* @default double`.
|
|
1385
1364
|
* @schema JsFormatterConfiguration#jsxQuoteStyle
|
|
1386
1365
|
*/
|
|
1387
1366
|
readonly jsxQuoteStyle?: QuoteStyle;
|
|
1388
1367
|
/**
|
|
1389
|
-
* The
|
|
1368
|
+
* The line ending applied to JavaScript and languages that extend it. If unset, inherits the
|
|
1369
|
+
* global line ending.
|
|
1390
1370
|
*
|
|
1391
1371
|
* @schema JsFormatterConfiguration#lineEnding
|
|
1392
1372
|
*/
|
|
1393
1373
|
readonly lineEnding?: LineEnding;
|
|
1394
1374
|
/**
|
|
1395
|
-
*
|
|
1375
|
+
* The maximum line width applied to JavaScript and languages that extend it. If unset,
|
|
1376
|
+
* inherits the global line width.
|
|
1396
1377
|
*
|
|
1397
|
-
* @default 80.
|
|
1398
1378
|
* @schema JsFormatterConfiguration#lineWidth
|
|
1399
1379
|
*/
|
|
1400
1380
|
readonly lineWidth?: number;
|
|
1401
1381
|
/**
|
|
1402
|
-
* When breaking binary expressions into multiple lines, whether to break them before or after
|
|
1382
|
+
* When breaking binary expressions into multiple lines, whether to break them before or after
|
|
1383
|
+
* the binary operator. Defaults to `after`.
|
|
1403
1384
|
*
|
|
1404
|
-
* @default after
|
|
1385
|
+
* @default after`.
|
|
1405
1386
|
* @schema JsFormatterConfiguration#operatorLinebreak
|
|
1406
1387
|
*/
|
|
1407
1388
|
readonly operatorLinebreak?: OperatorLinebreak;
|
|
1408
1389
|
/**
|
|
1409
|
-
*
|
|
1390
|
+
* Controls when object properties are quoted. Defaults to `asNeeded` in configuration
|
|
1391
|
+
* (`as-needed` on the CLI).
|
|
1410
1392
|
*
|
|
1411
|
-
* @default asNeeded
|
|
1393
|
+
* @default asNeeded` in configuration
|
|
1412
1394
|
* @schema JsFormatterConfiguration#quoteProperties
|
|
1413
1395
|
*/
|
|
1414
1396
|
readonly quoteProperties?: QuoteProperties;
|
|
1415
1397
|
/**
|
|
1416
|
-
* The type of quotes used in JavaScript code. Defaults to double
|
|
1398
|
+
* The type of quotes used in JavaScript code. Defaults to `double`.
|
|
1417
1399
|
*
|
|
1418
|
-
* @default double
|
|
1400
|
+
* @default double`.
|
|
1419
1401
|
* @schema JsFormatterConfiguration#quoteStyle
|
|
1420
1402
|
*/
|
|
1421
1403
|
readonly quoteStyle?: QuoteStyle;
|
|
1422
1404
|
/**
|
|
1423
|
-
*
|
|
1405
|
+
* Prints semicolons after every statement or only where needed to avoid automatic semicolon
|
|
1406
|
+
* insertion hazards. Defaults to `always`.
|
|
1424
1407
|
*
|
|
1408
|
+
* @default always`.
|
|
1425
1409
|
* @schema JsFormatterConfiguration#semicolons
|
|
1426
1410
|
*/
|
|
1427
1411
|
readonly semicolons?: Semicolons;
|
|
1428
1412
|
/**
|
|
1429
|
-
*
|
|
1413
|
+
* Prints trailing commas wherever possible in multiline comma-separated structures. Defaults
|
|
1414
|
+
* to `all`.
|
|
1430
1415
|
*
|
|
1431
|
-
* @default all
|
|
1416
|
+
* @default all`.
|
|
1432
1417
|
* @schema JsFormatterConfiguration#trailingCommas
|
|
1433
1418
|
*/
|
|
1434
1419
|
readonly trailingCommas?: JsTrailingCommas;
|
|
1435
1420
|
/**
|
|
1436
|
-
* Whether to add a trailing newline at the end of the file.
|
|
1421
|
+
* Whether to add a trailing newline at the end of the file. If unset, inherits the global
|
|
1422
|
+
* trailing newline setting.
|
|
1437
1423
|
*
|
|
1438
|
-
* Setting this option to `false` is **highly discouraged** because it could cause many problems with other tools:
|
|
1439
|
-
* - https://thoughtbot.com/blog/no-newline-at-end-of-file
|
|
1440
|
-
* - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
|
|
1441
|
-
* - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
|
|
1442
|
-
*
|
|
1443
|
-
* Disable the option at your own risk.
|
|
1444
|
-
*
|
|
1445
|
-
* Defaults to true.
|
|
1446
|
-
*
|
|
1447
|
-
* @default true.
|
|
1448
1424
|
* @schema JsFormatterConfiguration#trailingNewline
|
|
1449
1425
|
*/
|
|
1450
1426
|
readonly trailingNewline?: boolean;
|
|
@@ -1481,7 +1457,7 @@ export declare enum JsxRuntime {
|
|
|
1481
1457
|
*/
|
|
1482
1458
|
export interface JsLinterConfiguration {
|
|
1483
1459
|
/**
|
|
1484
|
-
*
|
|
1460
|
+
* Controls the linter for JavaScript and languages that extend it.
|
|
1485
1461
|
*
|
|
1486
1462
|
* @schema JsLinterConfiguration#enabled
|
|
1487
1463
|
*/
|
|
@@ -1493,7 +1469,7 @@ export interface JsLinterConfiguration {
|
|
|
1493
1469
|
*/
|
|
1494
1470
|
export declare function toJson_JsLinterConfiguration(obj: JsLinterConfiguration | undefined): Record<string, any> | undefined;
|
|
1495
1471
|
/**
|
|
1496
|
-
* Options that
|
|
1472
|
+
* Options that change how the JavaScript parser behaves.
|
|
1497
1473
|
*
|
|
1498
1474
|
* @schema JsParserConfiguration
|
|
1499
1475
|
*/
|
|
@@ -1507,9 +1483,8 @@ export interface JsParserConfiguration {
|
|
|
1507
1483
|
*/
|
|
1508
1484
|
readonly gritMetavariables?: boolean;
|
|
1509
1485
|
/**
|
|
1510
|
-
* When enabled, files
|
|
1511
|
-
*
|
|
1512
|
-
* Defaults to `true`.
|
|
1486
|
+
* When enabled, files such as `.js`, `.mjs`, and `.cjs` may contain JSX syntax. Defaults to
|
|
1487
|
+
* `true`.
|
|
1513
1488
|
*
|
|
1514
1489
|
* @default true`.
|
|
1515
1490
|
* @schema JsParserConfiguration#jsxEverywhere
|
|
@@ -1558,8 +1533,9 @@ export interface JsResolverConfiguration {
|
|
|
1558
1533
|
* - Biome only reads top-level `catalog` / `catalogs` mappings and scalar
|
|
1559
1534
|
* string entries.
|
|
1560
1535
|
*
|
|
1561
|
-
*
|
|
1536
|
+
* Defaults to `false`.
|
|
1562
1537
|
*
|
|
1538
|
+
* @default false`.
|
|
1563
1539
|
* @schema JsResolverConfiguration#experimentalPnpmCatalogs
|
|
1564
1540
|
*/
|
|
1565
1541
|
readonly experimentalPnpmCatalogs?: boolean;
|
|
@@ -1576,7 +1552,7 @@ export declare function toJson_JsResolverConfiguration(obj: JsResolverConfigurat
|
|
|
1576
1552
|
*/
|
|
1577
1553
|
export interface JsonAssistConfiguration {
|
|
1578
1554
|
/**
|
|
1579
|
-
*
|
|
1555
|
+
* Controls assist actions for JSON and languages that extend it.
|
|
1580
1556
|
*
|
|
1581
1557
|
* @schema JsonAssistConfiguration#enabled
|
|
1582
1558
|
*/
|
|
@@ -1592,86 +1568,77 @@ export declare function toJson_JsonAssistConfiguration(obj: JsonAssistConfigurat
|
|
|
1592
1568
|
*/
|
|
1593
1569
|
export interface JsonFormatterConfiguration {
|
|
1594
1570
|
/**
|
|
1595
|
-
* Whether to insert spaces
|
|
1571
|
+
* Whether to insert spaces inside braces in object literals. If unset, inherits the global
|
|
1572
|
+
* bracket spacing setting.
|
|
1596
1573
|
*
|
|
1597
|
-
* @default true.
|
|
1598
1574
|
* @schema JsonFormatterConfiguration#bracketSpacing
|
|
1599
1575
|
*/
|
|
1600
1576
|
readonly bracketSpacing?: boolean;
|
|
1601
1577
|
/**
|
|
1602
|
-
*
|
|
1603
|
-
*
|
|
1604
|
-
*
|
|
1605
|
-
*
|
|
1578
|
+
* Controls spaces inside JSON square brackets when their content fits on one line. When
|
|
1579
|
+
* enabled, `[1, 2, 3]` becomes `[ 1, 2, 3 ]`. Empty brackets are unchanged.
|
|
1580
|
+
*
|
|
1581
|
+
* If unset, inherits the global delimiter spacing setting.
|
|
1606
1582
|
*
|
|
1607
|
-
* @default false.
|
|
1608
1583
|
* @schema JsonFormatterConfiguration#delimiterSpacing
|
|
1609
1584
|
*/
|
|
1610
1585
|
readonly delimiterSpacing?: boolean;
|
|
1611
1586
|
/**
|
|
1612
|
-
*
|
|
1587
|
+
* Controls the formatter for JSON and languages that extend it.
|
|
1613
1588
|
*
|
|
1614
1589
|
* @schema JsonFormatterConfiguration#enabled
|
|
1615
1590
|
*/
|
|
1616
1591
|
readonly enabled?: boolean;
|
|
1617
1592
|
/**
|
|
1618
|
-
*
|
|
1619
|
-
*
|
|
1620
|
-
*
|
|
1621
|
-
*
|
|
1622
|
-
* When
|
|
1623
|
-
* When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
|
|
1593
|
+
* Uses the same `auto`, `always`, and `never` behavior as the global expansion setting.
|
|
1594
|
+
*
|
|
1595
|
+
* If unset, inherits the global expansion setting.
|
|
1596
|
+
*
|
|
1597
|
+
* When formatting `package.json`, Biome uses `always` unless configured otherwise.
|
|
1624
1598
|
*
|
|
1625
|
-
* @default auto".
|
|
1626
1599
|
* @schema JsonFormatterConfiguration#expand
|
|
1627
1600
|
*/
|
|
1628
1601
|
readonly expand?: Expand;
|
|
1629
1602
|
/**
|
|
1630
|
-
* The indent style applied to JSON
|
|
1603
|
+
* The indent style applied to JSON and languages that extend it. If unset, inherits the global
|
|
1604
|
+
* indentation style.
|
|
1631
1605
|
*
|
|
1632
1606
|
* @schema JsonFormatterConfiguration#indentStyle
|
|
1633
1607
|
*/
|
|
1634
1608
|
readonly indentStyle?: IndentStyle;
|
|
1635
1609
|
/**
|
|
1636
|
-
* The
|
|
1610
|
+
* The indentation width applied to JSON and languages that extend it. If unset, inherits the
|
|
1611
|
+
* global indentation width.
|
|
1637
1612
|
*
|
|
1638
|
-
* @default 2.
|
|
1639
1613
|
* @schema JsonFormatterConfiguration#indentWidth
|
|
1640
1614
|
*/
|
|
1641
1615
|
readonly indentWidth?: number;
|
|
1642
1616
|
/**
|
|
1643
|
-
* The
|
|
1617
|
+
* The line ending applied to JSON and languages that extend it. If unset, inherits the global
|
|
1618
|
+
* line ending.
|
|
1644
1619
|
*
|
|
1645
1620
|
* @schema JsonFormatterConfiguration#lineEnding
|
|
1646
1621
|
*/
|
|
1647
1622
|
readonly lineEnding?: LineEnding;
|
|
1648
1623
|
/**
|
|
1649
|
-
*
|
|
1624
|
+
* The maximum line width applied to JSON and languages that extend it. If unset, inherits the
|
|
1625
|
+
* global line width.
|
|
1650
1626
|
*
|
|
1651
|
-
* @default 80.
|
|
1652
1627
|
* @schema JsonFormatterConfiguration#lineWidth
|
|
1653
1628
|
*/
|
|
1654
1629
|
readonly lineWidth?: number;
|
|
1655
1630
|
/**
|
|
1656
|
-
*
|
|
1631
|
+
* Prints trailing commas wherever possible in multiline comma-separated structures. Defaults
|
|
1632
|
+
* to `none`.
|
|
1657
1633
|
*
|
|
1658
|
-
* @default none
|
|
1634
|
+
* @default none`.
|
|
1659
1635
|
* @schema JsonFormatterConfiguration#trailingCommas
|
|
1660
1636
|
*/
|
|
1661
1637
|
readonly trailingCommas?: JsonTrailingCommas;
|
|
1662
1638
|
/**
|
|
1663
|
-
* Whether to add a trailing newline at the end of the file.
|
|
1639
|
+
* Whether to add a trailing newline at the end of the file. If unset, inherits the global
|
|
1640
|
+
* trailing newline setting.
|
|
1664
1641
|
*
|
|
1665
|
-
* Setting this option to `false` is **highly discouraged** because it could cause many problems with other tools:
|
|
1666
|
-
* - https://thoughtbot.com/blog/no-newline-at-end-of-file
|
|
1667
|
-
* - https://callmeryan.medium.com/no-newline-at-end-of-file-navigating-gits-warning-for-android-developers-af14e73dd804
|
|
1668
|
-
* - https://unix.stackexchange.com/questions/345548/how-to-cat-files-together-adding-missing-newlines-at-end-of-some-files
|
|
1669
|
-
*
|
|
1670
|
-
* Disable the option at your own risk.
|
|
1671
|
-
*
|
|
1672
|
-
* Defaults to true.
|
|
1673
|
-
*
|
|
1674
|
-
* @default true.
|
|
1675
1642
|
* @schema JsonFormatterConfiguration#trailingNewline
|
|
1676
1643
|
*/
|
|
1677
1644
|
readonly trailingNewline?: boolean;
|
|
@@ -1688,7 +1655,7 @@ export declare function toJson_JsonFormatterConfiguration(obj: JsonFormatterConf
|
|
|
1688
1655
|
*/
|
|
1689
1656
|
export interface JsonLinterConfiguration {
|
|
1690
1657
|
/**
|
|
1691
|
-
*
|
|
1658
|
+
* Controls the linter for JSON and languages that extend it.
|
|
1692
1659
|
*
|
|
1693
1660
|
* @schema JsonLinterConfiguration#enabled
|
|
1694
1661
|
*/
|
|
@@ -1700,19 +1667,19 @@ export interface JsonLinterConfiguration {
|
|
|
1700
1667
|
*/
|
|
1701
1668
|
export declare function toJson_JsonLinterConfiguration(obj: JsonLinterConfiguration | undefined): Record<string, any> | undefined;
|
|
1702
1669
|
/**
|
|
1703
|
-
* Options that
|
|
1670
|
+
* Options that change how the JSON parser behaves.
|
|
1704
1671
|
*
|
|
1705
1672
|
* @schema JsonParserConfiguration
|
|
1706
1673
|
*/
|
|
1707
1674
|
export interface JsonParserConfiguration {
|
|
1708
1675
|
/**
|
|
1709
|
-
*
|
|
1676
|
+
* Allows parsing comments in `.json` files.
|
|
1710
1677
|
*
|
|
1711
1678
|
* @schema JsonParserConfiguration#allowComments
|
|
1712
1679
|
*/
|
|
1713
1680
|
readonly allowComments?: boolean;
|
|
1714
1681
|
/**
|
|
1715
|
-
*
|
|
1682
|
+
* Allows parsing trailing commas in `.json` files.
|
|
1716
1683
|
*
|
|
1717
1684
|
* @schema JsonParserConfiguration#allowTrailingCommas
|
|
1718
1685
|
*/
|
|
@@ -1850,13 +1817,11 @@ export interface OverrideFormatterConfiguration {
|
|
|
1850
1817
|
*/
|
|
1851
1818
|
readonly bracketSpacing?: boolean;
|
|
1852
1819
|
/**
|
|
1853
|
-
*
|
|
1854
|
-
*
|
|
1855
|
-
*
|
|
1856
|
-
*
|
|
1857
|
-
* delimiters affected depend on the language. Defaults to false.
|
|
1820
|
+
* Controls spaces immediately inside supported delimiters when their content fits on one line.
|
|
1821
|
+
* It doesn't add spaces before opening delimiters or inside empty delimiters.
|
|
1822
|
+
*
|
|
1823
|
+
* The affected delimiters vary by language. If unset, uses the configured formatter setting.
|
|
1858
1824
|
*
|
|
1859
|
-
* @default false.
|
|
1860
1825
|
* @schema OverrideFormatterConfiguration#delimiterSpacing
|
|
1861
1826
|
*/
|
|
1862
1827
|
readonly delimiterSpacing?: boolean;
|
|
@@ -1865,14 +1830,19 @@ export interface OverrideFormatterConfiguration {
|
|
|
1865
1830
|
*/
|
|
1866
1831
|
readonly enabled?: boolean;
|
|
1867
1832
|
/**
|
|
1868
|
-
*
|
|
1869
|
-
*
|
|
1870
|
-
*
|
|
1871
|
-
*
|
|
1872
|
-
*
|
|
1873
|
-
*
|
|
1833
|
+
* Controls whether arrays and objects are formatted on one line or multiple lines.
|
|
1834
|
+
*
|
|
1835
|
+
* `auto` formats objects on multiple lines if the first property has a newline, and arrays on
|
|
1836
|
+
* one line if they fit.
|
|
1837
|
+
*
|
|
1838
|
+
* `always` formats arrays and objects on multiple lines.
|
|
1839
|
+
*
|
|
1840
|
+
* `never` formats arrays and objects on one line if they fit.
|
|
1841
|
+
*
|
|
1842
|
+
* If unset, uses the configured formatter setting.
|
|
1843
|
+
*
|
|
1844
|
+
* When formatting `package.json`, Biome uses `always` unless configured otherwise.
|
|
1874
1845
|
*
|
|
1875
|
-
* @default auto".
|
|
1876
1846
|
* @schema OverrideFormatterConfiguration#expand
|
|
1877
1847
|
*/
|
|
1878
1848
|
readonly expand?: Expand;
|
|
@@ -1973,7 +1943,7 @@ export interface OverrideLinterConfiguration {
|
|
|
1973
1943
|
*/
|
|
1974
1944
|
export declare function toJson_OverrideLinterConfiguration(obj: OverrideLinterConfiguration | undefined): Record<string, any> | undefined;
|
|
1975
1945
|
/**
|
|
1976
|
-
* Integration with the
|
|
1946
|
+
* Integration with Git as the version control client.
|
|
1977
1947
|
*
|
|
1978
1948
|
* @schema VcsClientKind
|
|
1979
1949
|
*/
|