starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Settings validation error for key bindings with more than one modifier #9495

New Issue
Closed
opened 2026-01-31 01:55:55 +00:00 by claunia · 8 comments
claunia commented 2026-01-31 01:55:55 +00:00
Owner
Copy Link

Originally created by @Forinil on GitHub (Jul 8, 2020).

Environment

Windows build number: 10.0.19041.0
Windows Terminal version (if applicable): 1.0.1811.0

Any other software?
multipass: 1.3.0+win (installed via Chocolatey)

Steps to reproduce

Install Windows Terminal.
Define keybindings in settings.json with more than one modifier (eg. alt+shift+d)
Install multipass
Run any multipass command in either cmd or powershell or pwsh either within or without Windows Terminal.

Expected behavior

Multipass command completes successfully. Nothing else happens.

Actual behavior

Multipass command seems to complete successfully. Windows Terminal settings parsing error shows up.

image

Additional info

I verified my settings.json file using this schema and this website: https://www.jsonschemavalidator.net and it complains that all keybindings that have more than one modifier are incorrect, because they o not match the regexp pattern defined in https://github.com/microsoft/terminal/blob/master/doc/cascadia/profiles.schema.json#/definitions/KeyChordSegment/pattern.

Keybindings work fine, despite validation errors.

My questions

Why does multipass verify Windows Terminal settings?
Why do keybindings with more than one modifier not satisfy the regular expression?

Originally created by @Forinil on GitHub (Jul 8, 2020). <!-- 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 I ACKNOWLEDGE THE FOLLOWING BEFORE PROCEEDING: 1. If I delete this entire template and go my own path, the core team may close my issue without further explanation or engagement. 2. If I list multiple bugs/concerns in this one issue, the core team may close my issue without further explanation or engagement. 3. If I write an issue that has many duplicates, the core team may close my issue without further explanation or engagement (and without necessarily spending time to find the exact duplicate ID number). 4. If I leave the title incomplete when filing the issue, the core team may close my issue without further explanation or engagement. 5. If I file something completely blank in the body, the core team may close my issue without further explanation or engagement. All good? Then proceed! --> <!-- This bug tracker is monitored by Windows Terminal development team and other technical folks. **Important: When reporting BSODs or security issues, DO NOT attach memory dumps, logs, or traces to Github issues**. Instead, send dumps/traces to secure@microsoft.com, referencing this GitHub issue. If this is an application crash, please also provide a Feedback Hub submission link so we can find your diagnostic data on the backend. Use the category "Apps > Windows Terminal (Preview)" and choose "Share My Feedback" after submission to get the link. Please use this form and describe your issue, concisely but precisely, with as much detail as possible. --> # Environment ```none Windows build number: 10.0.19041.0 Windows Terminal version (if applicable): 1.0.1811.0 Any other software? multipass: 1.3.0+win (installed via Chocolatey) ``` # Steps to reproduce Install Windows Terminal. Define keybindings in settings.json with more than one modifier (eg. `alt+shift+d`) Install multipass Run any multipass command in either cmd or powershell or pwsh either within or without Windows Terminal. # Expected behavior Multipass command completes successfully. Nothing else happens. # Actual behavior Multipass command seems to complete successfully. Windows Terminal settings parsing error shows up. ![image](https://user-images.githubusercontent.com/22886482/86897518-ca3abb80-c107-11ea-97e2-aa94cf69561a.png) # Additional info I verified my `settings.json` file using this [schema](https://raw.githubusercontent.com/microsoft/terminal/release-1.0/doc/cascadia/profiles.schema.json) and this website: [https://www.jsonschemavalidator.net](https://www.jsonschemavalidator.net) and it complains that all keybindings that have more than one modifier are incorrect, because they o not match the regexp pattern defined in `https://github.com/microsoft/terminal/blob/master/doc/cascadia/profiles.schema.json#/definitions/KeyChordSegment/pattern`. Keybindings work fine, despite validation errors. # My questions Why does multipass verify Windows Terminal settings? Why do keybindings with more than one modifier not satisfy the regular expression?
claunia added the Needs-TriageNeeds-Tag-Fix labels 2026-01-31 01:55:56 +00:00
claunia commented 2026-01-31 01:55:56 +00:00
Author
Owner
Copy Link

@Forinil commented on GitHub (Jul 8, 2020):

Multipass error is most likely related to functionality mentioned here: https://github.com/canonical/multipass/issues/1585.

After I disabled multipass and Windows Terminal integration the error message disappeared, but it still does not explain the underlying issue with working keybindings supposedly being invalid.

@Forinil commented on GitHub (Jul 8, 2020): Multipass error is most likely related to functionality mentioned here: [https://github.com/canonical/multipass/issues/1585](https://github.com/canonical/multipass/issues/1585). After I disabled multipass and Windows Terminal integration the error message disappeared, but it still does not explain the underlying issue with working keybindings supposedly being invalid.
claunia commented 2026-01-31 01:55:57 +00:00
Author
Owner
Copy Link

@Saviq commented on GitHub (Jul 8, 2020):

Hi @Forinil could you please post an excerpt of your settings.json that exposes this behaviour?

Why does multipass verify Windows Terminal settings?

The file needs to be a valid JSON, is all… so we can safely add the Multipass profile in there without breaking it. We're using the same parser that Windows Terminal uses (jsoncpp so we can be 100% compatible, but apparently we're still not?

@Saviq commented on GitHub (Jul 8, 2020): Hi @Forinil could you please post an excerpt of your `settings.json` that exposes this behaviour? > Why does multipass verify Windows Terminal settings? The file needs to be a valid JSON, is all… so we can safely add the Multipass profile in there without breaking it. We're using the same parser that Windows Terminal uses ([jsoncpp](http://open-source-parsers.github.io/jsoncpp-docs/doxygen/) so we can be 100% compatible, but apparently we're still not?
claunia commented 2026-01-31 01:55:57 +00:00
Author
Owner
Copy Link

@Forinil commented on GitHub (Jul 8, 2020):

@Saviq Here it is: settings.zip

AS fasr as I can tell it's valid JSON, it just fails schema validation for some reason, even though it conforms with the documentation.

@Forinil commented on GitHub (Jul 8, 2020): @Saviq Here it is: [settings.zip](https://github.com/microsoft/terminal/files/4889944/settings.zip) AS fasr as I can tell it's valid JSON, it just fails schema validation for some reason, even though it conforms with the documentation.
claunia commented 2026-01-31 01:55:57 +00:00
Author
Owner
Copy Link

@Saviq commented on GitHub (Jul 8, 2020):

Hi @Forinil, your file has a BOM at the beginning - you probably created it in Visual Studio. Just change the encoding to "UTF-8" when saving it and you'll be fine.

We'll fix Multipass to not choke on it, in the mean time.

I believe this issue can be closed here.

@Saviq commented on GitHub (Jul 8, 2020): Hi @Forinil, your file has a [BOM](https://en.wikipedia.org/wiki/Byte_order_mark) at the beginning - you probably [created it in Visual Studio](https://stackoverflow.com/questions/44098326/ef-bb-bf-at-the-beginning-of-json-files-created-in-visual-studio). Just change the encoding to "UTF-8" when saving it and you'll be fine. We'll fix Multipass to not choke on it, in the mean time. I believe this issue can be closed here.
claunia commented 2026-01-31 01:55:57 +00:00
Author
Owner
Copy Link

@Forinil commented on GitHub (Jul 8, 2020):

I think it was created by Windows Terminal, but I edited and validated using Liquid Studio 2019.

Editing it in Notepad++ and changing encoding from UTF-8 with BOM to UTF-8 did solve my issue with multipass, but it did not fix validation errors in Liquid Studio or in https://www.jsonschemavalidator.net/ and while they do not bother me, as long as WT interprets the settings correctly, I still think the issue should be addressed.

@Forinil commented on GitHub (Jul 8, 2020): I think it was created by Windows Terminal, but I edited and validated using Liquid Studio 2019. Editing it in Notepad++ and changing encoding from `UTF-8 with BOM` to `UTF-8` did solve my issue with multipass, but it did not fix validation errors in Liquid Studio or in [https://www.jsonschemavalidator.net/](https://www.jsonschemavalidator.net/) and while they do not bother me, as long as WT interprets the settings correctly, I still think the issue should be addressed.
claunia commented 2026-01-31 01:55:58 +00:00
Author
Owner
Copy Link

@Forinil commented on GitHub (Jul 8, 2020):

That being said - @Saviq thank you for your help and for a fast response.

@Forinil commented on GitHub (Jul 8, 2020): That being said - @Saviq thank you for your help and for a fast response.
claunia commented 2026-01-31 01:55:58 +00:00
Author
Owner
Copy Link

@Saviq commented on GitHub (Jul 8, 2020):

but it did not fix validation errors in Liquid Studio or in https://www.jsonschemavalidator.net/ and while they do not bother me, as long as WT interprets the settings correctly, I still think the issue should be addressed.

Oh? It validated fine online there for me. I didn't upload the file, but rather its contents, so that may still be the BOM acting up…

And you're welcome :)

@Saviq commented on GitHub (Jul 8, 2020): > but it did not fix validation errors in Liquid Studio or in [https://www.jsonschemavalidator.net/](https://www.jsonschemavalidator.net/) and while they do not bother me, as long as WT interprets the settings correctly, I still think the issue should be addressed. Oh? It [validated fine online there](https://www.jsonschemavalidator.net/s/wAwSBVCL) for me. I didn't upload the file, but rather its contents, so that may still be the BOM acting up… And you're welcome :)
claunia commented 2026-01-31 01:55:59 +00:00
Author
Owner
Copy Link

@Forinil commented on GitHub (Jul 8, 2020):

I uploaded the contents rather than the file as well. The difference was I copy-pasted the schema rather than using a reference, which seems to make all the difference.

In any way this does not seem to be a bug in Windows Terminal, so I'm closing this issue.

@Forinil commented on GitHub (Jul 8, 2020): I uploaded the contents rather than the file as well. The difference was I copy-pasted the schema rather than using a reference, which seems to make all the difference. In any way this does not seem to be a bug in Windows Terminal, so I'm closing this issue.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Needs-Tag-Fix Needs-Triage
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#9495
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?