starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-09-25 08:24:54 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

[PR #2422] Add Warnings during settings load #24928

New Issue
Open
opened 2026-01-31 09:06:09 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:06:09 +00:00
Owner
Copy Link

Original Pull Request: https://github.com/microsoft/terminal/pull/2422

State: closed
Merged: Yes

Summary of the Pull Request

Adds support for two things: more discrete settings errors that we can detect on load, and discrete warnings we can detect on load.

Errors are things that we might find that cause the settings to be totally invalid. At the moment, there are two such cases:

  • Failing to parse the JSON at all
  • Failing to find any profiles. We need some profiles to be able to run.

When we find such an error case, we'll display more specific text in the popup:
image

Warnings are things that aren't necessarily fatal, but they certainly aren't good. I focused on two cases:

  • Failing to find the default profile in the list of profiles
  • Finding duplicate profiles in the list of profiles.

When we find a warning, we'll try to mitigate it, and keep running. We won't save the settings on load, because we'll have likely changed them internally. We'll also display all the warnings to the user, so they can see what they did wrong.
image

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

  • I added tests.
  • I tried loading a totally empty profiles.json
  • I messed with the settingonce the app was open to see if this would work during reload
  • I tried removing the profiles entirely
  • I tried having 2 warnings simultaneously
  • I tried having invalid json
**Original Pull Request:** https://github.com/microsoft/terminal/pull/2422 **State:** closed **Merged:** Yes --- <!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? --> ## Summary of the Pull Request Adds support for two things: more discrete settings errors that we can detect on load, and discrete warnings we can detect on load. **Errors** are things that we might find that cause the settings to be totally invalid. At the moment, there are two such cases: * Failing to parse the JSON at all * Failing to find _any_ profiles. We need some profiles to be able to run. When we find such an error case, we'll display more specific text in the popup: ![image](https://user-images.githubusercontent.com/18356694/62965553-f603d300-bdca-11e9-84d2-8c653b65e68a.png) **Warnings** are things that aren't necessarily fatal, but they certainly aren't good. I focused on two cases: * Failing to find the default profile in the list of profiles * Finding duplicate profiles in the list of profiles. When we find a warning, we'll try to mitigate it, and keep running. We _won't_ save the settings on load, because we'll have likely changed them internally. We'll also display _all_ the warnings to the user, so they can see what they did wrong. ![image](https://user-images.githubusercontent.com/18356694/62965545-f1d7b580-bdca-11e9-8645-2cf17a416a82.png) <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist * [x] Closes #1348 * [x] Closes #990 * [x] Closes the issue where the json being empty crashes the app * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [x] (☞ﾟヮﾟ)☞**Tests added/passed** ☜(ﾟヮﾟ☜) * [N/A] Requires documentation to be updated * [x] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx <!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here --> ## Detailed Description of the Pull Request / Additional comments <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed * **_I added tests_**. * I tried loading a totally empty `profiles.json` * I messed with the settingonce the app was open to see if this would work during reload * I tried removing the `profiles` entirely * I tried having 2 warnings simultaneously * I tried having invalid json
claunia added the pull-request label 2026-01-31 09:06:09 +00:00
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 pull-request
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#24928
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?