MEGATHREAD: Breaking settings changes in version 0.11! #5458

DHowett-MSFT · 2020-04-22T05:09:03Z

BREAKING SETTINGS CHANGES IN 0.11

BREAKING CHANGE We've deleted a lot of legacy settings handling (Remove a heap of legacy settings deserialization #5190)
- Please see our blog post and our most recent status update for more information.
- If you had settings hanging out in the globals dictionary, you'll want to move them out.
  - REMEDIATION: move everything from globals to the root of your settings file and delete the empty globals object.
  - Failure to do so will cause us to ignore your default profile, launch mode, etc., etc.
  - THIS INCLUDES defaultProfile
- requestedTheme has been renamed to theme (Rename 'requestedTheme' to 'theme' #5265)
profiles.json has been renamed to settings.json. This should be transparent to you as we'll rename it on first launch (rename profiles.json to settings.json, clean up the defaults #5199)
- As a side effect, we'll finally stop resurrecting old pre-version-0.3 roaming profiles.
If you don't specify a splitPane split mode, it'll default to automatic (Use an Automatic split for splitPane by default #5194)
copy's original and poorly-understood trimWhitespace argument is now called singleLine to indicate that it will, in fact, copy text as a single line (Rename copy keybinding arg #5216)
The default font for any profiles that don't specify a font is now Cascadia Mono (Set Cascadia Code as default font #5121)

Do your settings look like this?

{
    "globals": {
        "defaultProfile": "{0caa0dad-35be-5f56-a8ff-afceeeaa6101}",
        "initialCols": 200,
        "initialRows": 65,
        "initialPosition": "0,0",
        "wordDelimiters" : " ()\"'-:,;<>~!@#$%^&*|+=[]{}~?\u2502",
        "confirmCloseAllTabs": true,
        "keybindings": [
            ...
        ]
    },
    "profiles": {
        ...
    }
}

Then change them to look like this:

{
    "defaultProfile": "{0caa0dad-35be-5f56-a8ff-afceeeaa6101}",
    "initialCols": 200,
    "initialRows": 65,
    "initialPosition": "0,0",
    "wordDelimiters" : " ()\"'-:,;<>~!@#$%^&*|+=[]{}~?\u2502",
    "confirmCloseAllTabs": true,
    "keybindings": [
        ...
    ],
    "profiles": {
        ...
    }
}

Or even better, make a backup of your settings file, and delete the contents entirely. We'll re-generate the file with some better formatting and more sane defaults, and you can copy the modifications you want back in.

The text was updated successfully, but these errors were encountered:

mlewand · 2020-04-23T07:55:15Z

Out of curiosity, any reason why settings.json's global values weren't moved automatically to the root level after the upgrade? You migrate the config on multiple occasions which is good, but not this time.

I myself had this problem and got into #5489 even though I scanned changelog before the upgrade, but haven't picked up that I have actually to change something in my config 🙂

bmarkovic · 2020-04-23T16:33:18Z

If you had settings hanging out in the globals dictionary, you'll want to move them out.
Failure to do so will cause us to ignore your default profile, launch mode, etc., etc.
THIS INCLUDES defaultProfile

You might want to reword that from "move them out" as that really doesn't say nearly enough to anyone. Be specific:

...you will need to move them to the root object of the settings.json.

DHowett-MSFT · 2020-04-23T16:36:26Z

@bmarkovic that’s a great suggestion, thank you. I appreciate that you edited your comment.

bmarkovic · 2020-04-23T16:39:10Z

In my particular case this didn't restore functionality of keybindings, did something change about the format (or the JSON key name)?

DHowett-MSFT · 2020-04-23T16:40:15Z

Interesting. If you scroll down, do you happen to have a separate copy of keybindings? That may be an obnoxious gotcha on top of all this ☹️

bmarkovic · 2020-04-23T16:42:51Z

Unfortunately, no.

I see in #3600 that "command" is an object now, is that mandatory (i.e. the old format where "command" is string no longer works)?

Also in my config, "keys" is an array, here it is a string.

E.g.

        {
            "command" : "newTab",
            "keys" : 
            [
                "ctrl+t"
            ]
        },

DHowett-MSFT · 2020-04-23T16:44:40Z

Nah, action+command (the object format) isn’t mandatory, and keys can be either a string or an array... Would you mind sharing a gist of your settings?

bmarkovic · 2020-04-23T16:46:21Z

Off course not.

https://gist.github.com/bmarkovic/485363256672f4be66379c4d9a604c81

Edit: In case someone else comes along with an issue like this, the issue is that A LOT of these settings have changed and are no longer valid. If you are using VS.Code it will respect the new JSON schema, underline the things that are no longer valid, and you will have to refer to:

https://github.com/microsoft/terminal/blob/master/doc/cascadia/SettingsSchema.md

for the format of the new settings.

DHowett-MSFT · 2020-04-23T17:30:08Z

Ah, I'm gonna guess that the key bindings that aren't working are the Ctrl+Shift+# ones. Sorry our documentation failed you here -- those are included in the legacy settings removal from #5190. Right now, I think those old bindings are replacing the default bindings with their no-longer-effective legacy versions and you can just delete them.

Here's a better way out, though:

Judging by all the key bindings, the format, and the profiles containing every config option, it looks like that settings file predates 0.2. I really think it's great that you've been with us that long (since our first public release!) Thanks! Versions of Terminal after 0.5 lay down a cool new settings template that's more streamlined, and is a bit better-documented. There's a set of "default" settings now that live in the terminal package that your settings get applied on top of.

It's not a requirement by any means, but you might be a bit happier in general if you spend a couple minutes migrating.

move your old settings file aside
let Terminal make a new one (automatic on startup)
copy over key bindings that you care about (since you're using pre-0.2 settings, you might care that Ctrl+W and Ctrl+T are bound to close/open tab (which was a bad decision we made almost a whole year ago).
copy over some profiles you care about.

The settings model change from 0.5 means you don't need to specify every option in every profile, and you don't need to be quite so aggressive in customizing everything.

I took a stab at it -- this should be equivalent to your old settings, but with a whole bunch of the legacy cruft removed.

https://gist.github.com/DHowett-MSFT/ec2d24cf2b84e1555fb56a1192e4fb94

I didn't know if you used alt+N for switching tabs, but those were some of the old key bindings in your settings and I didn't want to go stomp them 😄
A bunch of your "duplicated" settings got moved into the "defaults" group.. cuts down on repetitive lines for sure.

DHowett-MSFT · 2020-04-23T17:31:40Z

The hallmark of an old (version 0.2) settings file is ctrl+w being bound, and being bound to closeTab (it closes the whole tab, even if there's panes inside it). The modern binding is Ctrl+Shift+W for closePane, which only closes the active focused pane.

bmarkovic · 2020-04-23T17:43:14Z

Hah, I've done it myself too in the meantime (I updated the alt+ tab switches, as I did use them) as well. I will take a look at your take on it too. This machine is not really my day-job driver (contrary to, I guess, most people, the Windows box is a play thing, and I earn my bread and butter on a Linux desktop) so that might be why I've not updated all this before.

Here is a pretty verbatim translation of my settings file to new schema (with a change here and there to make use of some new, previously unavailable settings), from my quick test they all do work after I change the target commands and format. I'll look at the "no-legacy cruft" version you pasted as well (I don't want get attached my non-standard bindings) and probably make some combo for future use.

Thank you for the help, and I do love the program. It has completely replaced ConEmu as the go-to terminal emulator on Windows for me.

DHowett-MSFT · 2020-04-23T17:44:21Z

Thank you for the help, and I do love the program. It has completely replaced ConEmu as the go-to terminal emulator on Windows for me.

Happy to hear that, and I'm sorry it's been a bit of a bumpy ride here on the preview train 😅

afmsavage · 2020-05-04T14:42:52Z

What a pain. Appreciate the commenting in the new generated settings.json but a straight copy/paste from the older version doesn't work. Cannot get color schemes working and now they are forcing you to have an enabled Azure Cloud Shell profile enabled. Comment it out, save, and it pops right back in.

zadjii-msft · 2020-05-04T14:48:11Z

From #5611

Wow, if you had colorscheme in your settings file, you must have installed the Terminal an exceptionally long time ago. Thanks for sticking with us for so long through the preview process ❤️!

As you've found out, the colorscheme key was deprecated in favor of colorScheme. Largely, we're tracking all the "upgrade to 0.11 broke my settings" bugs with #5458, so I'm gonna close this thread as a duplicate.

Thanks!

Maybe try changing "hidden": false 🤔 from #5684:

👉 NOTE: On launch, if a dynamic profile generator is enabled, it will always add new profiles it detects to your list of profiles. If you delete a dynamically generated profile from your list of profiles, it will just get re-added the next time the Terminal is launched! To remove a dynamic profile from your list of profiles, make sure to set "hidden": true in the profile.

tomm1e · 2020-05-05T13:01:23Z

Is black the new default? The regenerated settings.json does not contain any color schemes.

zadjii-msft · 2020-05-05T13:36:28Z

@tomm1e That's entirely intentional. We figured that every user didn't need to see a full copy of every default scheme in their settings file, so we moved them to defaults.json. You can still use the schemes in that file.

ashemedai · 2020-05-06T08:46:54Z

So upon a fresh install of Terminal the settings.json file contains a bunch of URL references. However, most of them lead nowhere useful. Can these changes be made for the sake of people actually trying these URLs since 1.0 is approaching? :)

ref URL	leads to	should be
https://aka.ms/terminal-documentation	https://github.com/microsoft/terminal/blob/master/doc/user-docs/index.md	https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md
https://aka.ms/terminal-global-settings	https://github.com/microsoft/terminal/blob/master/doc/user-docs/index.md	https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md#global-settings
https://aka.ms/terminal-profile-settings	https://github.com/microsoft/terminal/blob/master/doc/user-docs/index.md	https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md#profiles
https://aka.ms/terminal-color-schemes	https://github.com/microsoft/terminal/blob/master/doc/user-docs/index.md	https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md#color-schemes
https://aka.ms/terminal-keybindings	https://github.com/microsoft/terminal/blob/master/doc/user-docs/index.md	https://github.com/microsoft/terminal/blob/master/doc/user-docs/UsingJsonSettings.md#key-bindings
https://aka.ms/terminal-selection	https://github.com/microsoft/terminal/blob/master/doc/user-docs/index.md	https://github.com/microsoft/terminal/blob/master/doc/user-docs/index.md#selecting-and-copying-text-in-windows-terminal
https://aka.ms/terminal-panes	https://github.com/microsoft/terminal/blob/master/doc/user-docs/index.md	?

zadjii-msft · 2020-05-06T13:31:21Z

Those links are going to go somewhere useful Soon^TM. Please bear with us as we put the finishing touches on the actual docs 😉

ashemedai · 2020-05-06T14:52:44Z

@zadjii-msft Thanks for that update. Being a technical writer myself I always gets antsy when documentation seems to be forgotten. 😅

pecigonzalo · 2020-05-12T09:57:38Z

I noticed the blog article talks about using things like { "command": { "action": "copy", "singleLine": true ), "keys": "ctrl+alt+c" } to restore the single line copy functionality, but no indication on how to restore it to copy on select as it was previously done by copyFormatting. Is it possible to copy as single line but leave copyFormatting: false?

eg.

Select text that breaks into multiline due to window size
Paste with ctrl-shift-v
It breaks into newlines

We should document this as IMO its not clear that copyFormatting affects single line paste and if possible, how to fix it.

DHowett-MSFT · 2020-05-12T21:54:43Z

copyFormatting doesn't impact single-line paste or copy on select. copyOnSelect impacts copy on select.

Text that is broken into newlines due to window size is doing so because of a bug, and the solution isn't to set singleLine to true.

Do you have a specific repro that causes broken multiline text?

DHowett-MSFT · 2020-05-12T21:55:41Z

(There are three independent copy flags. copyOnSelect determines whether text is copied when you release the left mouse button, copyFormatting determines whether text is copied with color information and singleLine determines whether all newlines are deleted, even if they were intentional.)

pecigonzalo · 2020-05-12T22:13:13Z

@DHowett-MSFT I understand that to be the case regarding the different options, but it seems then there is a bug that affect that and its "fixed" by setting copyFormatting to true.

Repro for me is really simple for me and I can even dynamically toggle that and have it broken/fixed.

~
❯ echo this is a really long command that shouldnotbe breaking when copy paste
this is a really long command that shouldnotbe breaking when copy paste

~
❯ echo this is a really long command that shouldnotbe breakin

this is a really long command that shouldnotbe breakin

~
❯ g when copy paste
git: 'when' is not a git command. See 'git --help'.

The most similar commands are
        clean
        clone
        prune
        shell

~
❯

As you can see on that output, the line when pasted is split into multi line and ran as 2 commands.

Type a really long line that breaks to multi-line in your console (or make a smaller console)
Select text
Paste as ctrl+shif+v or ctrl-v or right click or whatever is your paste
It runs 2 commands
Toggle copyFormatting to true
Do the same
Does not break

Please note im not copying with ctrl+c or ctrl+shift+c but with copy on select.

For reference, this is my relevant config:

{
  "$schema": "https://aka.ms/terminal-profiles-schema",
  "defaultProfile": "{01751d96-d6f8-573f-8029-e581f2f7c955}",
  "copyFormatting": false,
  "profiles": {
    "defaults": {
      "historySize": 9001,
      "fontFace": "Fira Code",
      "fontSize": 12,
      "useAcrylic": true,
      "acrylicOpacity": 0.85
    },
    "list": [
      ...
    ]
  },
  "schemes": [
    ...
  ],
  "keybindings": [
    {
      "command": {
        "action": "copy",
        "singleLine": true
      },
      "keys": "ctrl+c"
    },
    {
      "command": {
        "action": "adjustFontSize",
        "delta": -1
      },
      "keys": "ctrl+-"
    },
    {
      "command": {
        "action": "adjustFontSize",
        "delta": 1
      },
      "keys": "ctrl+="
    }
  ]
}

pecigonzalo · 2020-05-12T22:22:22Z

Ok, oddly enough while I just did this while creating this comment and it caused the output I pasted (broken line) and it happened multiple times since the update. I just ran it once again after, just to check other cases and it worked correctly, which has me really confused now.

EverlyScott · 2020-05-17T00:22:34Z

Any reason why we haven't gotten a GUI for changing settings yet?

DHowett · 2020-05-17T00:25:40Z

@ScribbleNerd because that will take months of work that we couldn't complete until we nailed the basics of actually being a terminal? That work is being tracked in #1564.

exitdown · 2020-05-17T02:07:40Z

yeah not meaning to sound condescending but its a cli tool for cli competent people, so it makes far more sense to work on the core functionality and cli user features rather than trying to make it easy point and click to make pretty - at least until all the main things are done, upvote for html link handler haha

issue : microsoft/terminal#5458

ashishpawar517 · 2020-05-22T16:32:43Z

I only changed the default profile to cmd.exe in last version. then today after update it showing me global deprecated error over and over again.

warpdesign · 2020-06-01T19:54:43Z

How about automatically converting the file if older format is detected: seeing the format changes it appears to be possible.

Seeing how full of comments is this issue I think this could solve problems for a lot of people.

garethj-msft · 2020-06-10T05:59:26Z

Got to say, I found this extremely jarring for a product that that is at GA status.
Auto-migrating such things seems a pretty bare minimum for a breaking change release.

DHowett · 2020-06-10T07:37:50Z

is at GA status

Only people who were using the Preview build will encounter breaking changes. The preview build was offered with no warranties (express or implied.)

I’m sorry it was jarring. Settings migration is planned for any updates to the stable channel that require settings model changes.

DHowett-MSFT added Issue-Question For questions or discussion Area-Settings Issues related to settings and customizability, for console or terminal Product-Terminal The new Windows Terminal. labels Apr 22, 2020

ghost added the Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting label Apr 22, 2020

DHowett-MSFT pinned this issue Apr 22, 2020

DHowett-MSFT removed the Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting label Apr 22, 2020

DHowett-MSFT modified the milestone: Terminal v1.0 Apr 22, 2020

DHowett-MSFT changed the title ~~MEGATHREAD: My settings are gone! My default profile stopped bring default! I hate this!~~ MEGATHREAD: My settings are gone! My default profile broke! I hate this! Apr 22, 2020

This was referenced Apr 22, 2020

settings.json: "defaultProfile" seems to work only at old top-level place #5474

Closed

Default profile is not working in version 0.11.1121.0 #5476

Closed

DHowett-MSFT changed the title ~~MEGATHREAD: My settings are gone! My default profile broke! I hate this!~~ MEGATHREAD: DEFAULT PROFILE STOPPED WORKING! My settings are gone! I hate you! Apr 22, 2020

DHowett-MSFT changed the title ~~MEGATHREAD: DEFAULT PROFILE STOPPED WORKING! My settings are gone! I hate you!~~ MEGATHREAD: DEFAULT PROFILE STOPPED WORKING! Settings are gone! I hate you! Apr 22, 2020

DHowett-MSFT mentioned this issue Apr 22, 2020

Changes to globals section of settings.json are ignored #5473

Closed

mlewand mentioned this issue Apr 23, 2020

defaultProfile setting is no longer respected #5489

Closed

DHowett-MSFT mentioned this issue Apr 23, 2020

Using different GUIDs for profiles that use "source" cause them to not be found by Terminal. #5490

Closed

This comment has been minimized.

Sign in to view

blkc mentioned this issue May 18, 2020

WSL2 localhost forwarding doesn't seem to work microsoft/WSL#4636

Closed

SimpleDays pushed a commit to SimpleDays/WindowsTerminalProfiles that referenced this issue May 20, 2020

edit profiles.json

43cfbad

issue : microsoft/terminal#5458

zadjii-msft mentioned this issue May 20, 2020

Can not set the tabBar color #6035

Closed

KaKi87 mentioned this issue May 21, 2020

Feature Request Move scroll buffer instead of clearing on CTRL+L and on clear #2832

Closed

DHowett mentioned this issue May 21, 2020

Keymap configuration cannot be recognized #6102

Closed

zadjii-msft mentioned this issue Jun 1, 2020

Alt+1, Alt+2 in Settings file is not working properly to switch to corresponding tabs #6260

Closed

DHowett unpinned this issue Jun 30, 2020

Re-fresh mentioned this issue Jul 7, 2020

How does one install the same on Windows Terminal ? dracula/powershell#35

Closed

microsoft locked as resolved and limited conversation to collaborators Jul 9, 2020

DHowett closed this as completed Jul 9, 2020

ghost added the Needs-Tag-Fix Doesn't match tag requirements label Jul 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MEGATHREAD: Breaking settings changes in version 0.11! #5458

MEGATHREAD: Breaking settings changes in version 0.11! #5458

DHowett-MSFT commented Apr 22, 2020 •

edited

Loading

mlewand commented Apr 23, 2020 •

edited

Loading

bmarkovic commented Apr 23, 2020 •

edited

Loading

DHowett-MSFT commented Apr 23, 2020

bmarkovic commented Apr 23, 2020

DHowett-MSFT commented Apr 23, 2020

bmarkovic commented Apr 23, 2020 •

edited

Loading

DHowett-MSFT commented Apr 23, 2020

bmarkovic commented Apr 23, 2020 •

edited

Loading

DHowett-MSFT commented Apr 23, 2020 •

edited

Loading

DHowett-MSFT commented Apr 23, 2020 •

edited

Loading

bmarkovic commented Apr 23, 2020

DHowett-MSFT commented Apr 23, 2020

This comment has been minimized.

This comment has been minimized.

afmsavage commented May 4, 2020

zadjii-msft commented May 4, 2020

tomm1e commented May 5, 2020

zadjii-msft commented May 5, 2020

ashemedai commented May 6, 2020

zadjii-msft commented May 6, 2020

ashemedai commented May 6, 2020

pecigonzalo commented May 12, 2020 •

edited

Loading

DHowett-MSFT commented May 12, 2020

DHowett-MSFT commented May 12, 2020

pecigonzalo commented May 12, 2020 •

edited

Loading

pecigonzalo commented May 12, 2020 •

edited

Loading

EverlyScott commented May 17, 2020

DHowett commented May 17, 2020 •

edited

Loading

exitdown commented May 17, 2020 •

edited

Loading

ashishpawar517 commented May 22, 2020

warpdesign commented Jun 1, 2020 •

edited

Loading

garethj-msft commented Jun 10, 2020

DHowett commented Jun 10, 2020

MEGATHREAD: Breaking settings changes in version 0.11! #5458

MEGATHREAD: Breaking settings changes in version 0.11! #5458

Comments

DHowett-MSFT commented Apr 22, 2020 • edited Loading

BREAKING SETTINGS CHANGES IN 0.11

mlewand commented Apr 23, 2020 • edited Loading

bmarkovic commented Apr 23, 2020 • edited Loading

DHowett-MSFT commented Apr 23, 2020

bmarkovic commented Apr 23, 2020

DHowett-MSFT commented Apr 23, 2020

bmarkovic commented Apr 23, 2020 • edited Loading

DHowett-MSFT commented Apr 23, 2020

bmarkovic commented Apr 23, 2020 • edited Loading

DHowett-MSFT commented Apr 23, 2020 • edited Loading

DHowett-MSFT commented Apr 23, 2020 • edited Loading

bmarkovic commented Apr 23, 2020

DHowett-MSFT commented Apr 23, 2020

This comment has been minimized.

This comment has been minimized.

afmsavage commented May 4, 2020

zadjii-msft commented May 4, 2020

tomm1e commented May 5, 2020

zadjii-msft commented May 5, 2020

ashemedai commented May 6, 2020

zadjii-msft commented May 6, 2020

ashemedai commented May 6, 2020

pecigonzalo commented May 12, 2020 • edited Loading

DHowett-MSFT commented May 12, 2020

DHowett-MSFT commented May 12, 2020

pecigonzalo commented May 12, 2020 • edited Loading

pecigonzalo commented May 12, 2020 • edited Loading

EverlyScott commented May 17, 2020

DHowett commented May 17, 2020 • edited Loading

exitdown commented May 17, 2020 • edited Loading

ashishpawar517 commented May 22, 2020

warpdesign commented Jun 1, 2020 • edited Loading

garethj-msft commented Jun 10, 2020

DHowett commented Jun 10, 2020

DHowett-MSFT commented Apr 22, 2020 •

edited

Loading

mlewand commented Apr 23, 2020 •

edited

Loading

bmarkovic commented Apr 23, 2020 •

edited

Loading

bmarkovic commented Apr 23, 2020 •

edited

Loading

bmarkovic commented Apr 23, 2020 •

edited

Loading

DHowett-MSFT commented Apr 23, 2020 •

edited

Loading

DHowett-MSFT commented Apr 23, 2020 •

edited

Loading

pecigonzalo commented May 12, 2020 •

edited

Loading

pecigonzalo commented May 12, 2020 •

edited

Loading

pecigonzalo commented May 12, 2020 •

edited

Loading

DHowett commented May 17, 2020 •

edited

Loading

exitdown commented May 17, 2020 •

edited

Loading

warpdesign commented Jun 1, 2020 •

edited

Loading