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

Renaming a color scheme used by a profile should properly update the profile #12035

New Issue
Closed
opened 2026-01-31 03:04:36 +00:00 by claunia · 1 comment
claunia commented 2026-01-31 03:04:36 +00:00
Owner
Copy Link

Originally created by @carlos-zamora on GitHub (Jan 12, 2021).

Originally assigned to: @carlos-zamora on GitHub.

Steps to reproduce

  1. Open Settings UI
  2. Have a profile ("Profile A") refer to a custom color scheme ("Color Scheme A")
  3. Go to the Color Schemes page
  4. Select "Color Scheme A"
  5. Rename it to something else ("Color Scheme B")
  6. Navigate back to the profile that referred to this color scheme ("Profile A")

Expected behavior

"Profile A" should now reference "Color Scheme B".

Actual behavior

"Profile A" refers to "Campbell"

Additional details

The TerminalSettingsModel stores Profile.ColorScheme as a string reference to the name of the ColorScheme.
In TerminalSettingsEditor (Profiles.cpp), if a ColorScheme with that name isn't found, we fallback to "Campbell".

Perhaps a better architecture would be to reference a ColorScheme object in the TerminalSettingsModel? Or at least reference a ColorScheme object in the ViewModel in TerminalSettingsEditor.

Originally created by @carlos-zamora on GitHub (Jan 12, 2021). Originally assigned to: @carlos-zamora on GitHub. # Steps to reproduce 1. Open Settings UI 2. Have a profile ("Profile A") refer to a custom color scheme ("Color Scheme A") 3. Go to the Color Schemes page 4. Select "Color Scheme A" 5. Rename it to something else ("Color Scheme B") 6. Navigate back to the profile that referred to this color scheme ("Profile A") # Expected behavior "Profile A" should now reference "Color Scheme B". # Actual behavior "Profile A" refers to "Campbell" # Additional details The TerminalSettingsModel stores Profile.ColorScheme as a string reference to the name of the ColorScheme. In TerminalSettingsEditor ([Profiles.cpp](https://github.com/microsoft/terminal/blob/7235996b4d83b340a9cfa7227381922e5ad7baf8/src/cascadia/TerminalSettingsEditor/Profiles.cpp#L130)), if a ColorScheme with that name isn't found, we fallback to "Campbell". Perhaps a better architecture would be to reference a `ColorScheme` object in the TerminalSettingsModel? Or at least reference a `ColorScheme` object in the ViewModel in TerminalSettingsEditor.
claunia commented 2026-01-31 03:04:37 +00:00
Author
Owner
Copy Link

@carlos-zamora commented on GitHub (Jan 14, 2021):

So, I'm conflicted. There's the "brute-force" approach and the "elegant" way to do this:

  • brute-force approach:
    • When rename is accepted, iterate over all profiles and if profile.ColorSchemeName() == oldName, update the profile w/ profile.ColorSchemeName(newName).
  • elegant approach:
    • Idea: use ColorScheme references so that renaming a ColorScheme automatically updates whoever references it
    • Implementation:
      • ProfileViewModel holds a reference to a ColorScheme object (the one that the String ColorSchemeName refers to)
      • (the hard/annoying part) Since ColorScheme.Name() is not observable, we need to create a ColorSchemeViewModel to wrap each ColorScheme, which makes Name observable.
      • On a NameChanged event, ProfileViewModel would update Profile.ColorSchemeName
    • Concerns:
      • As I was writing this, I realized that that won't work either. We're creating the ProfileViewModel as we're navigating to the profile page. So the reference to the ColorScheme object would be created after the rename operation was completed.
      • To get around that issue, we would have to wrap all of the settings model objects with their respective view model objects when the Settings UI is opened.

@DHowett I'm going with the brute-force approach right now. Not too happy with it but it'll at least fix the bug for now. We should discuss what the overall architecture should look like, then file an issue to perform the refactor.

@carlos-zamora commented on GitHub (Jan 14, 2021): So, I'm conflicted. There's the "brute-force" approach and the "elegant" way to do this: - **brute-force approach**: - When rename is accepted, iterate over all profiles and if `profile.ColorSchemeName() == oldName`, update the profile w/ `profile.ColorSchemeName(newName)`. - **elegant approach**: - **Idea**: use `ColorScheme` references so that renaming a `ColorScheme` automatically updates whoever references it - **Implementation**: - `ProfileViewModel` holds a reference to a `ColorScheme` object (the one that the `String ColorSchemeName` refers to) - (the hard/annoying part) Since `ColorScheme.Name()` is not observable, we need to create a `ColorSchemeViewModel` to wrap each `ColorScheme`, which makes `Name` observable. - On a `NameChanged` event, `ProfileViewModel` would update `Profile.ColorSchemeName` - **Concerns**: - As I was writing this, I realized that that won't work either. We're creating the `ProfileViewModel` as we're navigating to the profile page. So the reference to the `ColorScheme` object would be created _after_ the rename operation was completed. - To get around that issue, we would have to wrap all of the settings model objects with their respective view model objects when the Settings UI is opened. @DHowett I'm going with the brute-force approach right now. Not too happy with it but it'll at least fix the bug for now. We should discuss what the overall architecture should look like, then file an issue to perform the refactor.
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-SettingsUI Issue-Bug Priority-1 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#12035
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?