Add support for "defaults" in profiles

[Jaykul]

The Windows Terminal profiles.json schema supports default settings for profiles by pushing the Profiles list down into a "list" property of a "Profiles" object ...

That is, instead of specifying profiles as an array:

"profiles": [
  {

We can specify profiles as an object, that has two properties: defaults, and list (which is the list of profiles as before, but now we can avoid repeating settings that are already in defaults):

  "profiles": {
    "defaults": {
      "fontFace": "CaskaydiaCove Nerd Font Mono",
      "padding": "0, 0, 0, 0",
      "backgroundImageAlignment": "bottomRight",
      "backgroundImageStretchMode": "none",
      "backgroundImageOpacity": 0.5,
      "useAcrylic": true,
      "acrylicOpacity": 0.4,
      "colorScheme": "Darkish"
    },
    "list": [
      {

...

Anyway. Currently this module basically falls over if I configure my profiles that way.

Also, it's worth mentioning that you really need to "layer" profiles.json on top of default.json if you want a full picture (e.g. all the color schemes are in there now).

You can find it via ...

Split-Path (Get-Process WindowsTerminal).Path | Get-ChildItem -Filter defaults.json

In PowerShell 7, they've added support for AppExeCLink junctions, so you can do this, even if it's not running:

Get-Command wt | Get-Item | ForEach-Object Target | Split-Path | Get-ChildItem -Filter defaults.json

[Jaykul]

For what it's worth ... here's my second draft 😉 which uses Update-Object from the Configuration module...

function GetLayeredConfig {
    [CmdletBinding()]
    param(
        # If set, update the profiles with values from profiles.defaults
        [switch]$FlattenDefaultProfile
    )

    # Hypothetically the file is in the first location, but if you're using a dev copy instead, it might be elsewhere:
    $script:UserConfigFile = Get-ChildItem @(
        "$Env:LocalAppData/packages/Microsoft.WindowsTerminal_8wekyb3d8bbwe/LocalState/profiles.json"
        "$Env:LocalAppData/packages/WindowsTerminalDev_8wekyb3d8bbwe/LocalState/profiles.json"
        "$Env:AppData/Microsoft/Windows Terminal/profiles.json"
        ) -ErrorAction Ignore | Select-Object -First 1

    if (!$UserConfigFile) {
        Write-Warning "Unable to locate Windows Terminal's profiles.json"
    } else {
        $global:Config = ConvertFrom-Json (Get-Content $UserConfigFile -Raw)
        $global:UserConfig = ConvertFrom-Json (Get-Content $UserConfigFile -Raw)
    }

    if (($wtExecutable = (Get-Process WindowsTerminal -ErrorAction Ignore).Path)) {
        $DefaultConfigFile = Get-ChildItem ($wtExecutable | Split-Path) -Filter defaults.json
    }

    if (!$DefaultConfigFile) {
        Write-Warning "Unable to locate Windows Terminal's default.json"
    } else {
        $global:Default = ConvertFrom-Json (Get-Content $DefaultConfigFile -Raw)
    }

    # The profiles exist two different ways, so we have to normalize that first ...
    # The only way to normalize it is to add the `default`:
    if (!(Get-Member Defaults -Input $UserConfig.Profiles)) {
        $UserConfig.profiles = [PSCustomObject]@{
            default = [PSCustomObject]@{}
            list    = $UserConfig.profiles
        }
    }
    if (!(Get-Member Defaults -input $Default.Profiles)) {
        $Default.profiles = [PSCustomObject]@{
            default = [PSCustomObject]@{}
            list    = $Default.profiles
        }
    }

    # Update-Object doesn't handle arrays at all, so we need to deal with those manually
    for ($u = 0; $u -lt $UserConfig.profiles.list.Count; $u++) {
        if (($d = $Default.profiles.list.guid.IndexOf($UserConfig.profiles.list[$u].guid)) -ge 0) {
            # Which is fine, because maybe we need to start with the default profile
            if ($FlattenDefaultProfile -and $UserConfig.profiles.defaults) {
                $UserConfig.profiles.list[$u] = $Default.profiles.list[$d] |
                    Update-Object ($UserConfig.profiles.defaults | Select-Object *) |
                    Update-Object $UserConfig.profiles.list[$u]
            } else {
                $UserConfig.profiles.list[$u] = $Default.profiles.list[$d] |
                    Update-Object $UserConfig.profiles.list[$u]
            }
        } elseif ($FlattenDefaultProfile -and $UserConfig.profiles.defaults) {
            $UserConfig.profiles.list[$u] = $UserConfig.profiles.defaults | Select-Object * |
                    Update-Object $UserConfig.profiles.list[$u]
        }
    }
    for ($u = 0; $u -lt $UserConfig.schemes.Count; $u++) {
        if (($d = $Default.schemes.name.IndexOf($UserConfig.schemes[$u].name)) -ge 0) {
            $UserConfig.schemes[$u] = $Default.schemes[$d] | Update-Object $UserConfig.schemes[$u]
        }
    }
    # Let's be honest, schemes that are in the default probably aren't in UserConfig, so copy them:
    $existing = $UserConfig.schemes.name
    $UserConfig.schemes += $Default.schemes.where{$_.name -notin $existing}

    # Finally, copy over everything else
    Update-Object -InputObject $Default -UpdateObject $UserConfig
}

[Jaykul]

@gpduck this just went critical, because in 0.11 after they renamed the file to "settings.json" they converted it to have defaults:

    "profiles":
    {
        "defaults":
        {
            // Put settings here that you want to apply to all profiles.
        },
        "list":
        [
            {
                // Make changes here to the powershell.exe profile.
                "guid": "{61c54bbd-c2c6-5271-96e7-009a87ff44bf}",
                "name": "Windows PowerShell",
                "commandline": "powershell.exe",
                "hidden": false
            },
            ...