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

Feature Request: Cascading settings (with a hardcoded default.json?) #1033

New Issue
Open
opened 2026-01-30 22:14:18 +00:00 by claunia · 0 comments
claunia commented 2026-01-30 22:14:18 +00:00
Owner
Copy Link

Originally created by @DHowett-MSFT on GitHub (May 13, 2019).

Originally assigned to: @zadjii-msft on GitHub.

Proposal

Include a default profiles.json in the package, allow the user to override it and merge their settings into it.

Questions

  • What if you want to delete a stock profile?
  • Optional features?
  • Turn off defaults? Perhaps {... "thing": null, }?

Child Work Items

  • #1880 Keep the original json blob around, and when we make edits to it, only append them or replace the existing values

Things that need to be done to accomplish Cascading Settings

Each <h3> here is a single PR into master, broken into either sub-PRs or work for me to do as a part of that PR

[x] Don't re-serialize settings on load (PR: #2475)

This should be done first and foremost. This is not really helping anyone. Old settings all migrate nicely, so whatever. Let's just pull it.

[_] Combine a defaults.json with a profiles.json (PR: #2515)

  • Add a defaults.json to the package
  • Create a function for layering a Json::Value on top of an existing object
  • Add tests for layering a profile json blob on top of a profile
  • Add functions to search a list of Profiles for a duplicate, and layer on that dupe or create a new Profile if no such dupe exists.
  • Ensure we can layer each of the following: (WITH TESTS)
    • layer profiles
    • layer color schemes
    • layer keybindings (for a matching key, the user action should override the default action) (NEEDS TESTS)
    • layer globals (NEEDS TESTS)
  • When loading settings, load defaults, then layer user settings on top of default profiles
  • Maintain user settings ordering, not defaults+user ordering
  • Add support for unbinding default keys
    • unbind with "unbound"
    • unbind with null
  • Add support for hiding profiles
  • Ensure that we can reset optional default settings with null (e.g. "iconPath": null)
  • Create the User Settings file if it doesn't exist
  • Stamp the "defaults.json" file into the code, so we can't possibly fail loading it
  • Add support for Alt clicking on "settings" to launch the defaults.json file
  • default construct profiles with scheme "Campbell" to make "scheme" and unnecessary setting in the partial diff

[_] Add Dynamic Profile Generators

  • Add Dynamic Profile Generator for WSL
    • Create Dynamic Profile Generator interface
    • Provide DPG's with GetNamespaceGuid and GetGuidForName functions from App somehow We're not doing this anymore. We'll create the GUID for the profile when it's returned, if it has a GUID of {0}
      • Add a test for generateing a guid based on namespace if GUID is {0}
    • Add layering for dynamic profiles based on guid and source, not just guid
  • Add Dynamic Profile Generator for Powershell Core
  • Add Dynamic Profile Generator for Azure Cloud Shell
  • Ensure that existing WSL, Powershell Core, and Azure profiles gracefully migrate to dynamic profiles
  • Add disabledProfileSources in user settings to hide dynamic profiles by namespace
  • On first launch of the terminal, if Powershell Core exists, make it the default profile
  • When adding this profiles, insert them into our JSON parse tree to save them
    • Only add the delta between the default profile and the dynamic profile's default state to the json. Don't include any user customizations (though at this point there won't be any)
  • Ensure adding a dynamic entry doesn't reformat settings
  • For profiles that were created from a dynamic profile source, they'll have both a guid and source guid that must both match. If a user profile with a source set does not find a matching profile at load time, the profile should be ignored.
  • profile diffs should probably not include "table". Probably don't need to include in the diff keys that are std::nullopt in both the base and derived.
  • Make sure to re-order profiles so they're { user profiles, dynamics not in user profiles, defaults not in user profiles }

[_] Smart Serializing

This would be needed for a Settings UI, so we don't necessarily need it for 1.0

  • Keep the original JSON parse tree around in memory
  • Only serialize things different from defaults
    • profiles
    • schemes
    • keybindings
Originally created by @DHowett-MSFT on GitHub (May 13, 2019). Originally assigned to: @zadjii-msft on GitHub. **Proposal** Include a default `profiles.json` in the package, allow the user to override it and merge their settings into it. **Questions** * What if you want to delete a stock profile? * Optional features? * Turn off defaults? Perhaps `{... "thing": null, }`? ### Child Work Items * [x] #1880 Keep the original json blob around, and when we make edits to it, only append them or replace the existing values <hr> ## Things that need to be done to accomplish Cascading Settings Each `<h3>` here is a single PR into master, broken into either sub-PRs or work for me to do as a part of that PR ### [x] Don't re-serialize settings on load (PR: #2475) This should be done first and foremost. This is not really helping anyone. Old settings all migrate nicely, so whatever. Let's just pull it. ### [_] Combine a defaults.json with a profiles.json (PR: #2515) * [x] Add a defaults.json to the package * [x] Create a function for layering a `Json::Value` on top of an existing object * [x] Add tests for layering a profile json blob on top of a profile * [x] Add functions to search a list of `Profile`s for a duplicate, and layer on that dupe or create a new `Profile` if no such dupe exists. * [x] Ensure we can layer each of the following: (WITH TESTS) * [x] layer profiles * [x] layer color schemes * [x] layer keybindings (for a matching key, the user action should override the default action) **(NEEDS TESTS)** * [x] layer globals **(NEEDS TESTS)** * [x] When loading settings, load defaults, then layer user settings on top of default profiles * [x] Maintain user settings ordering, not defaults+user ordering * [x] Add support for unbinding default keys - [x] unbind with `"unbound"` - [x] unbind with `null` * [x] Add support for hiding profiles * [x] Ensure that we can reset optional default settings with `null` (e.g. `"iconPath": null`) * [x] Create the User Settings file if it doesn't exist * [x] Stamp the "defaults.json" file into the code, so we can't possibly fail loading it * [x] Add support for Alt clicking on "settings" to launch the defaults.json file * [x] default construct profiles with scheme "Campbell" to make "scheme" and unnecessary setting in the partial diff ### [_] Add Dynamic Profile Generators * [x] Add Dynamic Profile Generator for WSL * [x] Create Dynamic Profile Generator interface * [x] ~~Provide DPG's with `GetNamespaceGuid` and `GetGuidForName` functions from `App` somehow~~ We're not doing this anymore. We'll create the GUID for the profile when it's returned, if it has a GUID of {0} - [x] Add a test for generateing a guid based on namespace if GUID is {0} * [x] Add layering for dynamic profiles based on `guid` and `source`, not _just_ `guid` * [x] Add Dynamic Profile Generator for Powershell Core * [x] Add Dynamic Profile Generator for Azure Cloud Shell * [x] Ensure that existing WSL, Powershell Core, and Azure profiles gracefully migrate to dynamic profiles * [x] Add `disabledProfileSources` in user settings to hide dynamic profiles by namespace * [ ] On first launch of the terminal, if Powershell Core exists, make it the default profile * [x] When adding this profiles, insert them into our JSON parse tree to save them * [x] Only add the delta between the default profile and the dynamic profile's default state to the json. Don't include any user customizations (though at this point there won't be any) * [x] Ensure adding a dynamic entry doesn't reformat settings * [ ] For profiles that were created from a dynamic profile source, they'll have both a `guid` and `source` guid that must _both_ match. If a user profile with a `source` set does not find a matching profile at load time, the profile **should be ignored**. * [ ] profile diffs should probably not include `"table"`. Probably don't need to include in the diff keys that are `std::nullopt` in both the base and derived. * [ ] Make sure to re-order profiles so they're { user profiles, dynamics not in user profiles, defaults not in user profiles } ### [_] Smart Serializing This would be needed for a Settings UI, so we don't necessarily need it for 1.0 * [ ] Keep the original JSON parse tree around in memory * [ ] Only serialize things different from defaults * [x] profiles * [ ] schemes * [ ] keybindings
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 Area-Settings Issue-Feature Product-Terminal Resolution-Fix-Committed
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#1033
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?