@visulima/vis 7.1.0-next.6 → 7.1.0-next.7
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/CHANGELOG.md +59 -0
- package/README.md +1 -1
- package/dist/bin.js +1 -1
- package/dist/binx.js +1 -1
- package/dist/config/index.d.ts +227 -12
- package/dist/packem_chunks/CONFIG_FILES.js +1 -1
- package/dist/packem_chunks/bloom-sync.js +1 -1
- package/dist/packem_chunks/catalog.js +1 -1
- package/dist/packem_chunks/cli-exec.js +1 -1
- package/dist/packem_chunks/cli-main.js +57 -57
- package/dist/packem_chunks/detect.js +4 -4
- package/dist/packem_chunks/dispatch.js +1 -1
- package/dist/packem_chunks/fix.js +1 -1
- package/dist/packem_chunks/handler.js +1 -1
- package/dist/packem_chunks/handler10.js +1 -1
- package/dist/packem_chunks/handler11.js +1 -1
- package/dist/packem_chunks/handler12.js +1 -1
- package/dist/packem_chunks/handler13.js +1 -1
- package/dist/packem_chunks/handler14.js +1 -1
- package/dist/packem_chunks/handler15.js +1 -1
- package/dist/packem_chunks/handler16.js +1 -1
- package/dist/packem_chunks/handler17.js +1 -1
- package/dist/packem_chunks/handler18.js +1 -1
- package/dist/packem_chunks/handler19.js +1 -1
- package/dist/packem_chunks/handler2.js +1 -1
- package/dist/packem_chunks/handler20.js +1 -1
- package/dist/packem_chunks/handler21.js +1 -1
- package/dist/packem_chunks/handler22.js +1 -1
- package/dist/packem_chunks/handler23.js +1 -1
- package/dist/packem_chunks/handler24.js +1 -1
- package/dist/packem_chunks/handler25.js +1 -1
- package/dist/packem_chunks/handler26.js +1 -1
- package/dist/packem_chunks/handler27.js +1 -1
- package/dist/packem_chunks/handler28.js +1 -1
- package/dist/packem_chunks/handler29.js +1 -1
- package/dist/packem_chunks/handler3.js +2 -2
- package/dist/packem_chunks/handler30.js +1 -1
- package/dist/packem_chunks/handler4.js +1 -1
- package/dist/packem_chunks/handler5.js +1 -1
- package/dist/packem_chunks/handler50.js +1 -1
- package/dist/packem_chunks/handler51.js +1 -1
- package/dist/packem_chunks/handler52.js +1 -1
- package/dist/packem_chunks/handler53.js +1 -1
- package/dist/packem_chunks/handler54.js +1 -1
- package/dist/packem_chunks/handler55.js +1 -1
- package/dist/packem_chunks/handler58.js +1 -1
- package/dist/packem_chunks/handler59.js +1 -1
- package/dist/packem_chunks/handler6.js +1 -1
- package/dist/packem_chunks/handler60.js +1 -1
- package/dist/packem_chunks/handler61.js +22 -3
- package/dist/packem_chunks/handler62.js +2 -22
- package/dist/packem_chunks/handler63.js +6 -2
- package/dist/packem_chunks/handler64.js +8 -61
- package/dist/packem_chunks/handler65.js +2 -6
- package/dist/packem_chunks/handler66.js +12 -8
- package/dist/packem_chunks/handler67.js +5 -2
- package/dist/packem_chunks/handler68.js +25 -12
- package/dist/packem_chunks/handler69.js +50 -25
- package/dist/packem_chunks/handler7.js +1 -1
- package/dist/packem_chunks/handler70.js +153 -50
- package/dist/packem_chunks/handler71.js +1 -1
- package/dist/packem_chunks/handler72.js +1 -1
- package/dist/packem_chunks/handler73.js +1 -1
- package/dist/packem_chunks/handler74.js +1 -1
- package/dist/packem_chunks/handler75.js +1 -1
- package/dist/packem_chunks/handler76.js +1 -1
- package/dist/packem_chunks/handler77.js +1 -1
- package/dist/packem_chunks/handler78.js +1 -1
- package/dist/packem_chunks/handler79.js +64 -64
- package/dist/packem_chunks/handler8.js +1 -1
- package/dist/packem_chunks/handler9.js +1 -1
- package/dist/packem_chunks/heal-accept.js +1 -1
- package/dist/packem_chunks/heal.js +1 -1
- package/dist/packem_chunks/help-command.js +1 -1
- package/dist/packem_chunks/index7.js +1 -1
- package/dist/packem_chunks/keys-refresh.js +1 -1
- package/dist/packem_chunks/lean.js +1 -1
- package/dist/packem_chunks/list.js +1 -1
- package/dist/packem_chunks/loader.js +1 -1
- package/dist/packem_chunks/prune.js +1 -1
- package/dist/packem_chunks/status.js +1 -1
- package/dist/packem_chunks/sync.js +1 -1
- package/dist/packem_chunks/sync2.js +1 -1
- package/dist/packem_chunks/tripwire.js +1 -1
- package/dist/packem_chunks/ts-loader.js +2 -2
- package/dist/packem_chunks/verify-lockfile.js +1 -1
- package/dist/packem_chunks/workflow-templates.js +29 -32
- package/dist/packem_shared/{advisories-BnFPhsl1.js → advisories-CyXUdibZ.js} +1 -1
- package/dist/packem_shared/{affected-selection-Bd03KJU3.js → affected-selection-CJnDzyIK.js} +1 -1
- package/dist/packem_shared/affected-shas-CJLirD2O.js +1 -0
- package/dist/packem_shared/{ai-analysis-GjV2rF4U.js → ai-analysis-DHlzow2O.js} +1 -1
- package/dist/packem_shared/{ai-cache-DFKUyj11.js → ai-cache-D-BSLcuJ.js} +1 -1
- package/dist/packem_shared/{ai-fix-DpBEXHZT.js → ai-fix-CyExJC_c.js} +1 -1
- package/dist/packem_shared/{augment-BSeqaai8.js → augment-Ub6PCwbh.js} +1 -1
- package/dist/packem_shared/{bin-D1zq7wxi.js → bin-BaReRSyo.js} +1 -1
- package/dist/packem_shared/{build-scripts-mKGcgTzp.js → build-scripts-BeJkep8z.js} +1 -1
- package/dist/packem_shared/ci-commands-4W9d2six.js +1 -0
- package/dist/packem_shared/{command-runtime-DG49t2MT.js → command-runtime-DdnpiUmN.js} +1 -1
- package/dist/packem_shared/{dependency-scan-BGKZYS_i.js → dependency-scan-CyByCwef.js} +1 -1
- package/dist/packem_shared/{detect-CaA92iu_.js → detect-xqoTANJb.js} +1 -1
- package/dist/packem_shared/{docker-Cs174Imq.js → docker-CJXAt5Au.js} +1 -1
- package/dist/packem_shared/{ecosystem-gate-DcpvfgEi.js → ecosystem-gate-DEnubRcS.js} +1 -1
- package/dist/packem_shared/{env-sb3SOT-b.js → env-NauRSSEC.js} +1 -1
- package/dist/packem_shared/{env-consistency-nSuzisQe.js → env-consistency-Cl1Rg65z.js} +1 -1
- package/dist/packem_shared/{failure-log-AtaeZOrx.js → failure-log-DwroazKs.js} +1 -1
- package/dist/packem_shared/glob-Cyk1H9ZL-BtN6Zzwg.js +1 -0
- package/dist/packem_shared/{index-CclzWrJ5.js → index-BCEhCrLl.js} +1 -1
- package/dist/packem_shared/{index-C_7lOmB0.js → index-OmE1O0Ys.js} +1 -1
- package/dist/packem_shared/{index-0dnGN3GP.js → index-zq6Ehql6.js} +1 -1
- package/dist/packem_shared/{isAccessibleSync-DYKTrrvc-CBsMZhj-.js → isAccessibleSync-DYKTrrvc-CKahNmLy.js} +1 -1
- package/dist/packem_shared/{lifecycle-BzenugED.js → lifecycle-Cn1mSP5f.js} +1 -1
- package/dist/packem_shared/{lockfile-DEWjBrlY.js → lockfile-Cx2Ny3um.js} +1 -1
- package/dist/packem_shared/{manifests-DPwVdkqB.js → manifests-BEGTH1ZG.js} +1 -1
- package/dist/packem_shared/{min-release-age-BH4JKSXA.js → min-release-age-DLAERxRt.js} +1 -1
- package/dist/packem_shared/{missing-package-json-ByjsDBbk.js → missing-package-json-w74qGfyh.js} +1 -1
- package/dist/packem_shared/{multi-eco-lockfiles-Bz9ViPBV.js → multi-eco-lockfiles-SATPXx6-.js} +1 -1
- package/dist/packem_shared/{native-config-sync-DI7_xs-Q.js → native-config-sync-DDFn6Zsf.js} +1 -1
- package/dist/packem_shared/{npmrc-CIvOb61L.js → npmrc-DONprxrc.js} +1 -1
- package/dist/packem_shared/{osv-DaMZpVWl.js → osv-dvIA_vX3.js} +1 -1
- package/dist/packem_shared/{package-version-VdULnxr1.js → package-version-BOK3IncQ.js} +2 -2
- package/dist/packem_shared/{packument-zeKEhTaX.js → packument-B678kHJO.js} +1 -1
- package/dist/packem_shared/{pm-runner-BXRi4ZM9.js → pm-runner-CYsiSHYa.js} +1 -1
- package/dist/packem_shared/{project-name-filter-BklluD5Y.js → project-name-filter-CBEoY08a.js} +1 -1
- package/dist/packem_shared/{provenance-CwyZDw8A.js → provenance-D4ioWGBq.js} +1 -1
- package/dist/packem_shared/reachable-DX8FPErP.js +1 -0
- package/dist/packem_shared/{registry-TXpTtpgS.js → registry-ClmannRw.js} +2 -2
- package/dist/packem_shared/{registry-keys-B4CNE38T.js → registry-keys-CF45rOur.js} +1 -1
- package/dist/packem_shared/{removeSync-g1D5kONg-jOsRSIIv.js → removeSync-g1D5kONg-DcG75b0G.js} +1 -1
- package/dist/packem_shared/{renderToString-DR0zDUjh-CdBv7J9a.js → renderToString-DR0zDUjh-CBDmAXxb.js} +1 -1
- package/dist/packem_shared/{resolve-explicit-Cg3eqSqr.js → resolve-explicit-C5-y-xEU.js} +1 -1
- package/dist/packem_shared/{resolve-runtime-D8rxuo3J.js → resolve-runtime-DBDozrmt.js} +1 -1
- package/dist/packem_shared/{run-file-D1mlOnd8.js → run-file-BKXvoVj2.js} +1 -1
- package/dist/packem_shared/{run-summary-utils-CZ2pIIOZ.js → run-summary-utils-75paIrLB.js} +1 -1
- package/dist/packem_shared/{runtime-check-By5NHR00.js → runtime-check-Yl8-Awkf.js} +1 -1
- package/dist/packem_shared/{s1ngularity-CXTWGOvX.js → s1ngularity-B2bqwE0C.js} +1 -1
- package/dist/packem_shared/{scaffold-files-CC1M9Gje.js → scaffold-files-UiCBBCT5.js} +1 -1
- package/dist/packem_shared/{scan-progress-BaCJp5nr.js → scan-progress-Dws7Gif1.js} +1 -1
- package/dist/packem_shared/{selectors-DdvjAetv.js → selectors-DZ4HDnlD.js} +1 -1
- package/dist/packem_shared/{signatures-Bm-ySKmD.js → signatures-DNqgsRp7.js} +1 -1
- package/dist/packem_shared/{spinner-D8Eugb6Y.js → spinner-BQ9mLz8X.js} +1 -1
- package/dist/packem_shared/{table-Dc3wOjzc.js → table-D1CpySxU.js} +1 -1
- package/dist/packem_shared/{tabs-Ch5hj2ow.js → tabs-BYtpIN5b.js} +1 -1
- package/dist/packem_shared/{target-options-rIthWS4M.js → target-options-CsevVc7U.js} +1 -1
- package/dist/packem_shared/{task-env-Cl4jNMCR.js → task-env-BftNOR00.js} +1 -1
- package/dist/packem_shared/{toolchain-DQIOCPht.js → toolchain-BvluBdrw.js} +1 -1
- package/dist/packem_shared/{typosquats-Dw02Q55Q.js → typosquats-XrArH9TO.js} +1 -1
- package/dist/packem_shared/{use-measured-height-wtekNTLa.js → use-measured-height-hHis1NaB.js} +1 -1
- package/dist/packem_shared/{verify-3WE9U_Bv.js → verify-Dic2G0nQ.js} +1 -1
- package/dist/packem_shared/{vis-update-app-it6zkxW1.js → vis-update-app-BNnbDZ--.js} +1 -1
- package/dist/packem_shared/{vis-user-error-6sSghaC9.js → vis-user-error-DhgW3DzD.js} +2 -2
- package/dist/packem_shared/{watch-C-9-PD2m.js → watch-BLHtUgfb.js} +1 -1
- package/dist/packem_shared/{watch-loop-q7f9ukDX.js → watch-loop-Dh4GHUVS.js} +7 -7
- package/dist/runtime/preload.js +1 -1
- package/index.js +54 -54
- package/package.json +11 -10
- package/schemas/vis-config.schema.json +1419 -80
- package/dist/packem_shared/affected-shas-CycHU3nr.js +0 -1
- package/dist/packem_shared/glob-Cyk1H9ZL-QtJl508G.js +0 -1
|
@@ -46,6 +46,10 @@
|
|
|
46
46
|
"description": "Scope the task-runner cache directory by the current git branch. When `true`, caches are stored under `<cacheDir>/branches/<slug>` so `main` and feature branches stop thrashing each other — generated artefacts (schemas, `.d.ts` snapshots) that legitimately differ across branches no longer oscillate the cache contents.\n\nFalls back to the unscoped path on detached HEAD, non-git workspaces, or when git isn't available.",
|
|
47
47
|
"default": false
|
|
48
48
|
},
|
|
49
|
+
"ci": {
|
|
50
|
+
"$ref": "#/$defs/CiConfig",
|
|
51
|
+
"description": "CI settings. `ci.workflow` drives the GitHub Actions / GitLab CI workflow that `vis sync ci-workflow` generates."
|
|
52
|
+
},
|
|
49
53
|
"codeowners": {
|
|
50
54
|
"$ref": "#/$defs/CodeownersConfig",
|
|
51
55
|
"description": "Code ownership configuration. Controls how `vis sync codeowners` renders the generated CODEOWNERS file."
|
|
@@ -251,16 +255,17 @@
|
|
|
251
255
|
"properties": {
|
|
252
256
|
"adapters": {
|
|
253
257
|
"type": "object",
|
|
258
|
+
"additionalProperties": false,
|
|
254
259
|
"properties": {
|
|
260
|
+
"oxfmt": {
|
|
261
|
+
"$ref": "#/$defs/OxfmtAdapterOverride"
|
|
262
|
+
},
|
|
255
263
|
"biome": {
|
|
256
264
|
"$ref": "#/$defs/LintFmtAdapterOverride"
|
|
257
265
|
},
|
|
258
266
|
"dprint": {
|
|
259
267
|
"$ref": "#/$defs/LintFmtAdapterOverride"
|
|
260
268
|
},
|
|
261
|
-
"oxfmt": {
|
|
262
|
-
"$ref": "#/$defs/LintFmtAdapterOverride"
|
|
263
|
-
},
|
|
264
269
|
"prettier": {
|
|
265
270
|
"$ref": "#/$defs/LintFmtAdapterOverride"
|
|
266
271
|
},
|
|
@@ -268,26 +273,48 @@
|
|
|
268
273
|
"$ref": "#/$defs/LintFmtAdapterOverride"
|
|
269
274
|
}
|
|
270
275
|
},
|
|
271
|
-
"
|
|
272
|
-
|
|
276
|
+
"description": "Per-adapter overrides. Keyed by `AdapterId`. Set `enabled: false` to skip an adapter even when detected, or `extraArgs` to append flags verbatim. `enabled: false` on `oxfmt` also turns the bundled oxfmt off."
|
|
277
|
+
},
|
|
278
|
+
"engine": {
|
|
279
|
+
"$ref": "#/$defs/FmtEngine",
|
|
280
|
+
"description": "Which formatter runs.\n- `auto` (default): the bundled oxfmt, unless biome, dprint or ruff format is detected.\n- `oxfmt`: always the bundled oxfmt, and no other formatter.\n- `prettier`: the adapter orchestration, with Prettier staying in charge.",
|
|
281
|
+
"default": "auto"
|
|
273
282
|
},
|
|
274
283
|
"extensionOverrides": {
|
|
275
284
|
"type": "object",
|
|
276
285
|
"additionalProperties": {
|
|
277
286
|
"$ref": "#/$defs/FmtAdapterId"
|
|
278
287
|
},
|
|
279
|
-
"description": "Pin a file extension (without the leading dot) to a specific adapter, overriding the registry's \"first detected adapter wins\" routing. Use to e.g. send `.md` to `dprint` even when both prettier and dprint are present."
|
|
288
|
+
"description": "Pin a file extension (without the leading dot) to a specific adapter, overriding the registry's \"first detected adapter wins\" routing. Use to e.g. send `.md` to `dprint` even when both prettier and dprint are present. Applies to the adapter orchestration only."
|
|
289
|
+
},
|
|
290
|
+
"ignorePatterns": {
|
|
291
|
+
"type": "array",
|
|
292
|
+
"items": {
|
|
293
|
+
"type": "string"
|
|
294
|
+
},
|
|
295
|
+
"description": "Files the bundled oxfmt skips, relative to the workspace root. Same shape as oxfmt's `ignorePatterns`. A pattern containing `..` is rejected."
|
|
296
|
+
},
|
|
297
|
+
"options": {
|
|
298
|
+
"$ref": "#/$defs/OxfmtOptions",
|
|
299
|
+
"description": "Formatting options for the bundled oxfmt, in oxfmt's own names (`printWidth`, `semi`, `singleQuote`, `sortImports`, ...). Used instead of any `.oxfmtrc` or Prettier config."
|
|
280
300
|
},
|
|
281
301
|
"order": {
|
|
282
302
|
"type": "array",
|
|
283
303
|
"items": {
|
|
284
304
|
"$ref": "#/$defs/FmtAdapterId"
|
|
285
305
|
},
|
|
286
|
-
"description": "Override the adapter precedence order. Adapters omitted from this list still run (appended at the end in registry order), but those listed earlier get priority for extension routing."
|
|
306
|
+
"description": "Override the adapter precedence order. Adapters omitted from this list still run (appended at the end in registry order), but those listed earlier get priority for extension routing. Applies to the adapter orchestration only."
|
|
307
|
+
},
|
|
308
|
+
"overrides": {
|
|
309
|
+
"type": "array",
|
|
310
|
+
"items": {
|
|
311
|
+
"$ref": "#/$defs/FmtOverride"
|
|
312
|
+
},
|
|
313
|
+
"description": "File-specific option overrides for the bundled oxfmt. Later entries win. A `files` or `excludeFiles` glob containing `..` is rejected."
|
|
287
314
|
}
|
|
288
315
|
},
|
|
289
316
|
"additionalProperties": false,
|
|
290
|
-
"description": "Configuration for `vis fmt`
|
|
317
|
+
"description": "Configuration for `vis fmt`.\n\nBy default `vis fmt` formats with the oxfmt that ships with vis, so a workspace needs no setup. The formatting options come from the first of these sources that exists, used whole (never merged): `fmt.options` here, then an `.oxfmtrc.json(c)` / `oxfmt.config.ts` file, then a Prettier config (mapped to oxfmt options), then oxfmt's defaults. Note that oxfmt's default `printWidth` is 100; a Prettier config without one maps to Prettier's 80.\n\nA workspace that uses biome, dprint or ruff format keeps the adapter orchestration: vis runs every detected formatter, routed by extension. `fmt.engine` overrides that choice.\n\nFlags on the CLI always win over config."
|
|
291
318
|
},
|
|
292
319
|
"gem": {
|
|
293
320
|
"type": "object",
|
|
@@ -1130,7 +1157,7 @@
|
|
|
1130
1157
|
},
|
|
1131
1158
|
"redact": {
|
|
1132
1159
|
"type": "boolean",
|
|
1133
|
-
"description": "
|
|
1160
|
+
"description": "Mask secret values in findings and reports. Default `true`; `false` reveals them."
|
|
1134
1161
|
},
|
|
1135
1162
|
"rules": {
|
|
1136
1163
|
"type": "object",
|
|
@@ -1166,7 +1193,7 @@
|
|
|
1166
1193
|
"const": false
|
|
1167
1194
|
}
|
|
1168
1195
|
],
|
|
1169
|
-
"description": "`.secretlintignore` paths, or `false` to disable auto-discovery."
|
|
1196
|
+
"description": "`.secretlintignore` paths, or `false` to disable auto-discovery (`--secretlintignore` files still apply)."
|
|
1170
1197
|
},
|
|
1171
1198
|
"walk": {
|
|
1172
1199
|
"type": "object",
|
|
@@ -3907,116 +3934,1428 @@
|
|
|
3907
3934
|
},
|
|
3908
3935
|
"additionalProperties": false,
|
|
3909
3936
|
"$defs": {
|
|
3910
|
-
"
|
|
3937
|
+
"CiConfig": {
|
|
3911
3938
|
"type": "object",
|
|
3912
3939
|
"properties": {
|
|
3913
|
-
"
|
|
3940
|
+
"workflow": {
|
|
3941
|
+
"$ref": "#/$defs/CiWorkflowConfig",
|
|
3942
|
+
"description": "The workflow generated by `vis sync ci-workflow`."
|
|
3943
|
+
}
|
|
3944
|
+
},
|
|
3945
|
+
"additionalProperties": false
|
|
3946
|
+
},
|
|
3947
|
+
"CiWorkflowConfig": {
|
|
3948
|
+
"type": "object",
|
|
3949
|
+
"properties": {
|
|
3950
|
+
"affected": {
|
|
3951
|
+
"type": "boolean",
|
|
3952
|
+
"description": "Run only the projects affected by the change (`vis ci`). Set to `false` to run every project (`vis run`).",
|
|
3953
|
+
"default": true
|
|
3954
|
+
},
|
|
3955
|
+
"branches": {
|
|
3956
|
+
"type": "array",
|
|
3957
|
+
"items": {
|
|
3958
|
+
"type": "string"
|
|
3959
|
+
},
|
|
3960
|
+
"description": "Branches whose pushes run the workflow, besides pull/merge requests. Defaults to `[defaultBase ?? \"main\"]`."
|
|
3961
|
+
},
|
|
3962
|
+
"buildFirst": {
|
|
3963
|
+
"type": "boolean",
|
|
3964
|
+
"description": "Run `build` before every other listed target that `dependsOn` does not already order relative to it. Most workspaces never declare that `test` or `typecheck` needs the dependencies' `dist`, because a sequential CI job built first anyway; running them in parallel with `build` would race. Set to `false` when your `dependsOn` is complete.",
|
|
3965
|
+
"default": true
|
|
3966
|
+
},
|
|
3967
|
+
"checkDrift": {
|
|
3968
|
+
"type": "boolean",
|
|
3969
|
+
"description": "Run `vis sync ci-workflow --check` in the workflow, so CI fails when the committed workflow no longer matches this config.",
|
|
3970
|
+
"default": true
|
|
3971
|
+
},
|
|
3972
|
+
"github": {
|
|
3973
|
+
"$ref": "#/$defs/CiGithubWorkflowConfig",
|
|
3974
|
+
"description": "Additions to the GitHub Actions workflow: env, permissions, services and extra steps."
|
|
3975
|
+
},
|
|
3976
|
+
"gitlab": {
|
|
3977
|
+
"$ref": "#/$defs/CiGitlabWorkflowConfig",
|
|
3978
|
+
"description": "Additions to the GitLab CI file: image, variables, scripts, services and runner tags."
|
|
3979
|
+
},
|
|
3980
|
+
"nodeVersion": {
|
|
3981
|
+
"type": "string",
|
|
3982
|
+
"description": "Node.js version installed by the workflow. Defaults to `toolchain.tools.node`, then `\"22\"`."
|
|
3983
|
+
},
|
|
3984
|
+
"partitions": {
|
|
3985
|
+
"type": "object",
|
|
3986
|
+
"additionalProperties": {
|
|
3987
|
+
"type": "number"
|
|
3988
|
+
},
|
|
3989
|
+
"description": "Split a target's tasks into N shards that run at the same time (`--partition=k/N`), e.g. `{ test: 3 }`. On GitHub each shard is a step in the same `parallel:` group, so a group holds at most 10 steps."
|
|
3990
|
+
},
|
|
3991
|
+
"providers": {
|
|
3992
|
+
"type": "array",
|
|
3993
|
+
"items": {
|
|
3994
|
+
"$ref": "#/$defs/CiWorkflowProvider"
|
|
3995
|
+
},
|
|
3996
|
+
"description": "Which providers to generate a workflow for. Detected when unset: from the CI files in the repository, then the CI environment or git remote."
|
|
3997
|
+
},
|
|
3998
|
+
"runsOn": {
|
|
3999
|
+
"type": "string",
|
|
4000
|
+
"description": "GitHub runner label.",
|
|
4001
|
+
"default": "ubuntu-latest"
|
|
4002
|
+
},
|
|
4003
|
+
"targets": {
|
|
4004
|
+
"type": "array",
|
|
4005
|
+
"items": {
|
|
4006
|
+
"anyOf": [
|
|
4007
|
+
{
|
|
4008
|
+
"$ref": "#/$defs/CiWorkflowTargetConfig"
|
|
4009
|
+
},
|
|
4010
|
+
{
|
|
4011
|
+
"type": "string"
|
|
4012
|
+
}
|
|
4013
|
+
]
|
|
4014
|
+
},
|
|
4015
|
+
"description": "Targets to run. A target that depends on another listed target (through `dependsOn`, directly or via unlisted targets) runs in a later group; the rest run at the same time. Defaults to whichever of lint, typecheck, lint:types, build and test exist in the workspace. Use the object form to give a target environment variables."
|
|
4016
|
+
},
|
|
4017
|
+
"timeoutMinutes": {
|
|
4018
|
+
"type": "number",
|
|
4019
|
+
"description": "Minutes before the CI job is cancelled (`timeout-minutes` on GitHub, `timeout` on GitLab).",
|
|
4020
|
+
"default": 60
|
|
4021
|
+
}
|
|
4022
|
+
},
|
|
4023
|
+
"additionalProperties": false,
|
|
4024
|
+
"description": "Settings for the CI workflow that `vis sync ci-workflow` generates.\n\nOn GitHub the workflow is a single job: it builds the dependencies of every listed target once (`vis ci … --deps-only`), then runs the targets as GitHub Actions `parallel:` step groups (`--skip-deps`). On GitLab each target becomes its own job, and a partitioned target uses `parallel: N`."
|
|
4025
|
+
},
|
|
4026
|
+
"CiGithubWorkflowConfig": {
|
|
4027
|
+
"type": "object",
|
|
4028
|
+
"properties": {
|
|
4029
|
+
"env": {
|
|
4030
|
+
"type": "object",
|
|
4031
|
+
"additionalProperties": {
|
|
4032
|
+
"type": "string"
|
|
4033
|
+
},
|
|
4034
|
+
"description": "Job-level environment variables, available to every step. Use `${{ secrets.NAME }}` for secrets."
|
|
4035
|
+
},
|
|
4036
|
+
"permissions": {
|
|
4037
|
+
"type": "object",
|
|
4038
|
+
"additionalProperties": {
|
|
4039
|
+
"type": "string",
|
|
4040
|
+
"enum": [
|
|
4041
|
+
"none",
|
|
4042
|
+
"read",
|
|
4043
|
+
"write"
|
|
4044
|
+
]
|
|
4045
|
+
},
|
|
4046
|
+
"description": "Permissions added to the workflow's default `contents: read`, e.g. `{ \"id-token\": \"write\" }` for OIDC."
|
|
4047
|
+
},
|
|
4048
|
+
"services": {
|
|
4049
|
+
"type": "object",
|
|
4050
|
+
"additionalProperties": {
|
|
4051
|
+
"$ref": "#/$defs/CiGithubService"
|
|
4052
|
+
},
|
|
4053
|
+
"description": "Service containers the job needs, keyed by service name (also its hostname)."
|
|
4054
|
+
},
|
|
4055
|
+
"steps": {
|
|
3914
4056
|
"type": "object",
|
|
3915
4057
|
"properties": {
|
|
3916
|
-
"
|
|
4058
|
+
"after": {
|
|
4059
|
+
"type": "array",
|
|
4060
|
+
"items": {
|
|
4061
|
+
"$ref": "#/$defs/CiGithubStep"
|
|
4062
|
+
},
|
|
4063
|
+
"description": "Steps after all targets ran, e.g. a coverage upload (add `if: always()` to run them after a failure)."
|
|
4064
|
+
},
|
|
4065
|
+
"afterSetup": {
|
|
4066
|
+
"type": "array",
|
|
4067
|
+
"items": {
|
|
4068
|
+
"$ref": "#/$defs/CiGithubStep"
|
|
4069
|
+
},
|
|
4070
|
+
"description": "Steps after the toolchains are installed and before anything runs, e.g. starting `docker compose`."
|
|
4071
|
+
}
|
|
4072
|
+
},
|
|
4073
|
+
"additionalProperties": false
|
|
4074
|
+
}
|
|
4075
|
+
},
|
|
4076
|
+
"additionalProperties": false,
|
|
4077
|
+
"description": "Additions to the generated GitHub Actions workflow."
|
|
4078
|
+
},
|
|
4079
|
+
"CiGithubService": {
|
|
4080
|
+
"type": "object",
|
|
4081
|
+
"properties": {
|
|
4082
|
+
"credentials": {
|
|
4083
|
+
"type": "object",
|
|
4084
|
+
"properties": {
|
|
4085
|
+
"password": {
|
|
3917
4086
|
"type": "string"
|
|
3918
4087
|
},
|
|
3919
|
-
"
|
|
4088
|
+
"username": {
|
|
3920
4089
|
"type": "string"
|
|
3921
4090
|
}
|
|
3922
4091
|
},
|
|
3923
4092
|
"required": [
|
|
3924
|
-
"
|
|
3925
|
-
"
|
|
4093
|
+
"password",
|
|
4094
|
+
"username"
|
|
3926
4095
|
],
|
|
3927
|
-
"additionalProperties": false
|
|
3928
|
-
"description": "Markers that bracket the generated block when `preserveBlock` is set."
|
|
4096
|
+
"additionalProperties": false
|
|
3929
4097
|
},
|
|
3930
|
-
"
|
|
4098
|
+
"env": {
|
|
3931
4099
|
"type": "object",
|
|
3932
4100
|
"additionalProperties": {
|
|
3933
|
-
"type": "
|
|
3934
|
-
|
|
3935
|
-
"type": "string"
|
|
3936
|
-
}
|
|
3937
|
-
},
|
|
3938
|
-
"description": "Workspace-level paths that apply outside any project (e.g., `.github/**`)."
|
|
4101
|
+
"type": "string"
|
|
4102
|
+
}
|
|
3939
4103
|
},
|
|
3940
|
-
"
|
|
4104
|
+
"image": {
|
|
4105
|
+
"type": "string"
|
|
4106
|
+
},
|
|
4107
|
+
"options": {
|
|
4108
|
+
"type": "string",
|
|
4109
|
+
"description": "Docker `create` options, e.g. `--health-cmd pg_isready`."
|
|
4110
|
+
},
|
|
4111
|
+
"ports": {
|
|
4112
|
+
"type": "array",
|
|
4113
|
+
"items": {
|
|
4114
|
+
"type": [
|
|
4115
|
+
"number",
|
|
4116
|
+
"string"
|
|
4117
|
+
]
|
|
4118
|
+
}
|
|
4119
|
+
},
|
|
4120
|
+
"volumes": {
|
|
3941
4121
|
"type": "array",
|
|
3942
4122
|
"items": {
|
|
3943
4123
|
"type": "string"
|
|
3944
|
-
}
|
|
3945
|
-
|
|
4124
|
+
}
|
|
4125
|
+
}
|
|
4126
|
+
},
|
|
4127
|
+
"required": [
|
|
4128
|
+
"image"
|
|
4129
|
+
],
|
|
4130
|
+
"additionalProperties": false,
|
|
4131
|
+
"description": "A service container for the GitHub job (`jobs.<id>.services`)."
|
|
4132
|
+
},
|
|
4133
|
+
"CiGithubStep": {
|
|
4134
|
+
"type": "object",
|
|
4135
|
+
"properties": {
|
|
4136
|
+
"continue-on-error": {
|
|
4137
|
+
"type": "boolean"
|
|
3946
4138
|
},
|
|
3947
|
-
"
|
|
4139
|
+
"env": {
|
|
4140
|
+
"type": "object",
|
|
4141
|
+
"additionalProperties": {
|
|
4142
|
+
"type": "string"
|
|
4143
|
+
}
|
|
4144
|
+
},
|
|
4145
|
+
"if": {
|
|
3948
4146
|
"type": "string",
|
|
3949
|
-
"
|
|
3950
|
-
"file-source",
|
|
3951
|
-
"project-id"
|
|
3952
|
-
],
|
|
3953
|
-
"description": "Sort order for generated entries — mirrors moon's `orderBy`."
|
|
4147
|
+
"description": "A GitHub expression, e.g. `always()` or `github.event_name == 'push'`."
|
|
3954
4148
|
},
|
|
3955
|
-
"
|
|
3956
|
-
"type": "
|
|
3957
|
-
"description": "When set, the generated content is spliced between {@link CodeownersConfig.blockMarker } markers in the existing file (markers are appended if missing) instead of overwriting the file."
|
|
4149
|
+
"name": {
|
|
4150
|
+
"type": "string"
|
|
3958
4151
|
},
|
|
3959
|
-
"
|
|
3960
|
-
"type": "string"
|
|
3961
|
-
"enum": [
|
|
3962
|
-
"bitbucket",
|
|
3963
|
-
"github",
|
|
3964
|
-
"gitlab",
|
|
3965
|
-
"other"
|
|
3966
|
-
],
|
|
3967
|
-
"description": "Provider determines whether `channel` is emitted (GitHub supports it via comment)."
|
|
4152
|
+
"run": {
|
|
4153
|
+
"type": "string"
|
|
3968
4154
|
},
|
|
3969
|
-
"
|
|
4155
|
+
"shell": {
|
|
4156
|
+
"type": "string"
|
|
4157
|
+
},
|
|
4158
|
+
"timeout-minutes": {
|
|
4159
|
+
"type": "number"
|
|
4160
|
+
},
|
|
4161
|
+
"uses": {
|
|
3970
4162
|
"type": "string",
|
|
3971
|
-
"description": "
|
|
4163
|
+
"description": "An action reference. Pin it to a commit SHA (`owner/action@<sha>`), as the generated steps are."
|
|
3972
4164
|
},
|
|
3973
|
-
"
|
|
3974
|
-
"type": "
|
|
3975
|
-
"
|
|
3976
|
-
"
|
|
3977
|
-
|
|
3978
|
-
|
|
4165
|
+
"with": {
|
|
4166
|
+
"type": "object",
|
|
4167
|
+
"additionalProperties": {
|
|
4168
|
+
"type": [
|
|
4169
|
+
"boolean",
|
|
4170
|
+
"number",
|
|
4171
|
+
"string"
|
|
4172
|
+
]
|
|
4173
|
+
}
|
|
4174
|
+
},
|
|
4175
|
+
"working-directory": {
|
|
4176
|
+
"type": "string"
|
|
3979
4177
|
}
|
|
3980
4178
|
},
|
|
3981
|
-
"
|
|
3982
|
-
|
|
3983
|
-
"CodeownersSource": {
|
|
3984
|
-
"type": "string",
|
|
3985
|
-
"enum": [
|
|
3986
|
-
"nested-codeowners",
|
|
3987
|
-
"package-json-maintainers",
|
|
3988
|
-
"project-json"
|
|
4179
|
+
"required": [
|
|
4180
|
+
"name"
|
|
3989
4181
|
],
|
|
3990
|
-
"
|
|
4182
|
+
"additionalProperties": false,
|
|
4183
|
+
"description": "A step added to the generated GitHub workflow. Exactly one of `run` and `uses` is required."
|
|
3991
4184
|
},
|
|
3992
|
-
"
|
|
4185
|
+
"CiGitlabWorkflowConfig": {
|
|
3993
4186
|
"type": "object",
|
|
3994
4187
|
"properties": {
|
|
3995
|
-
"
|
|
3996
|
-
"type": "
|
|
3997
|
-
"
|
|
4188
|
+
"afterScript": {
|
|
4189
|
+
"type": "array",
|
|
4190
|
+
"items": {
|
|
4191
|
+
"type": "string"
|
|
4192
|
+
},
|
|
4193
|
+
"description": "Commands after each job's script, e.g. collecting reports."
|
|
3998
4194
|
},
|
|
3999
|
-
"
|
|
4195
|
+
"beforeScript": {
|
|
4000
4196
|
"type": "array",
|
|
4001
4197
|
"items": {
|
|
4002
4198
|
"type": "string"
|
|
4003
4199
|
},
|
|
4004
|
-
"description": "
|
|
4200
|
+
"description": "Commands after the install and before each job's script."
|
|
4201
|
+
},
|
|
4202
|
+
"image": {
|
|
4203
|
+
"type": "string",
|
|
4204
|
+
"description": "Image for every job instead of `node:<nodeVersion>`. It must have Node.js, which vis runs on."
|
|
4205
|
+
},
|
|
4206
|
+
"services": {
|
|
4207
|
+
"type": "array",
|
|
4208
|
+
"items": {
|
|
4209
|
+
"$ref": "#/$defs/CiGitlabService"
|
|
4210
|
+
}
|
|
4211
|
+
},
|
|
4212
|
+
"stage": {
|
|
4213
|
+
"type": "string",
|
|
4214
|
+
"description": "Stage for every generated job. It has to be one of the `stages:` of the pipeline that includes the file.",
|
|
4215
|
+
"default": "test"
|
|
4216
|
+
},
|
|
4217
|
+
"tags": {
|
|
4218
|
+
"type": "array",
|
|
4219
|
+
"items": {
|
|
4220
|
+
"type": "string"
|
|
4221
|
+
},
|
|
4222
|
+
"description": "Runner tags that pick which runners take the jobs."
|
|
4223
|
+
},
|
|
4224
|
+
"variables": {
|
|
4225
|
+
"type": "object",
|
|
4226
|
+
"additionalProperties": {
|
|
4227
|
+
"type": "string"
|
|
4228
|
+
},
|
|
4229
|
+
"description": "Variables for every job. Use masked CI/CD variables for secrets."
|
|
4005
4230
|
}
|
|
4006
4231
|
},
|
|
4007
4232
|
"additionalProperties": false,
|
|
4008
|
-
"description": "
|
|
4233
|
+
"description": "Additions to the generated GitLab CI file. They apply to every job."
|
|
4009
4234
|
},
|
|
4010
|
-
"
|
|
4011
|
-
"
|
|
4012
|
-
|
|
4013
|
-
|
|
4014
|
-
|
|
4015
|
-
|
|
4016
|
-
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
|
|
4235
|
+
"CiGitlabService": {
|
|
4236
|
+
"anyOf": [
|
|
4237
|
+
{
|
|
4238
|
+
"type": "string"
|
|
4239
|
+
},
|
|
4240
|
+
{
|
|
4241
|
+
"type": "object",
|
|
4242
|
+
"properties": {
|
|
4243
|
+
"alias": {
|
|
4244
|
+
"type": "string"
|
|
4245
|
+
},
|
|
4246
|
+
"command": {
|
|
4247
|
+
"type": "array",
|
|
4248
|
+
"items": {
|
|
4249
|
+
"type": "string"
|
|
4250
|
+
}
|
|
4251
|
+
},
|
|
4252
|
+
"name": {
|
|
4253
|
+
"type": "string"
|
|
4254
|
+
},
|
|
4255
|
+
"variables": {
|
|
4256
|
+
"type": "object",
|
|
4257
|
+
"additionalProperties": {
|
|
4258
|
+
"type": "string"
|
|
4259
|
+
}
|
|
4260
|
+
}
|
|
4261
|
+
},
|
|
4262
|
+
"required": [
|
|
4263
|
+
"name"
|
|
4264
|
+
],
|
|
4265
|
+
"additionalProperties": false
|
|
4266
|
+
}
|
|
4267
|
+
],
|
|
4268
|
+
"description": "A service container for every GitLab job (`services:`)."
|
|
4269
|
+
},
|
|
4270
|
+
"CiWorkflowProvider": {
|
|
4271
|
+
"type": "string",
|
|
4272
|
+
"enum": [
|
|
4273
|
+
"github",
|
|
4274
|
+
"gitlab"
|
|
4275
|
+
],
|
|
4276
|
+
"description": "CI providers `vis sync ci-workflow` can render a workflow for."
|
|
4277
|
+
},
|
|
4278
|
+
"CiWorkflowTargetConfig": {
|
|
4279
|
+
"type": "object",
|
|
4280
|
+
"properties": {
|
|
4281
|
+
"env": {
|
|
4282
|
+
"type": "object",
|
|
4283
|
+
"additionalProperties": {
|
|
4284
|
+
"type": "string"
|
|
4285
|
+
},
|
|
4286
|
+
"description": "Environment variables for this target's step (GitHub) or job (GitLab)."
|
|
4287
|
+
},
|
|
4288
|
+
"name": {
|
|
4289
|
+
"type": "string"
|
|
4290
|
+
}
|
|
4291
|
+
},
|
|
4292
|
+
"required": [
|
|
4293
|
+
"name"
|
|
4294
|
+
],
|
|
4295
|
+
"additionalProperties": false,
|
|
4296
|
+
"description": "A target with settings of its own."
|
|
4297
|
+
},
|
|
4298
|
+
"CodeownersConfig": {
|
|
4299
|
+
"type": "object",
|
|
4300
|
+
"properties": {
|
|
4301
|
+
"blockMarker": {
|
|
4302
|
+
"type": "object",
|
|
4303
|
+
"properties": {
|
|
4304
|
+
"begin": {
|
|
4305
|
+
"type": "string"
|
|
4306
|
+
},
|
|
4307
|
+
"end": {
|
|
4308
|
+
"type": "string"
|
|
4309
|
+
}
|
|
4310
|
+
},
|
|
4311
|
+
"required": [
|
|
4312
|
+
"begin",
|
|
4313
|
+
"end"
|
|
4314
|
+
],
|
|
4315
|
+
"additionalProperties": false,
|
|
4316
|
+
"description": "Markers that bracket the generated block when `preserveBlock` is set."
|
|
4317
|
+
},
|
|
4318
|
+
"globalPaths": {
|
|
4319
|
+
"type": "object",
|
|
4320
|
+
"additionalProperties": {
|
|
4321
|
+
"type": "array",
|
|
4322
|
+
"items": {
|
|
4323
|
+
"type": "string"
|
|
4324
|
+
}
|
|
4325
|
+
},
|
|
4326
|
+
"description": "Workspace-level paths that apply outside any project (e.g., `.github/**`)."
|
|
4327
|
+
},
|
|
4328
|
+
"nestedIncludes": {
|
|
4329
|
+
"type": "array",
|
|
4330
|
+
"items": {
|
|
4331
|
+
"type": "string"
|
|
4332
|
+
},
|
|
4333
|
+
"description": "Glob patterns used to discover nested `CODEOWNERS` files. Defaults to `[\"**\\/CODEOWNERS\"]`."
|
|
4334
|
+
},
|
|
4335
|
+
"orderBy": {
|
|
4336
|
+
"type": "string",
|
|
4337
|
+
"enum": [
|
|
4338
|
+
"file-source",
|
|
4339
|
+
"project-id"
|
|
4340
|
+
],
|
|
4341
|
+
"description": "Sort order for generated entries — mirrors moon's `orderBy`."
|
|
4342
|
+
},
|
|
4343
|
+
"preserveBlock": {
|
|
4344
|
+
"type": "boolean",
|
|
4345
|
+
"description": "When set, the generated content is spliced between {@link CodeownersConfig.blockMarker } markers in the existing file (markers are appended if missing) instead of overwriting the file."
|
|
4346
|
+
},
|
|
4347
|
+
"provider": {
|
|
4348
|
+
"type": "string",
|
|
4349
|
+
"enum": [
|
|
4350
|
+
"bitbucket",
|
|
4351
|
+
"github",
|
|
4352
|
+
"gitlab",
|
|
4353
|
+
"other"
|
|
4354
|
+
],
|
|
4355
|
+
"description": "Provider determines whether `channel` is emitted (GitHub supports it via comment)."
|
|
4356
|
+
},
|
|
4357
|
+
"regenerationCommand": {
|
|
4358
|
+
"type": "string",
|
|
4359
|
+
"description": "Header instruction shown to reviewers. Replaces the default \"Update each project's project.json `owners` field…\" line. Useful when the canonical regenerate path is a custom script."
|
|
4360
|
+
},
|
|
4361
|
+
"sources": {
|
|
4362
|
+
"type": "array",
|
|
4363
|
+
"items": {
|
|
4364
|
+
"$ref": "#/$defs/CodeownersSource"
|
|
4365
|
+
},
|
|
4366
|
+
"description": "Enabled input sources. Defaults to `[\"project-json\"]`."
|
|
4367
|
+
}
|
|
4368
|
+
},
|
|
4369
|
+
"additionalProperties": false
|
|
4370
|
+
},
|
|
4371
|
+
"CodeownersSource": {
|
|
4372
|
+
"type": "string",
|
|
4373
|
+
"enum": [
|
|
4374
|
+
"nested-codeowners",
|
|
4375
|
+
"package-json-maintainers",
|
|
4376
|
+
"project-json"
|
|
4377
|
+
],
|
|
4378
|
+
"description": "Recognised input sources for the codeowners aggregator.\n\n- `project-json` — owners declared on each project's `project.json`. Canonical source; takes precedence over the other two on path conflicts.\n- `nested-codeowners` — `CODEOWNERS` files placed at arbitrary depth in the workspace tree (excluding the generated root file).\n- `package-json-maintainers` — fallback that reads each project's `package.json#maintainers` and emits one entry per project root for projects with no `project.json owners`. GitHub handles are extracted from each maintainer's `url` (e.g. `https://github.com/<handle>`)."
|
|
4379
|
+
},
|
|
4380
|
+
"OxfmtAdapterOverride": {
|
|
4381
|
+
"type": "object",
|
|
4382
|
+
"properties": {
|
|
4383
|
+
"enabled": {
|
|
4384
|
+
"type": "boolean",
|
|
4385
|
+
"description": "Set to `false` to skip this adapter even when its config file or package.json entry is detected. Defaults to `true` (run when detected)."
|
|
4386
|
+
},
|
|
4387
|
+
"extraArgs": {
|
|
4388
|
+
"type": "array",
|
|
4389
|
+
"items": {
|
|
4390
|
+
"type": "string"
|
|
4391
|
+
},
|
|
4392
|
+
"description": "Extra arguments appended verbatim to every invocation of this adapter. Useful for tool-specific flags vis doesn't expose directly (e.g. `eslint --rulesdir`)."
|
|
4393
|
+
},
|
|
4394
|
+
"builtin": {
|
|
4395
|
+
"type": "boolean",
|
|
4396
|
+
"description": "Set to `false` to keep running the project's own `oxfmt` through the adapter orchestration instead of the bundled one. Defaults to `true`."
|
|
4397
|
+
}
|
|
4398
|
+
},
|
|
4399
|
+
"additionalProperties": false,
|
|
4400
|
+
"description": "`fmt.adapters.oxfmt`: the shared overrides plus the switch for the oxfmt that ships with vis."
|
|
4401
|
+
},
|
|
4402
|
+
"LintFmtAdapterOverride": {
|
|
4403
|
+
"type": "object",
|
|
4404
|
+
"properties": {
|
|
4405
|
+
"enabled": {
|
|
4406
|
+
"type": "boolean",
|
|
4407
|
+
"description": "Set to `false` to skip this adapter even when its config file or package.json entry is detected. Defaults to `true` (run when detected)."
|
|
4408
|
+
},
|
|
4409
|
+
"extraArgs": {
|
|
4410
|
+
"type": "array",
|
|
4411
|
+
"items": {
|
|
4412
|
+
"type": "string"
|
|
4413
|
+
},
|
|
4414
|
+
"description": "Extra arguments appended verbatim to every invocation of this adapter. Useful for tool-specific flags vis doesn't expose directly (e.g. `eslint --rulesdir`)."
|
|
4415
|
+
}
|
|
4416
|
+
},
|
|
4417
|
+
"additionalProperties": false,
|
|
4418
|
+
"description": "Per-adapter override applied by `vis lint` / `vis fmt`. Keyed by adapter id under `lint.adapters` / `fmt.adapters`. Every field is optional — set only what you need to change."
|
|
4419
|
+
},
|
|
4420
|
+
"FmtEngine": {
|
|
4421
|
+
"type": "string",
|
|
4422
|
+
"enum": [
|
|
4423
|
+
"auto",
|
|
4424
|
+
"oxfmt",
|
|
4425
|
+
"prettier"
|
|
4426
|
+
],
|
|
4427
|
+
"description": "Which engine `vis fmt` uses.\n- `auto`: the bundled oxfmt, unless the workspace uses biome, dprint or ruff format.\n- `oxfmt`: always the bundled oxfmt.\n- `prettier`: the detected-adapter orchestration, with Prettier staying in charge."
|
|
4428
|
+
},
|
|
4429
|
+
"FmtAdapterId": {
|
|
4430
|
+
"type": "string",
|
|
4431
|
+
"enum": [
|
|
4432
|
+
"biome",
|
|
4433
|
+
"dprint",
|
|
4434
|
+
"oxfmt",
|
|
4435
|
+
"prettier",
|
|
4436
|
+
"ruff-fmt"
|
|
4437
|
+
],
|
|
4438
|
+
"description": "Adapter IDs that can format (adapter `kind` is `\"fmt\"` or `\"both\"`)."
|
|
4439
|
+
},
|
|
4440
|
+
"OxfmtOptions": {
|
|
4441
|
+
"type": "object",
|
|
4442
|
+
"properties": {
|
|
4443
|
+
"arrowParens": {
|
|
4444
|
+
"type": "string",
|
|
4445
|
+
"enum": [
|
|
4446
|
+
"always",
|
|
4447
|
+
"avoid"
|
|
4448
|
+
],
|
|
4449
|
+
"description": "Include parentheses around a sole arrow function parameter.\n\n- Languages: JS, JSX, TS, TSX\n- Default: `\"always\"`"
|
|
4450
|
+
},
|
|
4451
|
+
"astro": {
|
|
4452
|
+
"anyOf": [
|
|
4453
|
+
{
|
|
4454
|
+
"type": "boolean"
|
|
4455
|
+
},
|
|
4456
|
+
{
|
|
4457
|
+
"type": "object",
|
|
4458
|
+
"properties": {
|
|
4459
|
+
"allowShorthand": {
|
|
4460
|
+
"type": "boolean",
|
|
4461
|
+
"description": "Whether to normalize matching identifier attributes to shorthand or explicit form. When unset, the form that was written stays as-is.\n\n- Default: Unset"
|
|
4462
|
+
},
|
|
4463
|
+
"compressHTML": {
|
|
4464
|
+
"type": "string",
|
|
4465
|
+
"enum": [
|
|
4466
|
+
"jsx",
|
|
4467
|
+
"html",
|
|
4468
|
+
"none"
|
|
4469
|
+
],
|
|
4470
|
+
"description": "Mirror of Astro's `compressHTML` config. Tells the formatter which whitespace the compiler will collapse.\n\n- Default: `\"jsx\"`"
|
|
4471
|
+
},
|
|
4472
|
+
"skipFrontmatter": {
|
|
4473
|
+
"type": "boolean",
|
|
4474
|
+
"description": "Whether to skip formatting the frontmatter.\n\n- Default: `false`"
|
|
4475
|
+
}
|
|
4476
|
+
},
|
|
4477
|
+
"additionalProperties": {}
|
|
4478
|
+
}
|
|
4479
|
+
],
|
|
4480
|
+
"description": "Options for `prettier-plugin-astro`.\n\nPass `true` or an object to enable `.astro` file formatting, `false` to disable (handy in overrides). Setting `true` resets to defaults, dropping options inherited from a parent scope.\n\nNOTE: `prettier-plugin-astro` requires the `@astrojs/compiler-rs` package at runtime. Oxfmt does NOT bundle it, so install it in your project, otherwise formatting fails.\n\n- Languages: Astro\n- Default: Disabled"
|
|
4481
|
+
},
|
|
4482
|
+
"bracketSameLine": {
|
|
4483
|
+
"type": "boolean",
|
|
4484
|
+
"description": "Put the `>` of a multi-line element at the end of the last line, instead of being alone on the next line (does not apply to self-closing elements).\n\n- Languages: JSX, TSX, HTML, Angular, Vue, MJML, Svelte, Astro\n- Default: `false`"
|
|
4485
|
+
},
|
|
4486
|
+
"bracketSpacing": {
|
|
4487
|
+
"type": "boolean",
|
|
4488
|
+
"description": "Print spaces between brackets in object literals.\n\n- Languages: JS, JSX, TS, TSX, JSON, JSONC, JSON5, GraphQL, YAML\n- Default: `true`"
|
|
4489
|
+
},
|
|
4490
|
+
"embeddedLanguageFormatting": {
|
|
4491
|
+
"type": "string",
|
|
4492
|
+
"enum": [
|
|
4493
|
+
"auto",
|
|
4494
|
+
"off"
|
|
4495
|
+
],
|
|
4496
|
+
"description": "Control whether to format embedded parts in the file. For example:\n- CSS-in-JS: template literal\n- JS-in-Vue: `<script>` block\n- JS-in-Markdown: code fence\n- YAML-in-CSS/Markdown: front matter\n\nWith `\"off\"`, these parts are kept as-is.\n\nNOTE: Some languages behave differently. For Svelte, formatting fails with `\"off\"`, a limitation of `prettier-plugin-svelte`. For Astro, the frontmatter is still formatted, but by Prettier instead of Oxfmt (use `astro.skipFrontmatter` to keep it as-is).\n\n- Languages: JS, JSX, TS, TSX, CSS, SCSS, Less, HTML, Vue, Angular, Svelte, Astro, Markdown, MDX\n- Default: `\"auto\"`"
|
|
4497
|
+
},
|
|
4498
|
+
"endOfLine": {
|
|
4499
|
+
"type": "string",
|
|
4500
|
+
"enum": [
|
|
4501
|
+
"lf",
|
|
4502
|
+
"crlf",
|
|
4503
|
+
"cr"
|
|
4504
|
+
],
|
|
4505
|
+
"description": "Which end of line characters to apply.\n\nNOTE: `\"auto\"` is not supported.\n\n- Languages: All\n- Default: `\"lf\"`\n- Overrides `.editorconfig.end_of_line`"
|
|
4506
|
+
},
|
|
4507
|
+
"experimentalOperatorPosition": {
|
|
4508
|
+
"type": "string",
|
|
4509
|
+
"enum": [
|
|
4510
|
+
"start",
|
|
4511
|
+
"end"
|
|
4512
|
+
],
|
|
4513
|
+
"description": "When expressions wrap lines, print operators at the start of new lines (`\"start\"`) or at the end of previous lines (`\"end\"`).\n\n- Languages: JS, JSX, TS, TSX\n- Default: `\"end\"`"
|
|
4514
|
+
},
|
|
4515
|
+
"htmlWhitespaceSensitivity": {
|
|
4516
|
+
"type": "string",
|
|
4517
|
+
"enum": [
|
|
4518
|
+
"css",
|
|
4519
|
+
"strict",
|
|
4520
|
+
"ignore"
|
|
4521
|
+
],
|
|
4522
|
+
"description": "Specify the global whitespace sensitivity.\n\n- Languages: HTML, Angular, Vue, Handlebars, Svelte\n- Default: `\"css\"`"
|
|
4523
|
+
},
|
|
4524
|
+
"insertFinalNewline": {
|
|
4525
|
+
"type": "boolean",
|
|
4526
|
+
"description": "Whether to insert a final newline at the end of the file.\n\n- Languages: All\n- Default: `true`\n- Overrides `.editorconfig.insert_final_newline`"
|
|
4527
|
+
},
|
|
4528
|
+
"jsdoc": {
|
|
4529
|
+
"anyOf": [
|
|
4530
|
+
{
|
|
4531
|
+
"type": "boolean"
|
|
4532
|
+
},
|
|
4533
|
+
{
|
|
4534
|
+
"type": "object",
|
|
4535
|
+
"properties": {
|
|
4536
|
+
"addDefaultToDescription": {
|
|
4537
|
+
"type": "boolean",
|
|
4538
|
+
"description": "Append default values to `@param` descriptions (e.g. \"Default is `value`\").\n\n- Default: `true`"
|
|
4539
|
+
},
|
|
4540
|
+
"bracketSpacing": {
|
|
4541
|
+
"type": "boolean",
|
|
4542
|
+
"description": "Add spaces inside JSDoc type braces: `{string}` → `{ string }`.\n\n- Default: `false`"
|
|
4543
|
+
},
|
|
4544
|
+
"capitalizeDescriptions": {
|
|
4545
|
+
"type": "boolean",
|
|
4546
|
+
"description": "Capitalize the first letter of tag descriptions.\n\n- Default: `true`"
|
|
4547
|
+
},
|
|
4548
|
+
"commentLineStrategy": {
|
|
4549
|
+
"type": "string",
|
|
4550
|
+
"enum": [
|
|
4551
|
+
"singleLine",
|
|
4552
|
+
"multiline",
|
|
4553
|
+
"keep"
|
|
4554
|
+
],
|
|
4555
|
+
"description": "How to format comment blocks.\n\n- `\"singleLine\"`: Convert to single-line `/** content * /` when possible\n- `\"multiline\"`: Always use multi-line format\n- `\"keep\"`: Preserve original formatting\n\nBy default, comments are collapsed to a single line when possible.\n\n- Default: `\"singleLine\"`"
|
|
4556
|
+
},
|
|
4557
|
+
"descriptionTag": {
|
|
4558
|
+
"type": "boolean",
|
|
4559
|
+
"description": "Emit `@description` tag instead of inline description.\n\n- Default: `false`"
|
|
4560
|
+
},
|
|
4561
|
+
"descriptionWithDot": {
|
|
4562
|
+
"type": "boolean",
|
|
4563
|
+
"description": "Add a trailing dot to the end of descriptions.\n\n- Default: `false`"
|
|
4564
|
+
},
|
|
4565
|
+
"keepUnparsableExampleIndent": {
|
|
4566
|
+
"type": "boolean",
|
|
4567
|
+
"description": "Preserve indentation in unparsable `@example` code.\n\n- Default: `false`"
|
|
4568
|
+
},
|
|
4569
|
+
"lineWrappingStyle": {
|
|
4570
|
+
"type": "string",
|
|
4571
|
+
"enum": [
|
|
4572
|
+
"greedy",
|
|
4573
|
+
"balance"
|
|
4574
|
+
],
|
|
4575
|
+
"description": "Strategy for wrapping description lines at print width.\n\n- `\"greedy\"`: Always re-wrap text to fit within print width\n- `\"balance\"`: Preserve original line breaks if all lines fit within print width\n\nBy default, description lines are always re-wrapped.\n\n- Default: `\"greedy\"`"
|
|
4576
|
+
},
|
|
4577
|
+
"preferCodeFences": {
|
|
4578
|
+
"type": "boolean",
|
|
4579
|
+
"description": "Use fenced code blocks (```` ``` ````) instead of 4-space indentation for code without a language tag.\n\n- Default: `false`"
|
|
4580
|
+
},
|
|
4581
|
+
"separateReturnsFromParam": {
|
|
4582
|
+
"type": "boolean",
|
|
4583
|
+
"description": "Add a blank line between the last `@param` and `@returns`.\n\n- Default: `false`"
|
|
4584
|
+
},
|
|
4585
|
+
"separateTagGroups": {
|
|
4586
|
+
"type": "boolean",
|
|
4587
|
+
"description": "Add blank lines between different tag groups (e.g. between `@param` and `@returns`).\n\n- Default: `false`"
|
|
4588
|
+
}
|
|
4589
|
+
},
|
|
4590
|
+
"additionalProperties": {}
|
|
4591
|
+
}
|
|
4592
|
+
],
|
|
4593
|
+
"description": "Enable JSDoc comment formatting.\n\nNormalizes JSDoc comments: tag aliases are canonicalized, descriptions are capitalized, long lines are wrapped, and short comments are collapsed to single-line.\n\nPass `true` or an object to enable, `false` to disable.\n\n- Languages: JS, JSX, TS, TSX\n- Default: Disabled"
|
|
4594
|
+
},
|
|
4595
|
+
"jsxSingleQuote": {
|
|
4596
|
+
"type": "boolean",
|
|
4597
|
+
"description": "Use single quotes instead of double quotes in JSX.\n\n- Languages: JSX, TSX\n- Default: `false`"
|
|
4598
|
+
},
|
|
4599
|
+
"objectWrap": {
|
|
4600
|
+
"type": "string",
|
|
4601
|
+
"enum": [
|
|
4602
|
+
"preserve",
|
|
4603
|
+
"collapse"
|
|
4604
|
+
],
|
|
4605
|
+
"description": "How to wrap object literals when they could fit on one line or span multiple lines.\n\nBy default, formats objects as multi-line if there is a newline prior to the first property. Authors can use this heuristic to contextually improve readability, though it has some downsides.\n\n- Languages: JS, JSX, TS, TSX, JSON, JSONC, JSON5\n- Default: `\"preserve\"`"
|
|
4606
|
+
},
|
|
4607
|
+
"printWidth": {
|
|
4608
|
+
"type": "number",
|
|
4609
|
+
"description": "Specify the line length that the printer will wrap on.\n\nIf you don't want line wrapping when formatting Markdown, you can set the `proseWrap` option to disable it.\n\n- Languages: All\n- Default: `100`\n- Overrides `.editorconfig.max_line_length`"
|
|
4610
|
+
},
|
|
4611
|
+
"proseWrap": {
|
|
4612
|
+
"type": "string",
|
|
4613
|
+
"enum": [
|
|
4614
|
+
"always",
|
|
4615
|
+
"never",
|
|
4616
|
+
"preserve"
|
|
4617
|
+
],
|
|
4618
|
+
"description": "How to wrap prose.\n\n- `\"always\"`: Wrap prose to the print width\n- `\"never\"`: Put each prose block on a single line, relying on editor/viewer soft wrapping\n- `\"preserve\"`: Keep wrapping as-is\n\nBy default, wrapping is preserved, since some services use a linebreak-sensitive renderer (e.g. GitHub comments, BitBucket).\n\n- Languages: Markdown, MDX, YAML\n- Default: `\"preserve\"`"
|
|
4619
|
+
},
|
|
4620
|
+
"quoteProps": {
|
|
4621
|
+
"type": "string",
|
|
4622
|
+
"enum": [
|
|
4623
|
+
"as-needed",
|
|
4624
|
+
"consistent",
|
|
4625
|
+
"preserve"
|
|
4626
|
+
],
|
|
4627
|
+
"description": "Change when properties in objects are quoted.\n\n- Languages: JS, JSX, TS, TSX\n- Default: `\"as-needed\"`"
|
|
4628
|
+
},
|
|
4629
|
+
"semi": {
|
|
4630
|
+
"type": "boolean",
|
|
4631
|
+
"description": "Print semicolons at the ends of statements.\n\n- Languages: JS, JSX, TS, TSX\n- Default: `true`"
|
|
4632
|
+
},
|
|
4633
|
+
"singleAttributePerLine": {
|
|
4634
|
+
"type": "boolean",
|
|
4635
|
+
"description": "Enforce single attribute per line.\n\n- Languages: JSX, TSX, HTML, Angular, Vue, MJML, Svelte, Astro\n- Default: `false`"
|
|
4636
|
+
},
|
|
4637
|
+
"singleQuote": {
|
|
4638
|
+
"type": "boolean",
|
|
4639
|
+
"description": "Use single quotes instead of double quotes.\n\nFor JSX, you can set the `jsxSingleQuote` option.\n\n- Languages: JS, JSX, TS, TSX, CSS, Less, SCSS, Markdown, MDX, YAML, Handlebars, Svelte, Astro\n- Default: `false`\n- Overrides `.editorconfig.quote_type`"
|
|
4640
|
+
},
|
|
4641
|
+
"sortImports": {
|
|
4642
|
+
"anyOf": [
|
|
4643
|
+
{
|
|
4644
|
+
"type": "boolean"
|
|
4645
|
+
},
|
|
4646
|
+
{
|
|
4647
|
+
"type": "object",
|
|
4648
|
+
"properties": {
|
|
4649
|
+
"customGroups": {
|
|
4650
|
+
"type": "array",
|
|
4651
|
+
"items": {
|
|
4652
|
+
"type": "object",
|
|
4653
|
+
"properties": {
|
|
4654
|
+
"elementNamePattern": {
|
|
4655
|
+
"type": "array",
|
|
4656
|
+
"items": {
|
|
4657
|
+
"type": "string"
|
|
4658
|
+
},
|
|
4659
|
+
"description": "List of glob patterns to match import sources for this group."
|
|
4660
|
+
},
|
|
4661
|
+
"groupName": {
|
|
4662
|
+
"type": "string",
|
|
4663
|
+
"description": "Name of the custom group, used in the `groups` option."
|
|
4664
|
+
},
|
|
4665
|
+
"modifiers": {
|
|
4666
|
+
"type": "array",
|
|
4667
|
+
"items": {
|
|
4668
|
+
"type": "string",
|
|
4669
|
+
"enum": [
|
|
4670
|
+
"side_effect",
|
|
4671
|
+
"type",
|
|
4672
|
+
"value",
|
|
4673
|
+
"default",
|
|
4674
|
+
"wildcard",
|
|
4675
|
+
"named"
|
|
4676
|
+
],
|
|
4677
|
+
"description": "Modifier matching the import characteristics in `customGroups` (see `sortImports.groups` for semantics)."
|
|
4678
|
+
},
|
|
4679
|
+
"description": "Modifiers to match the import characteristics. All specified modifiers must match."
|
|
4680
|
+
},
|
|
4681
|
+
"selector": {
|
|
4682
|
+
"type": "string",
|
|
4683
|
+
"enum": [
|
|
4684
|
+
"type",
|
|
4685
|
+
"side_effect_style",
|
|
4686
|
+
"side_effect",
|
|
4687
|
+
"style",
|
|
4688
|
+
"index",
|
|
4689
|
+
"sibling",
|
|
4690
|
+
"parent",
|
|
4691
|
+
"subpath",
|
|
4692
|
+
"internal",
|
|
4693
|
+
"builtin",
|
|
4694
|
+
"external",
|
|
4695
|
+
"import"
|
|
4696
|
+
],
|
|
4697
|
+
"description": "Selector to match the import kind."
|
|
4698
|
+
}
|
|
4699
|
+
},
|
|
4700
|
+
"additionalProperties": {}
|
|
4701
|
+
},
|
|
4702
|
+
"description": "Define your own groups for matching very specific imports.\n\nThe first matching definition is used, and custom groups take precedence over predefined groups. To give a predefined group precedence, define an equivalent custom group and put it first.\n\nWhen multiple conditions (`elementNamePattern`, `selector`, `modifiers`) are specified, all of them must match.\n\nNOTE: Predefined group names (e.g. `side_effect`, `external`) and `unknown` are reserved and cannot be used as `groupName`.\n\n- Default: `[]`"
|
|
4703
|
+
},
|
|
4704
|
+
"groups": {
|
|
4705
|
+
"type": "array",
|
|
4706
|
+
"items": {
|
|
4707
|
+
"anyOf": [
|
|
4708
|
+
{
|
|
4709
|
+
"type": "object",
|
|
4710
|
+
"properties": {
|
|
4711
|
+
"newlinesBetween": {
|
|
4712
|
+
"type": "boolean"
|
|
4713
|
+
}
|
|
4714
|
+
},
|
|
4715
|
+
"required": [
|
|
4716
|
+
"newlinesBetween"
|
|
4717
|
+
],
|
|
4718
|
+
"additionalProperties": {},
|
|
4719
|
+
"description": "A marker object for overriding `newlinesBetween` at a specific group boundary."
|
|
4720
|
+
},
|
|
4721
|
+
{
|
|
4722
|
+
"type": "string"
|
|
4723
|
+
},
|
|
4724
|
+
{
|
|
4725
|
+
"type": "array",
|
|
4726
|
+
"items": {
|
|
4727
|
+
"type": "string"
|
|
4728
|
+
}
|
|
4729
|
+
}
|
|
4730
|
+
]
|
|
4731
|
+
},
|
|
4732
|
+
"description": "List of import groups for sorting.\n\nEach import is assigned to a single group (or `unknown` if none matches), and groups are ordered as listed. Within a group, imports are sorted according to `order`, `ignoreCase`, etc.\n\nA predefined group name is a single selector with optional modifiers, joined by `-` (e.g. `type-external`). Modifiers can be in any order, but the selector must come last.\n\nSelectors, from most to least important:\n- `type`: TypeScript type imports.\n- `side_effect_style`: Side effect style imports.\n- `side_effect`: Side effect imports.\n- `style`: Style imports.\n- `index`: Main file from the current directory.\n- `sibling`: Modules from the same directory.\n- `parent`: Modules from the parent directory.\n- `subpath`: Node.js subpath imports.\n- `internal`: Your internal modules.\n- `builtin`: Node.js Built-in Modules.\n- `external`: External modules installed in the project.\n- `import`: Any import.\n\nModifiers, from most to least important:\n- `side_effect`: Side effect imports.\n- `type`: TypeScript type imports.\n- `value`: Value imports.\n- `default`: Imports containing the default specifier.\n- `wildcard`: Imports containing the wildcard (`* as`) specifier.\n- `named`: Imports containing at least one named specifier.\n\nWrap groups in an array to sort them together as a single group (order within the array does not matter).\n\nTo override `newlinesBetween` at a specific group boundary, put a `{ \"newlinesBetween\": boolean }` marker object at that position.\n\n- Default: See below ```json [ \"builtin\", \"external\", [\"internal\", \"subpath\"], [\"parent\", \"sibling\", \"index\"], \"style\", \"unknown\" ] ```"
|
|
4733
|
+
},
|
|
4734
|
+
"ignoreCase": {
|
|
4735
|
+
"type": "boolean",
|
|
4736
|
+
"description": "Ignore case when sorting.\n\n- Default: `true`"
|
|
4737
|
+
},
|
|
4738
|
+
"internalPattern": {
|
|
4739
|
+
"type": "array",
|
|
4740
|
+
"items": {
|
|
4741
|
+
"type": "string"
|
|
4742
|
+
},
|
|
4743
|
+
"description": "Prefixes for identifying internal imports.\n\n- Default: `[\"~/\", \"@/\", \"#\"]`"
|
|
4744
|
+
},
|
|
4745
|
+
"newlinesBetween": {
|
|
4746
|
+
"type": "boolean",
|
|
4747
|
+
"description": "Add newlines between groups.\n\n- Default: `true`"
|
|
4748
|
+
},
|
|
4749
|
+
"order": {
|
|
4750
|
+
"type": "string",
|
|
4751
|
+
"enum": [
|
|
4752
|
+
"asc",
|
|
4753
|
+
"desc"
|
|
4754
|
+
],
|
|
4755
|
+
"description": "Sort in ascending or descending order.\n\n- Default: `\"asc\"`"
|
|
4756
|
+
},
|
|
4757
|
+
"partitionByComment": {
|
|
4758
|
+
"type": "boolean",
|
|
4759
|
+
"description": "Use comments to separate imports into logical groups.\n\nWhen `true`, all comments are treated as delimiters.\n\n```js import { b1, b2 } from 'b' // PARTITION import { a } from 'a' import { c } from 'c' ```\n\n- Default: `false`"
|
|
4760
|
+
},
|
|
4761
|
+
"partitionByNewline": {
|
|
4762
|
+
"type": "boolean",
|
|
4763
|
+
"description": "Use empty lines to separate imports into logical groups.\n\nWhen `true`, imports are not sorted across an empty line.\n\n```js import { b1, b2 } from 'b'\n\nimport { a } from 'a' import { c } from 'c' ```\n\n- Default: `false`"
|
|
4764
|
+
},
|
|
4765
|
+
"sortSideEffects": {
|
|
4766
|
+
"type": "boolean",
|
|
4767
|
+
"description": "Sort side effect imports.\n\nDisabled by default for safety reasons.\n\n- Default: `false`"
|
|
4768
|
+
}
|
|
4769
|
+
},
|
|
4770
|
+
"additionalProperties": {}
|
|
4771
|
+
}
|
|
4772
|
+
],
|
|
4773
|
+
"description": "Sort import statements.\n\nUses a similar algorithm to [eslint-plugin-perfectionist/sort-imports](https://perfectionist.dev/rules/sort-imports).\n\nPass `true` or an object to enable, `false` to disable.\n\n- Languages: JS, JSX, TS, TSX\n- Default: Disabled"
|
|
4774
|
+
},
|
|
4775
|
+
"sortPackageJson": {
|
|
4776
|
+
"anyOf": [
|
|
4777
|
+
{
|
|
4778
|
+
"type": "boolean"
|
|
4779
|
+
},
|
|
4780
|
+
{
|
|
4781
|
+
"type": "object",
|
|
4782
|
+
"properties": {
|
|
4783
|
+
"sortScripts": {
|
|
4784
|
+
"type": "boolean",
|
|
4785
|
+
"description": "Sort the `scripts` field alphabetically.\n\n- Default: `false`"
|
|
4786
|
+
}
|
|
4787
|
+
},
|
|
4788
|
+
"additionalProperties": {}
|
|
4789
|
+
}
|
|
4790
|
+
],
|
|
4791
|
+
"description": "Sort `package.json` keys.\n\nThe order is NOT compatible with [prettier-plugin-packagejson](https://github.com/matzkoh/prettier-plugin-packagejson), but we believe it is clearer and easier to navigate.\n\n- Languages: JSON (`package.json` only)\n- Default: `true`"
|
|
4792
|
+
},
|
|
4793
|
+
"sortTailwindcss": {
|
|
4794
|
+
"anyOf": [
|
|
4795
|
+
{
|
|
4796
|
+
"type": "boolean"
|
|
4797
|
+
},
|
|
4798
|
+
{
|
|
4799
|
+
"type": "object",
|
|
4800
|
+
"properties": {
|
|
4801
|
+
"attributes": {
|
|
4802
|
+
"type": "array",
|
|
4803
|
+
"items": {
|
|
4804
|
+
"type": "string"
|
|
4805
|
+
},
|
|
4806
|
+
"description": "List of additional attributes to sort beyond `class` and `className` (exact match).\n\nNOTE: Regex patterns are not yet supported.\n\n- Default: `[]`\n- Example: `[\"myClassProp\", \":class\"]`"
|
|
4807
|
+
},
|
|
4808
|
+
"config": {
|
|
4809
|
+
"type": "string",
|
|
4810
|
+
"description": "Path to your Tailwind CSS configuration file (v3).\n\nNOTE: Paths are resolved relative to the Oxfmt configuration file.\n\n- Default: Automatically find `\"tailwind.config.js\"`"
|
|
4811
|
+
},
|
|
4812
|
+
"functions": {
|
|
4813
|
+
"type": "array",
|
|
4814
|
+
"items": {
|
|
4815
|
+
"type": "string"
|
|
4816
|
+
},
|
|
4817
|
+
"description": "List of custom function names whose arguments should be sorted (exact match).\n\nNOTE: Regex patterns are not yet supported.\n\n- Default: `[]`\n- Example: `[\"clsx\", \"cn\", \"cva\", \"tw\"]`"
|
|
4818
|
+
},
|
|
4819
|
+
"preserveDuplicates": {
|
|
4820
|
+
"type": "boolean",
|
|
4821
|
+
"description": "Preserve duplicate classes.\n\n- Default: `false`"
|
|
4822
|
+
},
|
|
4823
|
+
"preserveWhitespace": {
|
|
4824
|
+
"type": "boolean",
|
|
4825
|
+
"description": "Preserve whitespace around classes.\n\n- Default: `false`"
|
|
4826
|
+
},
|
|
4827
|
+
"stylesheet": {
|
|
4828
|
+
"type": "string",
|
|
4829
|
+
"description": "Path to your Tailwind CSS stylesheet (v4).\n\nNOTE: Paths are resolved relative to the Oxfmt configuration file.\n\n- Default: Installed Tailwind CSS's `theme.css`"
|
|
4830
|
+
}
|
|
4831
|
+
},
|
|
4832
|
+
"additionalProperties": {}
|
|
4833
|
+
}
|
|
4834
|
+
],
|
|
4835
|
+
"description": "Sort Tailwind CSS classes.\n\nUses the same algorithm as [prettier-plugin-tailwindcss](https://github.com/tailwindlabs/prettier-plugin-tailwindcss). Option names omit the `tailwind` prefix used in the original plugin (e.g. `config` instead of `tailwindConfig`).\n\nPass `true` or an object to enable, `false` to disable.\n\n- Languages: JS, JSX, TS, TSX, HTML, Vue, Angular, Handlebars, CSS, SCSS, Less, Svelte, Astro\n- Default: Disabled"
|
|
4836
|
+
},
|
|
4837
|
+
"svelte": {
|
|
4838
|
+
"anyOf": [
|
|
4839
|
+
{
|
|
4840
|
+
"type": "boolean"
|
|
4841
|
+
},
|
|
4842
|
+
{
|
|
4843
|
+
"type": "object",
|
|
4844
|
+
"properties": {
|
|
4845
|
+
"allowShorthand": {
|
|
4846
|
+
"type": "boolean",
|
|
4847
|
+
"description": "Whether to allow attribute shorthand if attribute name and expression are the same.\n\n- Default: `true`"
|
|
4848
|
+
},
|
|
4849
|
+
"indentScriptAndStyle": {
|
|
4850
|
+
"type": "boolean",
|
|
4851
|
+
"description": "Whether to indent code inside `<script>` and `<style>` tags.\n\n- Default: `true`"
|
|
4852
|
+
},
|
|
4853
|
+
"sortOrder": {
|
|
4854
|
+
"type": "string",
|
|
4855
|
+
"description": "The order in which Svelte component sections are printed. Join `options`, `scripts`, `markup`, `styles` with `-` in the desired order, or use `none` to keep the original order.\n\n- Default: `\"options-scripts-markup-styles\"`"
|
|
4856
|
+
}
|
|
4857
|
+
},
|
|
4858
|
+
"additionalProperties": {}
|
|
4859
|
+
}
|
|
4860
|
+
],
|
|
4861
|
+
"description": "Options for `prettier-plugin-svelte`.\n\nPass `true` or an object to enable `.svelte` file formatting, `false` to disable (handy in overrides). Setting `true` resets to defaults, dropping options inherited from a parent scope.\n\nNOTE: `prettier-plugin-svelte` requires the `svelte` package (`svelte/compiler`) at runtime. Oxfmt does NOT bundle it, so install it in your project, otherwise formatting fails.\n\n- Languages: Svelte\n- Default: Disabled"
|
|
4862
|
+
},
|
|
4863
|
+
"tabWidth": {
|
|
4864
|
+
"type": "number",
|
|
4865
|
+
"description": "Specify the number of spaces per indentation-level.\n\n- Languages: All\n- Default: `2`\n- Overrides `.editorconfig.indent_size` (falls back to `.editorconfig.tab_width`)"
|
|
4866
|
+
},
|
|
4867
|
+
"trailingComma": {
|
|
4868
|
+
"type": "string",
|
|
4869
|
+
"enum": [
|
|
4870
|
+
"all",
|
|
4871
|
+
"es5",
|
|
4872
|
+
"none"
|
|
4873
|
+
],
|
|
4874
|
+
"description": "Print trailing commas wherever possible in multi-line comma-separated syntactic structures.\n\nA single-line array, for example, never gets trailing commas.\n\n- Languages: JS, JSX, TS, TSX, JSONC, JSON5, TOML, CSS, Less, SCSS, YAML\n- Default: `\"all\"`"
|
|
4875
|
+
},
|
|
4876
|
+
"useTabs": {
|
|
4877
|
+
"type": "boolean",
|
|
4878
|
+
"description": "Indent lines with tabs instead of spaces.\n\n- Languages: All\n- Default: `false`\n- Overrides `.editorconfig.indent_style`"
|
|
4879
|
+
},
|
|
4880
|
+
"vueIndentScriptAndStyle": {
|
|
4881
|
+
"type": "boolean",
|
|
4882
|
+
"description": "Whether or not to indent the code inside `<script>` and `<style>` tags in Vue files.\n\n- Languages: Vue\n- Default: `false`"
|
|
4883
|
+
}
|
|
4884
|
+
},
|
|
4885
|
+
"additionalProperties": {},
|
|
4886
|
+
"description": "Formatting options accepted by oxfmt, as declared by the `oxfmt` package."
|
|
4887
|
+
},
|
|
4888
|
+
"FmtOverride": {
|
|
4889
|
+
"type": "object",
|
|
4890
|
+
"properties": {
|
|
4891
|
+
"excludeFiles": {
|
|
4892
|
+
"type": "array",
|
|
4893
|
+
"items": {
|
|
4894
|
+
"type": "string"
|
|
4895
|
+
},
|
|
4896
|
+
"description": "Glob patterns to exclude from this override."
|
|
4897
|
+
},
|
|
4898
|
+
"files": {
|
|
4899
|
+
"type": "array",
|
|
4900
|
+
"items": {
|
|
4901
|
+
"type": "string"
|
|
4902
|
+
},
|
|
4903
|
+
"description": "Glob patterns to match files for this override."
|
|
4904
|
+
},
|
|
4905
|
+
"options": {
|
|
4906
|
+
"type": "object",
|
|
4907
|
+
"properties": {
|
|
4908
|
+
"arrowParens": {
|
|
4909
|
+
"type": "string",
|
|
4910
|
+
"enum": [
|
|
4911
|
+
"always",
|
|
4912
|
+
"avoid"
|
|
4913
|
+
],
|
|
4914
|
+
"description": "Include parentheses around a sole arrow function parameter.\n\n- Languages: JS, JSX, TS, TSX\n- Default: `\"always\"`"
|
|
4915
|
+
},
|
|
4916
|
+
"astro": {
|
|
4917
|
+
"anyOf": [
|
|
4918
|
+
{
|
|
4919
|
+
"type": "boolean"
|
|
4920
|
+
},
|
|
4921
|
+
{
|
|
4922
|
+
"type": "object",
|
|
4923
|
+
"properties": {
|
|
4924
|
+
"allowShorthand": {
|
|
4925
|
+
"type": "boolean",
|
|
4926
|
+
"description": "Whether to normalize matching identifier attributes to shorthand or explicit form. When unset, the form that was written stays as-is.\n\n- Default: Unset"
|
|
4927
|
+
},
|
|
4928
|
+
"compressHTML": {
|
|
4929
|
+
"type": "string",
|
|
4930
|
+
"enum": [
|
|
4931
|
+
"jsx",
|
|
4932
|
+
"html",
|
|
4933
|
+
"none"
|
|
4934
|
+
],
|
|
4935
|
+
"description": "Mirror of Astro's `compressHTML` config. Tells the formatter which whitespace the compiler will collapse.\n\n- Default: `\"jsx\"`"
|
|
4936
|
+
},
|
|
4937
|
+
"skipFrontmatter": {
|
|
4938
|
+
"type": "boolean",
|
|
4939
|
+
"description": "Whether to skip formatting the frontmatter.\n\n- Default: `false`"
|
|
4940
|
+
}
|
|
4941
|
+
},
|
|
4942
|
+
"additionalProperties": {}
|
|
4943
|
+
}
|
|
4944
|
+
],
|
|
4945
|
+
"description": "Options for `prettier-plugin-astro`.\n\nPass `true` or an object to enable `.astro` file formatting, `false` to disable (handy in overrides). Setting `true` resets to defaults, dropping options inherited from a parent scope.\n\nNOTE: `prettier-plugin-astro` requires the `@astrojs/compiler-rs` package at runtime. Oxfmt does NOT bundle it, so install it in your project, otherwise formatting fails.\n\n- Languages: Astro\n- Default: Disabled"
|
|
4946
|
+
},
|
|
4947
|
+
"bracketSameLine": {
|
|
4948
|
+
"type": "boolean",
|
|
4949
|
+
"description": "Put the `>` of a multi-line element at the end of the last line, instead of being alone on the next line (does not apply to self-closing elements).\n\n- Languages: JSX, TSX, HTML, Angular, Vue, MJML, Svelte, Astro\n- Default: `false`"
|
|
4950
|
+
},
|
|
4951
|
+
"bracketSpacing": {
|
|
4952
|
+
"type": "boolean",
|
|
4953
|
+
"description": "Print spaces between brackets in object literals.\n\n- Languages: JS, JSX, TS, TSX, JSON, JSONC, JSON5, GraphQL, YAML\n- Default: `true`"
|
|
4954
|
+
},
|
|
4955
|
+
"embeddedLanguageFormatting": {
|
|
4956
|
+
"type": "string",
|
|
4957
|
+
"enum": [
|
|
4958
|
+
"auto",
|
|
4959
|
+
"off"
|
|
4960
|
+
],
|
|
4961
|
+
"description": "Control whether to format embedded parts in the file. For example:\n- CSS-in-JS: template literal\n- JS-in-Vue: `<script>` block\n- JS-in-Markdown: code fence\n- YAML-in-CSS/Markdown: front matter\n\nWith `\"off\"`, these parts are kept as-is.\n\nNOTE: Some languages behave differently. For Svelte, formatting fails with `\"off\"`, a limitation of `prettier-plugin-svelte`. For Astro, the frontmatter is still formatted, but by Prettier instead of Oxfmt (use `astro.skipFrontmatter` to keep it as-is).\n\n- Languages: JS, JSX, TS, TSX, CSS, SCSS, Less, HTML, Vue, Angular, Svelte, Astro, Markdown, MDX\n- Default: `\"auto\"`"
|
|
4962
|
+
},
|
|
4963
|
+
"endOfLine": {
|
|
4964
|
+
"type": "string",
|
|
4965
|
+
"enum": [
|
|
4966
|
+
"lf",
|
|
4967
|
+
"crlf",
|
|
4968
|
+
"cr"
|
|
4969
|
+
],
|
|
4970
|
+
"description": "Which end of line characters to apply.\n\nNOTE: `\"auto\"` is not supported.\n\n- Languages: All\n- Default: `\"lf\"`\n- Overrides `.editorconfig.end_of_line`"
|
|
4971
|
+
},
|
|
4972
|
+
"experimentalOperatorPosition": {
|
|
4973
|
+
"type": "string",
|
|
4974
|
+
"enum": [
|
|
4975
|
+
"start",
|
|
4976
|
+
"end"
|
|
4977
|
+
],
|
|
4978
|
+
"description": "When expressions wrap lines, print operators at the start of new lines (`\"start\"`) or at the end of previous lines (`\"end\"`).\n\n- Languages: JS, JSX, TS, TSX\n- Default: `\"end\"`"
|
|
4979
|
+
},
|
|
4980
|
+
"htmlWhitespaceSensitivity": {
|
|
4981
|
+
"type": "string",
|
|
4982
|
+
"enum": [
|
|
4983
|
+
"css",
|
|
4984
|
+
"strict",
|
|
4985
|
+
"ignore"
|
|
4986
|
+
],
|
|
4987
|
+
"description": "Specify the global whitespace sensitivity.\n\n- Languages: HTML, Angular, Vue, Handlebars, Svelte\n- Default: `\"css\"`"
|
|
4988
|
+
},
|
|
4989
|
+
"insertFinalNewline": {
|
|
4990
|
+
"type": "boolean",
|
|
4991
|
+
"description": "Whether to insert a final newline at the end of the file.\n\n- Languages: All\n- Default: `true`\n- Overrides `.editorconfig.insert_final_newline`"
|
|
4992
|
+
},
|
|
4993
|
+
"jsdoc": {
|
|
4994
|
+
"anyOf": [
|
|
4995
|
+
{
|
|
4996
|
+
"type": "boolean"
|
|
4997
|
+
},
|
|
4998
|
+
{
|
|
4999
|
+
"type": "object",
|
|
5000
|
+
"properties": {
|
|
5001
|
+
"addDefaultToDescription": {
|
|
5002
|
+
"type": "boolean",
|
|
5003
|
+
"description": "Append default values to `@param` descriptions (e.g. \"Default is `value`\").\n\n- Default: `true`"
|
|
5004
|
+
},
|
|
5005
|
+
"bracketSpacing": {
|
|
5006
|
+
"type": "boolean",
|
|
5007
|
+
"description": "Add spaces inside JSDoc type braces: `{string}` → `{ string }`.\n\n- Default: `false`"
|
|
5008
|
+
},
|
|
5009
|
+
"capitalizeDescriptions": {
|
|
5010
|
+
"type": "boolean",
|
|
5011
|
+
"description": "Capitalize the first letter of tag descriptions.\n\n- Default: `true`"
|
|
5012
|
+
},
|
|
5013
|
+
"commentLineStrategy": {
|
|
5014
|
+
"type": "string",
|
|
5015
|
+
"enum": [
|
|
5016
|
+
"singleLine",
|
|
5017
|
+
"multiline",
|
|
5018
|
+
"keep"
|
|
5019
|
+
],
|
|
5020
|
+
"description": "How to format comment blocks.\n\n- `\"singleLine\"`: Convert to single-line `/** content * /` when possible\n- `\"multiline\"`: Always use multi-line format\n- `\"keep\"`: Preserve original formatting\n\nBy default, comments are collapsed to a single line when possible.\n\n- Default: `\"singleLine\"`"
|
|
5021
|
+
},
|
|
5022
|
+
"descriptionTag": {
|
|
5023
|
+
"type": "boolean",
|
|
5024
|
+
"description": "Emit `@description` tag instead of inline description.\n\n- Default: `false`"
|
|
5025
|
+
},
|
|
5026
|
+
"descriptionWithDot": {
|
|
5027
|
+
"type": "boolean",
|
|
5028
|
+
"description": "Add a trailing dot to the end of descriptions.\n\n- Default: `false`"
|
|
5029
|
+
},
|
|
5030
|
+
"keepUnparsableExampleIndent": {
|
|
5031
|
+
"type": "boolean",
|
|
5032
|
+
"description": "Preserve indentation in unparsable `@example` code.\n\n- Default: `false`"
|
|
5033
|
+
},
|
|
5034
|
+
"lineWrappingStyle": {
|
|
5035
|
+
"type": "string",
|
|
5036
|
+
"enum": [
|
|
5037
|
+
"greedy",
|
|
5038
|
+
"balance"
|
|
5039
|
+
],
|
|
5040
|
+
"description": "Strategy for wrapping description lines at print width.\n\n- `\"greedy\"`: Always re-wrap text to fit within print width\n- `\"balance\"`: Preserve original line breaks if all lines fit within print width\n\nBy default, description lines are always re-wrapped.\n\n- Default: `\"greedy\"`"
|
|
5041
|
+
},
|
|
5042
|
+
"preferCodeFences": {
|
|
5043
|
+
"type": "boolean",
|
|
5044
|
+
"description": "Use fenced code blocks (```` ``` ````) instead of 4-space indentation for code without a language tag.\n\n- Default: `false`"
|
|
5045
|
+
},
|
|
5046
|
+
"separateReturnsFromParam": {
|
|
5047
|
+
"type": "boolean",
|
|
5048
|
+
"description": "Add a blank line between the last `@param` and `@returns`.\n\n- Default: `false`"
|
|
5049
|
+
},
|
|
5050
|
+
"separateTagGroups": {
|
|
5051
|
+
"type": "boolean",
|
|
5052
|
+
"description": "Add blank lines between different tag groups (e.g. between `@param` and `@returns`).\n\n- Default: `false`"
|
|
5053
|
+
}
|
|
5054
|
+
},
|
|
5055
|
+
"additionalProperties": {}
|
|
5056
|
+
}
|
|
5057
|
+
],
|
|
5058
|
+
"description": "Enable JSDoc comment formatting.\n\nNormalizes JSDoc comments: tag aliases are canonicalized, descriptions are capitalized, long lines are wrapped, and short comments are collapsed to single-line.\n\nPass `true` or an object to enable, `false` to disable.\n\n- Languages: JS, JSX, TS, TSX\n- Default: Disabled"
|
|
5059
|
+
},
|
|
5060
|
+
"jsxSingleQuote": {
|
|
5061
|
+
"type": "boolean",
|
|
5062
|
+
"description": "Use single quotes instead of double quotes in JSX.\n\n- Languages: JSX, TSX\n- Default: `false`"
|
|
5063
|
+
},
|
|
5064
|
+
"objectWrap": {
|
|
5065
|
+
"type": "string",
|
|
5066
|
+
"enum": [
|
|
5067
|
+
"preserve",
|
|
5068
|
+
"collapse"
|
|
5069
|
+
],
|
|
5070
|
+
"description": "How to wrap object literals when they could fit on one line or span multiple lines.\n\nBy default, formats objects as multi-line if there is a newline prior to the first property. Authors can use this heuristic to contextually improve readability, though it has some downsides.\n\n- Languages: JS, JSX, TS, TSX, JSON, JSONC, JSON5\n- Default: `\"preserve\"`"
|
|
5071
|
+
},
|
|
5072
|
+
"printWidth": {
|
|
5073
|
+
"type": "number",
|
|
5074
|
+
"description": "Specify the line length that the printer will wrap on.\n\nIf you don't want line wrapping when formatting Markdown, you can set the `proseWrap` option to disable it.\n\n- Languages: All\n- Default: `100`\n- Overrides `.editorconfig.max_line_length`"
|
|
5075
|
+
},
|
|
5076
|
+
"proseWrap": {
|
|
5077
|
+
"type": "string",
|
|
5078
|
+
"enum": [
|
|
5079
|
+
"always",
|
|
5080
|
+
"never",
|
|
5081
|
+
"preserve"
|
|
5082
|
+
],
|
|
5083
|
+
"description": "How to wrap prose.\n\n- `\"always\"`: Wrap prose to the print width\n- `\"never\"`: Put each prose block on a single line, relying on editor/viewer soft wrapping\n- `\"preserve\"`: Keep wrapping as-is\n\nBy default, wrapping is preserved, since some services use a linebreak-sensitive renderer (e.g. GitHub comments, BitBucket).\n\n- Languages: Markdown, MDX, YAML\n- Default: `\"preserve\"`"
|
|
5084
|
+
},
|
|
5085
|
+
"quoteProps": {
|
|
5086
|
+
"type": "string",
|
|
5087
|
+
"enum": [
|
|
5088
|
+
"as-needed",
|
|
5089
|
+
"consistent",
|
|
5090
|
+
"preserve"
|
|
5091
|
+
],
|
|
5092
|
+
"description": "Change when properties in objects are quoted.\n\n- Languages: JS, JSX, TS, TSX\n- Default: `\"as-needed\"`"
|
|
5093
|
+
},
|
|
5094
|
+
"semi": {
|
|
5095
|
+
"type": "boolean",
|
|
5096
|
+
"description": "Print semicolons at the ends of statements.\n\n- Languages: JS, JSX, TS, TSX\n- Default: `true`"
|
|
5097
|
+
},
|
|
5098
|
+
"singleAttributePerLine": {
|
|
5099
|
+
"type": "boolean",
|
|
5100
|
+
"description": "Enforce single attribute per line.\n\n- Languages: JSX, TSX, HTML, Angular, Vue, MJML, Svelte, Astro\n- Default: `false`"
|
|
5101
|
+
},
|
|
5102
|
+
"singleQuote": {
|
|
5103
|
+
"type": "boolean",
|
|
5104
|
+
"description": "Use single quotes instead of double quotes.\n\nFor JSX, you can set the `jsxSingleQuote` option.\n\n- Languages: JS, JSX, TS, TSX, CSS, Less, SCSS, Markdown, MDX, YAML, Handlebars, Svelte, Astro\n- Default: `false`\n- Overrides `.editorconfig.quote_type`"
|
|
5105
|
+
},
|
|
5106
|
+
"sortImports": {
|
|
5107
|
+
"anyOf": [
|
|
5108
|
+
{
|
|
5109
|
+
"type": "boolean"
|
|
5110
|
+
},
|
|
5111
|
+
{
|
|
5112
|
+
"type": "object",
|
|
5113
|
+
"properties": {
|
|
5114
|
+
"customGroups": {
|
|
5115
|
+
"type": "array",
|
|
5116
|
+
"items": {
|
|
5117
|
+
"type": "object",
|
|
5118
|
+
"properties": {
|
|
5119
|
+
"elementNamePattern": {
|
|
5120
|
+
"type": "array",
|
|
5121
|
+
"items": {
|
|
5122
|
+
"type": "string"
|
|
5123
|
+
},
|
|
5124
|
+
"description": "List of glob patterns to match import sources for this group."
|
|
5125
|
+
},
|
|
5126
|
+
"groupName": {
|
|
5127
|
+
"type": "string",
|
|
5128
|
+
"description": "Name of the custom group, used in the `groups` option."
|
|
5129
|
+
},
|
|
5130
|
+
"modifiers": {
|
|
5131
|
+
"type": "array",
|
|
5132
|
+
"items": {
|
|
5133
|
+
"type": "string",
|
|
5134
|
+
"enum": [
|
|
5135
|
+
"side_effect",
|
|
5136
|
+
"type",
|
|
5137
|
+
"value",
|
|
5138
|
+
"default",
|
|
5139
|
+
"wildcard",
|
|
5140
|
+
"named"
|
|
5141
|
+
],
|
|
5142
|
+
"description": "Modifier matching the import characteristics in `customGroups` (see `sortImports.groups` for semantics)."
|
|
5143
|
+
},
|
|
5144
|
+
"description": "Modifiers to match the import characteristics. All specified modifiers must match."
|
|
5145
|
+
},
|
|
5146
|
+
"selector": {
|
|
5147
|
+
"type": "string",
|
|
5148
|
+
"enum": [
|
|
5149
|
+
"type",
|
|
5150
|
+
"side_effect_style",
|
|
5151
|
+
"side_effect",
|
|
5152
|
+
"style",
|
|
5153
|
+
"index",
|
|
5154
|
+
"sibling",
|
|
5155
|
+
"parent",
|
|
5156
|
+
"subpath",
|
|
5157
|
+
"internal",
|
|
5158
|
+
"builtin",
|
|
5159
|
+
"external",
|
|
5160
|
+
"import"
|
|
5161
|
+
],
|
|
5162
|
+
"description": "Selector to match the import kind."
|
|
5163
|
+
}
|
|
5164
|
+
},
|
|
5165
|
+
"additionalProperties": {}
|
|
5166
|
+
},
|
|
5167
|
+
"description": "Define your own groups for matching very specific imports.\n\nThe first matching definition is used, and custom groups take precedence over predefined groups. To give a predefined group precedence, define an equivalent custom group and put it first.\n\nWhen multiple conditions (`elementNamePattern`, `selector`, `modifiers`) are specified, all of them must match.\n\nNOTE: Predefined group names (e.g. `side_effect`, `external`) and `unknown` are reserved and cannot be used as `groupName`.\n\n- Default: `[]`"
|
|
5168
|
+
},
|
|
5169
|
+
"groups": {
|
|
5170
|
+
"type": "array",
|
|
5171
|
+
"items": {
|
|
5172
|
+
"anyOf": [
|
|
5173
|
+
{
|
|
5174
|
+
"type": "object",
|
|
5175
|
+
"properties": {
|
|
5176
|
+
"newlinesBetween": {
|
|
5177
|
+
"type": "boolean"
|
|
5178
|
+
}
|
|
5179
|
+
},
|
|
5180
|
+
"required": [
|
|
5181
|
+
"newlinesBetween"
|
|
5182
|
+
],
|
|
5183
|
+
"additionalProperties": {},
|
|
5184
|
+
"description": "A marker object for overriding `newlinesBetween` at a specific group boundary."
|
|
5185
|
+
},
|
|
5186
|
+
{
|
|
5187
|
+
"type": "string"
|
|
5188
|
+
},
|
|
5189
|
+
{
|
|
5190
|
+
"type": "array",
|
|
5191
|
+
"items": {
|
|
5192
|
+
"type": "string"
|
|
5193
|
+
}
|
|
5194
|
+
}
|
|
5195
|
+
]
|
|
5196
|
+
},
|
|
5197
|
+
"description": "List of import groups for sorting.\n\nEach import is assigned to a single group (or `unknown` if none matches), and groups are ordered as listed. Within a group, imports are sorted according to `order`, `ignoreCase`, etc.\n\nA predefined group name is a single selector with optional modifiers, joined by `-` (e.g. `type-external`). Modifiers can be in any order, but the selector must come last.\n\nSelectors, from most to least important:\n- `type`: TypeScript type imports.\n- `side_effect_style`: Side effect style imports.\n- `side_effect`: Side effect imports.\n- `style`: Style imports.\n- `index`: Main file from the current directory.\n- `sibling`: Modules from the same directory.\n- `parent`: Modules from the parent directory.\n- `subpath`: Node.js subpath imports.\n- `internal`: Your internal modules.\n- `builtin`: Node.js Built-in Modules.\n- `external`: External modules installed in the project.\n- `import`: Any import.\n\nModifiers, from most to least important:\n- `side_effect`: Side effect imports.\n- `type`: TypeScript type imports.\n- `value`: Value imports.\n- `default`: Imports containing the default specifier.\n- `wildcard`: Imports containing the wildcard (`* as`) specifier.\n- `named`: Imports containing at least one named specifier.\n\nWrap groups in an array to sort them together as a single group (order within the array does not matter).\n\nTo override `newlinesBetween` at a specific group boundary, put a `{ \"newlinesBetween\": boolean }` marker object at that position.\n\n- Default: See below ```json [ \"builtin\", \"external\", [\"internal\", \"subpath\"], [\"parent\", \"sibling\", \"index\"], \"style\", \"unknown\" ] ```"
|
|
5198
|
+
},
|
|
5199
|
+
"ignoreCase": {
|
|
5200
|
+
"type": "boolean",
|
|
5201
|
+
"description": "Ignore case when sorting.\n\n- Default: `true`"
|
|
5202
|
+
},
|
|
5203
|
+
"internalPattern": {
|
|
5204
|
+
"type": "array",
|
|
5205
|
+
"items": {
|
|
5206
|
+
"type": "string"
|
|
5207
|
+
},
|
|
5208
|
+
"description": "Prefixes for identifying internal imports.\n\n- Default: `[\"~/\", \"@/\", \"#\"]`"
|
|
5209
|
+
},
|
|
5210
|
+
"newlinesBetween": {
|
|
5211
|
+
"type": "boolean",
|
|
5212
|
+
"description": "Add newlines between groups.\n\n- Default: `true`"
|
|
5213
|
+
},
|
|
5214
|
+
"order": {
|
|
5215
|
+
"type": "string",
|
|
5216
|
+
"enum": [
|
|
5217
|
+
"asc",
|
|
5218
|
+
"desc"
|
|
5219
|
+
],
|
|
5220
|
+
"description": "Sort in ascending or descending order.\n\n- Default: `\"asc\"`"
|
|
5221
|
+
},
|
|
5222
|
+
"partitionByComment": {
|
|
5223
|
+
"type": "boolean",
|
|
5224
|
+
"description": "Use comments to separate imports into logical groups.\n\nWhen `true`, all comments are treated as delimiters.\n\n```js import { b1, b2 } from 'b' // PARTITION import { a } from 'a' import { c } from 'c' ```\n\n- Default: `false`"
|
|
5225
|
+
},
|
|
5226
|
+
"partitionByNewline": {
|
|
5227
|
+
"type": "boolean",
|
|
5228
|
+
"description": "Use empty lines to separate imports into logical groups.\n\nWhen `true`, imports are not sorted across an empty line.\n\n```js import { b1, b2 } from 'b'\n\nimport { a } from 'a' import { c } from 'c' ```\n\n- Default: `false`"
|
|
5229
|
+
},
|
|
5230
|
+
"sortSideEffects": {
|
|
5231
|
+
"type": "boolean",
|
|
5232
|
+
"description": "Sort side effect imports.\n\nDisabled by default for safety reasons.\n\n- Default: `false`"
|
|
5233
|
+
}
|
|
5234
|
+
},
|
|
5235
|
+
"additionalProperties": {}
|
|
5236
|
+
}
|
|
5237
|
+
],
|
|
5238
|
+
"description": "Sort import statements.\n\nUses a similar algorithm to [eslint-plugin-perfectionist/sort-imports](https://perfectionist.dev/rules/sort-imports).\n\nPass `true` or an object to enable, `false` to disable.\n\n- Languages: JS, JSX, TS, TSX\n- Default: Disabled"
|
|
5239
|
+
},
|
|
5240
|
+
"sortPackageJson": {
|
|
5241
|
+
"anyOf": [
|
|
5242
|
+
{
|
|
5243
|
+
"type": "boolean"
|
|
5244
|
+
},
|
|
5245
|
+
{
|
|
5246
|
+
"type": "object",
|
|
5247
|
+
"properties": {
|
|
5248
|
+
"sortScripts": {
|
|
5249
|
+
"type": "boolean",
|
|
5250
|
+
"description": "Sort the `scripts` field alphabetically.\n\n- Default: `false`"
|
|
5251
|
+
}
|
|
5252
|
+
},
|
|
5253
|
+
"additionalProperties": {}
|
|
5254
|
+
}
|
|
5255
|
+
],
|
|
5256
|
+
"description": "Sort `package.json` keys.\n\nThe order is NOT compatible with [prettier-plugin-packagejson](https://github.com/matzkoh/prettier-plugin-packagejson), but we believe it is clearer and easier to navigate.\n\n- Languages: JSON (`package.json` only)\n- Default: `true`"
|
|
5257
|
+
},
|
|
5258
|
+
"sortTailwindcss": {
|
|
5259
|
+
"anyOf": [
|
|
5260
|
+
{
|
|
5261
|
+
"type": "boolean"
|
|
5262
|
+
},
|
|
5263
|
+
{
|
|
5264
|
+
"type": "object",
|
|
5265
|
+
"properties": {
|
|
5266
|
+
"attributes": {
|
|
5267
|
+
"type": "array",
|
|
5268
|
+
"items": {
|
|
5269
|
+
"type": "string"
|
|
5270
|
+
},
|
|
5271
|
+
"description": "List of additional attributes to sort beyond `class` and `className` (exact match).\n\nNOTE: Regex patterns are not yet supported.\n\n- Default: `[]`\n- Example: `[\"myClassProp\", \":class\"]`"
|
|
5272
|
+
},
|
|
5273
|
+
"config": {
|
|
5274
|
+
"type": "string",
|
|
5275
|
+
"description": "Path to your Tailwind CSS configuration file (v3).\n\nNOTE: Paths are resolved relative to the Oxfmt configuration file.\n\n- Default: Automatically find `\"tailwind.config.js\"`"
|
|
5276
|
+
},
|
|
5277
|
+
"functions": {
|
|
5278
|
+
"type": "array",
|
|
5279
|
+
"items": {
|
|
5280
|
+
"type": "string"
|
|
5281
|
+
},
|
|
5282
|
+
"description": "List of custom function names whose arguments should be sorted (exact match).\n\nNOTE: Regex patterns are not yet supported.\n\n- Default: `[]`\n- Example: `[\"clsx\", \"cn\", \"cva\", \"tw\"]`"
|
|
5283
|
+
},
|
|
5284
|
+
"preserveDuplicates": {
|
|
5285
|
+
"type": "boolean",
|
|
5286
|
+
"description": "Preserve duplicate classes.\n\n- Default: `false`"
|
|
5287
|
+
},
|
|
5288
|
+
"preserveWhitespace": {
|
|
5289
|
+
"type": "boolean",
|
|
5290
|
+
"description": "Preserve whitespace around classes.\n\n- Default: `false`"
|
|
5291
|
+
},
|
|
5292
|
+
"stylesheet": {
|
|
5293
|
+
"type": "string",
|
|
5294
|
+
"description": "Path to your Tailwind CSS stylesheet (v4).\n\nNOTE: Paths are resolved relative to the Oxfmt configuration file.\n\n- Default: Installed Tailwind CSS's `theme.css`"
|
|
5295
|
+
}
|
|
5296
|
+
},
|
|
5297
|
+
"additionalProperties": {}
|
|
5298
|
+
}
|
|
5299
|
+
],
|
|
5300
|
+
"description": "Sort Tailwind CSS classes.\n\nUses the same algorithm as [prettier-plugin-tailwindcss](https://github.com/tailwindlabs/prettier-plugin-tailwindcss). Option names omit the `tailwind` prefix used in the original plugin (e.g. `config` instead of `tailwindConfig`).\n\nPass `true` or an object to enable, `false` to disable.\n\n- Languages: JS, JSX, TS, TSX, HTML, Vue, Angular, Handlebars, CSS, SCSS, Less, Svelte, Astro\n- Default: Disabled"
|
|
5301
|
+
},
|
|
5302
|
+
"svelte": {
|
|
5303
|
+
"anyOf": [
|
|
5304
|
+
{
|
|
5305
|
+
"type": "boolean"
|
|
5306
|
+
},
|
|
5307
|
+
{
|
|
5308
|
+
"type": "object",
|
|
5309
|
+
"properties": {
|
|
5310
|
+
"allowShorthand": {
|
|
5311
|
+
"type": "boolean",
|
|
5312
|
+
"description": "Whether to allow attribute shorthand if attribute name and expression are the same.\n\n- Default: `true`"
|
|
5313
|
+
},
|
|
5314
|
+
"indentScriptAndStyle": {
|
|
5315
|
+
"type": "boolean",
|
|
5316
|
+
"description": "Whether to indent code inside `<script>` and `<style>` tags.\n\n- Default: `true`"
|
|
5317
|
+
},
|
|
5318
|
+
"sortOrder": {
|
|
5319
|
+
"type": "string",
|
|
5320
|
+
"description": "The order in which Svelte component sections are printed. Join `options`, `scripts`, `markup`, `styles` with `-` in the desired order, or use `none` to keep the original order.\n\n- Default: `\"options-scripts-markup-styles\"`"
|
|
5321
|
+
}
|
|
5322
|
+
},
|
|
5323
|
+
"additionalProperties": {}
|
|
5324
|
+
}
|
|
5325
|
+
],
|
|
5326
|
+
"description": "Options for `prettier-plugin-svelte`.\n\nPass `true` or an object to enable `.svelte` file formatting, `false` to disable (handy in overrides). Setting `true` resets to defaults, dropping options inherited from a parent scope.\n\nNOTE: `prettier-plugin-svelte` requires the `svelte` package (`svelte/compiler`) at runtime. Oxfmt does NOT bundle it, so install it in your project, otherwise formatting fails.\n\n- Languages: Svelte\n- Default: Disabled"
|
|
5327
|
+
},
|
|
5328
|
+
"tabWidth": {
|
|
5329
|
+
"type": "number",
|
|
5330
|
+
"description": "Specify the number of spaces per indentation-level.\n\n- Languages: All\n- Default: `2`\n- Overrides `.editorconfig.indent_size` (falls back to `.editorconfig.tab_width`)"
|
|
5331
|
+
},
|
|
5332
|
+
"trailingComma": {
|
|
5333
|
+
"type": "string",
|
|
5334
|
+
"enum": [
|
|
5335
|
+
"all",
|
|
5336
|
+
"es5",
|
|
5337
|
+
"none"
|
|
5338
|
+
],
|
|
5339
|
+
"description": "Print trailing commas wherever possible in multi-line comma-separated syntactic structures.\n\nA single-line array, for example, never gets trailing commas.\n\n- Languages: JS, JSX, TS, TSX, JSONC, JSON5, TOML, CSS, Less, SCSS, YAML\n- Default: `\"all\"`"
|
|
5340
|
+
},
|
|
5341
|
+
"useTabs": {
|
|
5342
|
+
"type": "boolean",
|
|
5343
|
+
"description": "Indent lines with tabs instead of spaces.\n\n- Languages: All\n- Default: `false`\n- Overrides `.editorconfig.indent_style`"
|
|
5344
|
+
},
|
|
5345
|
+
"vueIndentScriptAndStyle": {
|
|
5346
|
+
"type": "boolean",
|
|
5347
|
+
"description": "Whether or not to indent the code inside `<script>` and `<style>` tags in Vue files.\n\n- Languages: Vue\n- Default: `false`"
|
|
5348
|
+
}
|
|
5349
|
+
},
|
|
5350
|
+
"additionalProperties": {},
|
|
5351
|
+
"description": "Format options to apply for matched files. Accepts the same options as the top-level format options."
|
|
5352
|
+
}
|
|
5353
|
+
},
|
|
5354
|
+
"required": [
|
|
5355
|
+
"files"
|
|
5356
|
+
],
|
|
5357
|
+
"additionalProperties": {},
|
|
5358
|
+
"description": "A per-glob options override, in oxfmt's own shape."
|
|
4020
5359
|
},
|
|
4021
5360
|
"LintAdapterId": {
|
|
4022
5361
|
"type": "string",
|