Skip to content

Commit 8a8d02f

Browse files
ralishcarlos-zamora
authored andcommitted
Minor fixes to the settings schema (#19387)
## Summary of the Pull Request Fixes a couple of minor issues in the settings schema which can result in erroneous settings validation failures. ## References and Relevant Issues None ## Detailed Description of the Pull Request / Additional comments - `answerbackMessage` Permit `null` type (corresponds to the default value). - `compatibility.input.forceVT` Add missing setting (previously was `experimental.input.forceVT`). - `rendering.graphicsAPI` Add missing `automatic` enumeration value. - Mark several settings as deprecated using the same format and direct the user to the updated settings to use. ## Validation Steps Performed Tested updated schema against configuration with above settings present. ## PR Checklist - [X] Schema updated (if necessary) --------- Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com> (cherry picked from commit fc2d107) Service-Card-Id: PVTI_lADOAF3p4s4BBcTlzgirMyU Service-Version: 1.24
1 parent 1ba28b2 commit 8a8d02f

1 file changed

Lines changed: 52 additions & 34 deletions

File tree

doc/cascadia/profiles.schema.json

Lines changed: 52 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2466,6 +2466,7 @@
24662466
"description": "Direct3D 11 provides a more performant and feature-rich experience, whereas Direct2D is more stable. The default option \"Automatic\" will pick the API that best fits your graphics hardware. If you experience significant issues, consider using Direct2D.",
24672467
"type": "string",
24682468
"enum": [
2469+
"automatic",
24692470
"direct2d",
24702471
"direct3d11"
24712472
]
@@ -2479,8 +2480,9 @@
24792480
"type": "boolean"
24802481
},
24812482
"experimental.input.forceVT": {
2482-
"description": "Force the terminal to use the legacy input encoding. Certain keys in some applications may stop working when enabling this setting.",
2483-
"type": "boolean"
2483+
"type": "boolean",
2484+
"description": "[Deprecated] Replaced with the \"compatibility.input.forceVT\" profile setting.",
2485+
"deprecated": true
24842486
},
24852487
"experimental.useBackgroundImageForWindow": {
24862488
"default": false,
@@ -2527,14 +2529,14 @@
25272529
"type": "string"
25282530
},
25292531
"rowsToScroll": {
2530-
"default": "system",
2531-
"description": "This parameter once allowed you to override the systemwide \"choose how many lines to scroll at one time\" setting. It no longer does so. However, you can customize the number of lines to scroll in \"scrollUp\" and \"scrollDown\" bindings.",
2532-
"maximum": 999,
2533-
"minimum": 0,
25342532
"type": [
25352533
"integer",
25362534
"string"
25372535
],
2536+
"description": "[Deprecated] This setting no longer has any effect. However, you can customize the number of lines to scroll using the \"rowsToScroll\" argument on the \"scrollUp\" and \"scrollDown\" actions.",
2537+
"default": "system",
2538+
"minimum": 0,
2539+
"maximum": 999,
25382540
"deprecated": true
25392541
},
25402542
"minimizeToNotificationArea": {
@@ -2580,9 +2582,12 @@
25802582
"$ref": "#/$defs/NewTabMenu"
25812583
},
25822584
"language": {
2583-
"default": "",
2585+
"type": [
2586+
"string",
2587+
"null"
2588+
],
25842589
"description": "Sets an override for the app's preferred language, expressed as a BCP-47 language tag like en-US.",
2585-
"type": "string"
2590+
"default": null
25862591
},
25872592
"theme": {
25882593
"default": "dark",
@@ -2646,19 +2651,19 @@
26462651
"type": "boolean"
26472652
},
26482653
"useTabSwitcher": {
2654+
"description": "[Deprecated] Replaced with the \"tabSwitcherMode\" setting.",
26492655
"default": true,
2650-
"description": "Deprecated. Please use \"tabSwitcherMode\" instead.",
26512656
"oneOf": [
26522657
{
26532658
"type": "boolean"
26542659
},
26552660
{
2661+
"type": "string",
26562662
"enum": [
26572663
"mru",
26582664
"inOrder",
26592665
"disabled"
2660-
],
2661-
"type": "string"
2666+
]
26622667
}
26632668
],
26642669
"deprecated": true
@@ -2715,12 +2720,12 @@
27152720
"type": "object",
27162721
"properties": {
27172722
"acrylicOpacity": {
2723+
"type": "number",
2724+
"description": "[Deprecated] Replaced with the \"opacity\" setting.",
27182725
"default": 0.5,
2719-
"description": "[deprecated] Please use `opacity` instead.",
2720-
"deprecated": true,
2721-
"maximum": 1,
27222726
"minimum": 0,
2723-
"type": "number"
2727+
"maximum": 1,
2728+
"deprecated": true
27242729
},
27252730
"antialiasingMode": {
27262731
"default": "grayscale",
@@ -2746,6 +2751,11 @@
27462751
"description": "When set to true, when opening a new tab or pane it will get reloaded environment variables.",
27472752
"type": "boolean"
27482753
},
2754+
"compatibility.input.forceVT": {
2755+
"default": false,
2756+
"description": "Force the terminal to use the legacy input encoding. Certain keys in some applications may stop working when enabling this setting.",
2757+
"type": "boolean"
2758+
},
27492759
"compatibility.allowDECRQCRA": {
27502760
"default": false,
27512761
"description": "When set to true, the terminal will support the DECRQCRA (Request Checksum of Rectangular Area) escape sequence.",
@@ -2917,24 +2927,29 @@
29172927
"type": "boolean"
29182928
},
29192929
"experimental.autoMarkPrompts": {
2920-
"deprecated": true,
2921-
"description": "This has been replaced by autoMarkPrompts in 1.21",
2922-
"type": "boolean"
2930+
"type": "boolean",
2931+
"description": "[Deprecated] Replaced with the \"autoMarkPrompts\" setting.",
2932+
"deprecated": true
29232933
},
29242934
"experimental.retroTerminalEffect": {
29252935
"description": "When set to true, enable retro terminal effects. This is an experimental feature, and its continued existence is not guaranteed.",
29262936
"type": "boolean"
29272937
},
29282938
"experimental.showMarksOnScrollbar": {
2929-
"deprecated": true,
2930-
"description": "This has been replaced by showMarksOnScrollbar in 1.21",
2931-
"type": "boolean"
2939+
"type": "boolean",
2940+
"description": "[Deprecated] Replaced with the \"showMarksOnScrollbar\" setting.",
2941+
"deprecated": true
29322942
},
29332943
"showMarksOnScrollbar": {
29342944
"default": false,
29352945
"description": "When set to true, marks added to the buffer via the addMark action will appear on the scrollbar.",
29362946
"type": "boolean"
29372947
},
2948+
"experimental.rainbowSuggestions": {
2949+
"type": "boolean",
2950+
"description": "Enables displaying command suggestions in the terminal in RGB (all the colors of the rainbow!).",
2951+
"default": false
2952+
},
29382953
"experimental.rightClickContextMenu": {
29392954
"default": false,
29402955
"description": "When true, right-click shows a context menu; otherwise, it pastes from the clipboard or copies selection.",
@@ -2950,23 +2965,29 @@
29502965
"type": "string"
29512966
},
29522967
"fontFace": {
2953-
"default": "Cascadia Mono",
2954-
"description": "[deprecated] Define 'face' within the 'font' object instead.",
29552968
"type": "string",
2969+
"description": "[Deprecated] Replaced with the \"face\" setting within the \"font\" object.",
2970+
"default": "Cascadia Mono",
29562971
"deprecated": true
29572972
},
29582973
"fontSize": {
2974+
"type": "number",
2975+
"description": "[Deprecated] Replaced with the \"size\" setting within the \"font\" object.",
29592976
"default": 12,
2960-
"description": "[deprecated] Define 'size' within the 'font' object instead.",
29612977
"minimum": 1,
2962-
"type": "number",
29632978
"deprecated": true
29642979
},
29652980
"fontWeight": {
2981+
"description": "[Deprecated] Replaced with the \"weight\" setting within the \"font\" object.",
29662982
"default": "normal",
2967-
"description": "[deprecated] Define 'weight' within the 'font' object instead.",
29682983
"oneOf": [
29692984
{
2985+
"type": "integer",
2986+
"minimum": 100,
2987+
"maximum": 990
2988+
},
2989+
{
2990+
"type": "string",
29702991
"enum": [
29712992
"thin",
29722993
"extra-light",
@@ -2979,13 +3000,7 @@
29793000
"extra-bold",
29803001
"black",
29813002
"extra-black"
2982-
],
2983-
"type": "string"
2984-
},
2985-
{
2986-
"maximum": 990,
2987-
"minimum": 100,
2988-
"type": "integer"
3003+
]
29893004
}
29903005
],
29913006
"deprecated": true
@@ -3096,7 +3111,10 @@
30963111
},
30973112
"answerbackMessage": {
30983113
"description": "The response that is sent when an ENQ control character is received.",
3099-
"type": "string"
3114+
"type": [
3115+
"string",
3116+
"null"
3117+
]
31003118
},
31013119
"source": {
31023120
"description": "Stores the name of the profile generator that originated this profile.",

0 commit comments

Comments
 (0)