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

Encapsulate the background image settings into a JSON object #1175

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

Originally created by @carlos-zamora on GitHub (May 16, 2019).

Summary of the new feature/enhancement

As we're adding more settings to the JSON file, do we want to keep what's in each object flat or should we start introducing nested objects? I think having them be nested looks nicer and is easier to read (especially as the settings file gets really big). On the other hand, this might mean that we're forcing settings to look a certain way.

Consider this:

  • Today:
{
    guid: ...,
    useAcrylic: ...,
    colorScheme: ...,
    backgroundImage: ...,
    backgroundImageOpacity: ...,
    backgroundImageStretchMode: ...,
    backgroundImageSetting4: ...,
    backgroundImageSetting5: ...
}
  • Proposal:
{
    guid: ...,
    useAcrylic: ...,
    colorScheme: ...,
    backgroundImage: 
    {
        url: ...,
        opacity: ...,
        stretchMode: ...,
        setting4: ...,
        setting5: ...
    }
}

I think the proposal looks a lot nicer. I'm picking on backgroundImage from #853 but it definitely can apply to some other things like fontProperties (size, family, etc...) and devEnvironment (environmentVariables, startingDirectory, etc...).

Also, I think it's easier to see the benefit when there's a nasty looking settings file as follows:

{
    profileName: ...,
    backgroundImage: ...,
    guid: ...,
    backgroundImageOpacity: ...,
    useAcrylic: ...,
    backgroundImageStretchMode: ...,
    colorScheme: ...
}
Originally created by @carlos-zamora on GitHub (May 16, 2019). # Summary of the new feature/enhancement As we're adding more settings to the JSON file, do we want to keep what's in each object flat or should we start introducing nested objects? I think having them be nested looks nicer and is easier to read (especially as the settings file gets really big). On the other hand, this might mean that we're forcing settings to look a certain way. Consider this: - Today: ``` { guid: ..., useAcrylic: ..., colorScheme: ..., backgroundImage: ..., backgroundImageOpacity: ..., backgroundImageStretchMode: ..., backgroundImageSetting4: ..., backgroundImageSetting5: ... } ``` - Proposal: ``` { guid: ..., useAcrylic: ..., colorScheme: ..., backgroundImage: { url: ..., opacity: ..., stretchMode: ..., setting4: ..., setting5: ... } } ``` I think the proposal looks a lot nicer. I'm picking on backgroundImage from #853 but it definitely can apply to some other things like `fontProperties` (size, family, etc...) and `devEnvironment` (environmentVariables, startingDirectory, etc...). Also, I think it's easier to see the benefit when there's a nasty looking settings file as follows: ``` { profileName: ..., backgroundImage: ..., guid: ..., backgroundImageOpacity: ..., useAcrylic: ..., backgroundImageStretchMode: ..., colorScheme: ... } ```
claunia added the Area-SettingsIssue-TaskProduct-Terminal labels 2026-01-30 22:18:10 +00:00
claunia commented 2026-01-30 22:18:11 +00:00
Author
Owner
Copy Link

@DHowett-MSFT commented on GitHub (May 20, 2019):

We'll also need to investigate what it means to provide connection-specific settings -- once there's more than just the ConhostConnection, we'll want configuration options per connection. Does that make this a better or worse idea?

@DHowett-MSFT commented on GitHub (May 20, 2019): We'll also need to investigate what it means to provide connection-specific settings -- once there's more than just the ConhostConnection, we'll want configuration options per connection. Does that make this a better or worse idea?
claunia commented 2026-01-30 22:18:11 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Nov 22, 2021):

I'm gonna repurpose this to "encapsulate the background image settings into a JSON object". We've already got non-flat settings for appearances, and for font properties. So this would be fairly easy to do with the background image as well (if wildly less important now with the SUI).

@zadjii-msft commented on GitHub (Nov 22, 2021): I'm gonna repurpose this to "encapsulate the background image settings into a JSON object". We've already got non-flat settings for appearances, and for font properties. So this would be fairly easy to do with the background image as well (if wildly less important now with the SUI).
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-Task Product-Terminal
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#1175
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?