2019-09-27 22:38:49 +02:00
{
"$id" : "https://github.com/microsoft/terminal/blob/master/doc/cascadia/profiles.schema.json" ,
"$schema" : "http://json-schema.org/draft-07/schema#" ,
"title" : "Microsoft's Windows Terminal Settings Profile Schema'" ,
"definitions" : {
"Color" : {
"default" : "#" ,
"pattern" : "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" ,
2019-11-20 23:55:36 +01:00
"type" : "string" ,
"format" : "color"
2019-09-27 22:38:49 +02:00
} ,
"ProfileGuid" : {
"default" : "{}" ,
"pattern" : "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$" ,
"type" : "string"
} ,
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
"ShortcutActionName" : {
"enum" : [
"closePane" ,
"closeTab" ,
"closeWindow" ,
"copy" ,
"copyTextWithoutNewlines" ,
"decreaseFontSize" ,
"duplicateTab" ,
"increaseFontSize" ,
"moveFocus" ,
"moveFocusDown" ,
"moveFocusLeft" ,
"moveFocusRight" ,
"moveFocusUp" ,
"newTab" ,
"newTabProfile0" ,
"newTabProfile1" ,
"newTabProfile2" ,
"newTabProfile3" ,
"newTabProfile4" ,
"newTabProfile5" ,
"newTabProfile6" ,
"newTabProfile7" ,
"newTabProfile8" ,
"nextTab" ,
"openNewTabDropdown" ,
"openSettings" ,
"paste" ,
"prevTab" ,
2019-11-25 18:35:10 +01:00
"resetFontSize" ,
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
"resizePane" ,
"resizePaneDown" ,
"resizePaneLeft" ,
"resizePaneRight" ,
"resizePaneUp" ,
"scrollDown" ,
"scrollDownPage" ,
"scrollUp" ,
"scrollUpPage" ,
"splitHorizontal" ,
"splitVertical" ,
2019-11-28 14:42:15 +01:00
"splitPane" ,
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
"switchToTab" ,
"switchToTab0" ,
"switchToTab1" ,
"switchToTab2" ,
"switchToTab3" ,
"switchToTab4" ,
"switchToTab5" ,
"switchToTab6" ,
"switchToTab7" ,
"switchToTab8" ,
2020-01-14 21:26:30 +01:00
"toggleFullscreen" ,
"find"
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
] ,
"type" : "string"
} ,
"Direction" : {
"enum" : [
"left" ,
"right" ,
"up" ,
"down"
] ,
"type" : "string"
} ,
2019-11-28 14:42:15 +01:00
"SplitState" : {
"enum" : [
"vertical" ,
2020-01-15 20:55:13 +01:00
"horizontal" ,
"auto"
2019-11-28 14:42:15 +01:00
] ,
"type" : "string"
} ,
Add support for new panes with specifc profiles and other settings overrides (#3825)
## Summary of the Pull Request
This enables the user to set a number of extra settings in the `NewTab` and `SplitPane` `ShortcutAction`s, that enable customizing how a new terminal is created at runtime. The following four properties were added:
* `profile`
* `commandline`
* `tabTitle`
* `startingDirectory`
`profile` can be used with either a GUID or the name of a profile, and the action will launch that profile instead of the default.
`commandline`, `tabTitle`, and `startingDirectory` can all be used to override the profile's values of those settings. This will be more useful for #607.
With this PR, you can make bindings like the following:
```json
{ "keys": ["ctrl+a"], "command": { "action": "splitPane", "split": "vertical" } },
{ "keys": ["ctrl+b"], "command": { "action": "splitPane", "split": "vertical", "profile": "{6239a42c-1111-49a3-80bd-e8fdd045185c}" } },
{ "keys": ["ctrl+c"], "command": { "action": "splitPane", "split": "vertical", "profile": "profile1" } },
{ "keys": ["ctrl+d"], "command": { "action": "splitPane", "split": "vertical", "profile": "profile2" } },
{ "keys": ["ctrl+e"], "command": { "action": "splitPane", "split": "horizontal", "commandline": "foo.exe" } },
{ "keys": ["ctrl+f"], "command": { "action": "splitPane", "split": "horizontal", "profile": "profile1", "commandline": "foo.exe" } },
{ "keys": ["ctrl+g"], "command": { "action": "newTab" } },
{ "keys": ["ctrl+h"], "command": { "action": "newTab", "startingDirectory": "c:\\foo" } },
{ "keys": ["ctrl+i"], "command": { "action": "newTab", "profile": "profile2", "startingDirectory": "c:\\foo" } },
{ "keys": ["ctrl+j"], "command": { "action": "newTab", "tabTitle": "bar" } },
{ "keys": ["ctrl+k"], "command": { "action": "newTab", "profile": "profile2", "tabTitle": "bar" } },
{ "keys": ["ctrl+l"], "command": { "action": "newTab", "profile": "profile1", "tabTitle": "bar", "startingDirectory": "c:\\foo", "commandline":"foo.exe" } }
```
## References
This is a lot of work that was largely started in pursuit of #607. We want people to be able to override these properties straight from the commandline. While they may not make as much sense as keybindings like this, they'll make more sense as commandline arguments.
## PR Checklist
* [x] Closes #998
* [x] I work here
* [x] Tests added/passed
* [x] Requires documentation to be updated
## Validation Steps Performed
There are tests 🎉
Manually added some bindings, they opened the correct profiles in panes/tabs
2019-12-09 14:02:29 +01:00
"NewTerminalArgs" : {
"properties" : {
"commandline" : {
"description" : "A commandline to use instead of the profile's" ,
"type" : "string"
} ,
"tabTitle" : {
"description" : "An initial tabTitle to use instead of the profile's" ,
"type" : "string"
} ,
"startingDirectory" : {
"description" : "A startingDirectory to use instead of the profile's" ,
"type" : "string"
} ,
"profile" : {
"description" : "Either the GUID or name of a profile to use, instead of launching the default" ,
"type" : "string"
} ,
"index" : {
"type" : "integer" ,
"description" : "The index of the profile in the new tab dropdown to open"
}
} ,
"type" : "object"
} ,
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
"ShortcutAction" : {
"properties" : {
"action" : {
"description" : "The action to execute" ,
"$ref" : "#/definitions/ShortcutActionName"
}
} ,
"required" : [
"action"
] ,
"type" : "object"
} ,
"CopyAction" : {
"description" : "Arguments corresponding to a Copy Text Action" ,
"allOf" : [
{ "$ref" : "#/definitions/ShortcutAction" } ,
{
"properties" : {
"action" : { "type" : "string" , "pattern" : "copy" } ,
"trimWhitespace" : {
"type" : "boolean" ,
2019-12-04 01:27:56 +01:00
"default" : true ,
"description" : "If true, whitespace is removed and newlines are maintained. If false, newlines are removed and whitespace is maintained."
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
}
}
}
]
} ,
"NewTabAction" : {
"description" : "Arguments corresponding to a New Tab Action" ,
"allOf" : [
{ "$ref" : "#/definitions/ShortcutAction" } ,
Add support for new panes with specifc profiles and other settings overrides (#3825)
## Summary of the Pull Request
This enables the user to set a number of extra settings in the `NewTab` and `SplitPane` `ShortcutAction`s, that enable customizing how a new terminal is created at runtime. The following four properties were added:
* `profile`
* `commandline`
* `tabTitle`
* `startingDirectory`
`profile` can be used with either a GUID or the name of a profile, and the action will launch that profile instead of the default.
`commandline`, `tabTitle`, and `startingDirectory` can all be used to override the profile's values of those settings. This will be more useful for #607.
With this PR, you can make bindings like the following:
```json
{ "keys": ["ctrl+a"], "command": { "action": "splitPane", "split": "vertical" } },
{ "keys": ["ctrl+b"], "command": { "action": "splitPane", "split": "vertical", "profile": "{6239a42c-1111-49a3-80bd-e8fdd045185c}" } },
{ "keys": ["ctrl+c"], "command": { "action": "splitPane", "split": "vertical", "profile": "profile1" } },
{ "keys": ["ctrl+d"], "command": { "action": "splitPane", "split": "vertical", "profile": "profile2" } },
{ "keys": ["ctrl+e"], "command": { "action": "splitPane", "split": "horizontal", "commandline": "foo.exe" } },
{ "keys": ["ctrl+f"], "command": { "action": "splitPane", "split": "horizontal", "profile": "profile1", "commandline": "foo.exe" } },
{ "keys": ["ctrl+g"], "command": { "action": "newTab" } },
{ "keys": ["ctrl+h"], "command": { "action": "newTab", "startingDirectory": "c:\\foo" } },
{ "keys": ["ctrl+i"], "command": { "action": "newTab", "profile": "profile2", "startingDirectory": "c:\\foo" } },
{ "keys": ["ctrl+j"], "command": { "action": "newTab", "tabTitle": "bar" } },
{ "keys": ["ctrl+k"], "command": { "action": "newTab", "profile": "profile2", "tabTitle": "bar" } },
{ "keys": ["ctrl+l"], "command": { "action": "newTab", "profile": "profile1", "tabTitle": "bar", "startingDirectory": "c:\\foo", "commandline":"foo.exe" } }
```
## References
This is a lot of work that was largely started in pursuit of #607. We want people to be able to override these properties straight from the commandline. While they may not make as much sense as keybindings like this, they'll make more sense as commandline arguments.
## PR Checklist
* [x] Closes #998
* [x] I work here
* [x] Tests added/passed
* [x] Requires documentation to be updated
## Validation Steps Performed
There are tests 🎉
Manually added some bindings, they opened the correct profiles in panes/tabs
2019-12-09 14:02:29 +01:00
{ "$ref" : "#/definitions/NewTerminalArgs" } ,
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
{
"properties" : {
Add support for new panes with specifc profiles and other settings overrides (#3825)
## Summary of the Pull Request
This enables the user to set a number of extra settings in the `NewTab` and `SplitPane` `ShortcutAction`s, that enable customizing how a new terminal is created at runtime. The following four properties were added:
* `profile`
* `commandline`
* `tabTitle`
* `startingDirectory`
`profile` can be used with either a GUID or the name of a profile, and the action will launch that profile instead of the default.
`commandline`, `tabTitle`, and `startingDirectory` can all be used to override the profile's values of those settings. This will be more useful for #607.
With this PR, you can make bindings like the following:
```json
{ "keys": ["ctrl+a"], "command": { "action": "splitPane", "split": "vertical" } },
{ "keys": ["ctrl+b"], "command": { "action": "splitPane", "split": "vertical", "profile": "{6239a42c-1111-49a3-80bd-e8fdd045185c}" } },
{ "keys": ["ctrl+c"], "command": { "action": "splitPane", "split": "vertical", "profile": "profile1" } },
{ "keys": ["ctrl+d"], "command": { "action": "splitPane", "split": "vertical", "profile": "profile2" } },
{ "keys": ["ctrl+e"], "command": { "action": "splitPane", "split": "horizontal", "commandline": "foo.exe" } },
{ "keys": ["ctrl+f"], "command": { "action": "splitPane", "split": "horizontal", "profile": "profile1", "commandline": "foo.exe" } },
{ "keys": ["ctrl+g"], "command": { "action": "newTab" } },
{ "keys": ["ctrl+h"], "command": { "action": "newTab", "startingDirectory": "c:\\foo" } },
{ "keys": ["ctrl+i"], "command": { "action": "newTab", "profile": "profile2", "startingDirectory": "c:\\foo" } },
{ "keys": ["ctrl+j"], "command": { "action": "newTab", "tabTitle": "bar" } },
{ "keys": ["ctrl+k"], "command": { "action": "newTab", "profile": "profile2", "tabTitle": "bar" } },
{ "keys": ["ctrl+l"], "command": { "action": "newTab", "profile": "profile1", "tabTitle": "bar", "startingDirectory": "c:\\foo", "commandline":"foo.exe" } }
```
## References
This is a lot of work that was largely started in pursuit of #607. We want people to be able to override these properties straight from the commandline. While they may not make as much sense as keybindings like this, they'll make more sense as commandline arguments.
## PR Checklist
* [x] Closes #998
* [x] I work here
* [x] Tests added/passed
* [x] Requires documentation to be updated
## Validation Steps Performed
There are tests 🎉
Manually added some bindings, they opened the correct profiles in panes/tabs
2019-12-09 14:02:29 +01:00
"action" : { "type" : "string" , "pattern" : "newTab" }
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
}
}
]
} ,
"SwitchToTabAction" : {
"description" : "Arguments corresponding to a Switch To Tab Action" ,
"allOf" : [
{ "$ref" : "#/definitions/ShortcutAction" } ,
{
"properties" : {
"action" : { "type" : "string" , "pattern" : "switchToTab" } ,
"index" : {
"type" : "integer" ,
"default" : 0 ,
"description" : "Which tab to switch to, with the first being 0"
}
}
}
] ,
"required" : [ "index" ]
} ,
"MoveFocusAction" : {
"description" : "Arguments corresponding to a Move Focus Action" ,
"allOf" : [
{ "$ref" : "#/definitions/ShortcutAction" } ,
{
"properties" : {
"action" : { "type" : "string" , "pattern" : "moveFocus" } ,
"direction" : {
"$ref" : "#/definitions/Direction" ,
"default" : "left" ,
"description" : "The direction to move focus in, between panes"
}
}
}
] ,
"required" : [ "direction" ]
} ,
"ResizePaneAction" : {
"description" : "Arguments corresponding to a Resize Pane Action" ,
"allOf" : [
{ "$ref" : "#/definitions/ShortcutAction" } ,
{
"properties" : {
"action" : { "type" : "string" , "pattern" : "resizePane" } ,
"direction" : {
"$ref" : "#/definitions/Direction" ,
"default" : "left" ,
"description" : "The direction to move the pane separator in"
}
}
}
] ,
"required" : [ "direction" ]
} ,
2019-11-28 14:42:15 +01:00
"SplitPaneAction" : {
"description" : "Arguments corresponding to a Split Pane Action" ,
"allOf" : [
{ "$ref" : "#/definitions/ShortcutAction" } ,
Add support for new panes with specifc profiles and other settings overrides (#3825)
## Summary of the Pull Request
This enables the user to set a number of extra settings in the `NewTab` and `SplitPane` `ShortcutAction`s, that enable customizing how a new terminal is created at runtime. The following four properties were added:
* `profile`
* `commandline`
* `tabTitle`
* `startingDirectory`
`profile` can be used with either a GUID or the name of a profile, and the action will launch that profile instead of the default.
`commandline`, `tabTitle`, and `startingDirectory` can all be used to override the profile's values of those settings. This will be more useful for #607.
With this PR, you can make bindings like the following:
```json
{ "keys": ["ctrl+a"], "command": { "action": "splitPane", "split": "vertical" } },
{ "keys": ["ctrl+b"], "command": { "action": "splitPane", "split": "vertical", "profile": "{6239a42c-1111-49a3-80bd-e8fdd045185c}" } },
{ "keys": ["ctrl+c"], "command": { "action": "splitPane", "split": "vertical", "profile": "profile1" } },
{ "keys": ["ctrl+d"], "command": { "action": "splitPane", "split": "vertical", "profile": "profile2" } },
{ "keys": ["ctrl+e"], "command": { "action": "splitPane", "split": "horizontal", "commandline": "foo.exe" } },
{ "keys": ["ctrl+f"], "command": { "action": "splitPane", "split": "horizontal", "profile": "profile1", "commandline": "foo.exe" } },
{ "keys": ["ctrl+g"], "command": { "action": "newTab" } },
{ "keys": ["ctrl+h"], "command": { "action": "newTab", "startingDirectory": "c:\\foo" } },
{ "keys": ["ctrl+i"], "command": { "action": "newTab", "profile": "profile2", "startingDirectory": "c:\\foo" } },
{ "keys": ["ctrl+j"], "command": { "action": "newTab", "tabTitle": "bar" } },
{ "keys": ["ctrl+k"], "command": { "action": "newTab", "profile": "profile2", "tabTitle": "bar" } },
{ "keys": ["ctrl+l"], "command": { "action": "newTab", "profile": "profile1", "tabTitle": "bar", "startingDirectory": "c:\\foo", "commandline":"foo.exe" } }
```
## References
This is a lot of work that was largely started in pursuit of #607. We want people to be able to override these properties straight from the commandline. While they may not make as much sense as keybindings like this, they'll make more sense as commandline arguments.
## PR Checklist
* [x] Closes #998
* [x] I work here
* [x] Tests added/passed
* [x] Requires documentation to be updated
## Validation Steps Performed
There are tests 🎉
Manually added some bindings, they opened the correct profiles in panes/tabs
2019-12-09 14:02:29 +01:00
{ "$ref" : "#/definitions/NewTerminalArgs" } ,
2019-11-28 14:42:15 +01:00
{
"properties" : {
"action" : { "type" : "string" , "pattern" : "splitPane" } ,
"split" : {
"$ref" : "#/definitions/SplitState" ,
2020-01-15 20:55:13 +01:00
"default" : "auto" ,
"description" : "The orientation to split the pane in, either vertical (think [|]), horizontal (think [-]), or auto (splits pane based on remaining space)"
2019-11-28 14:42:15 +01:00
}
}
}
] ,
"required" : [ "split" ]
} ,
2019-09-27 22:38:49 +02:00
"Keybinding" : {
"additionalProperties" : false ,
"properties" : {
"command" : {
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
"description" : "The action executed when the associated key bindings are pressed." ,
"oneOf" : [
{ "$ref" : "#/definitions/CopyAction" } ,
{ "$ref" : "#/definitions/ShortcutActionName" } ,
{ "$ref" : "#/definitions/NewTabAction" } ,
{ "$ref" : "#/definitions/SwitchToTabAction" } ,
{ "$ref" : "#/definitions/MoveFocusAction" } ,
2019-11-28 23:15:16 +01:00
{ "$ref" : "#/definitions/ResizePaneAction" } ,
2019-11-28 14:42:15 +01:00
{ "$ref" : "#/definitions/SplitPaneAction" }
Add support for arbitrary args in keybindings (#3391)
## Summary of the Pull Request
Enables the user to provide arbitrary argument values to shortcut actions through a new `args` member of keybindings. For some keybindings, like `NewTabWithProfile<N>`, we previously needed 9 different `ShortcutAction`s, one for each value of `Index`. If a user wanted to have a `NewTabWithProfile11` keybinding, that was simply impossible. Now that the args are in their own separate json object, each binding can accept any number of arbitrary argument values.
So instead of:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": "newTabProfile0", "keys": ["ctrl+shift+1"] },
{ "command": "newTabProfile1", "keys": ["ctrl+shift+2"] },
{ "command": "newTabProfile2", "keys": ["ctrl+shift+3"] },
{ "command": "newTabProfile3", "keys": ["ctrl+shift+4"] },
```
We can now use:
```json
{ "command": "newTab", "keys": ["ctrl+shift+t"] },
{ "command": { "action": "newTab", "index": 0 }, "keys": ["ctrl+shift+1"] },
{ "command": { "action": "newTab", "index": 1 }, "keys": ["ctrl+shift+2"] },
{ "command": { "action": "newTab", "index": 2 }, "keys": ["ctrl+shift+3"] },
```
Initially, this does seem more verbose. However, for cases where there are multiple args, or there's a large range of values for the args, this will quickly become a more powerful system of expressing keybindings.
The "legacy" keybindings are _left in_ in this PR. They have helper methods to generate appropriate `IActionArgs` values. Prior to releasing 1.0, I think we should remove them, if only to remove some code bloat.
## References
See [the spec](https://github.com/microsoft/terminal/blob/master/doc/specs/%231142%20-%20Keybinding%20Arguments.md) for more details.
This is part two of the implementation, part one was #2446
## PR Checklist
* [x] Closes #1142
* [x] I work here
* [x] Tests added/passed
* [x] Schema updated
## Validation Steps Performed
* Ran Tests
* Removed the legacy keybindings from the `defaults.json`, everything still works
* Tried leaving the legacy keybingings in my `profiles.json`, everything still works.
-------------------------------------------------
* this is a start, but there's a weird linker bug if I take the SetKeybinding(ShortcutAction, KeyChord) implementation out, which I don't totally understand
* a good old-fashioned clean will fix that right up
* all these things work
* hey this actually _functionally_ works
* Mostly cleanup and completion of implementation
* Hey I bet we could just make NewTab the handler for NewTabWithProfile
* Start writing tests for Keybinding args
* Add tests
* Revert a bad sln change, and clean out dead code
* Change to include "command" as a single object
This is a change to make @dhowett-msft happy. Changes the args to be a part
of the "command" object, as opposed to an object on their own.
EX:
```jsonc
// Old style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": { "action": "switchToTab", "index": 0 }, "keys": ["ctrl+alt+1"] },
// new style
{ "command": "switchToTab0", "keys": ["ctrl+1"] },
{ "command": "switchToTab", "args": { "index": 0 } "keys": ["ctrl+alt+1"] },
```
* schemas are hard yo
* Fix the build?
* wonder why my -Wall settings are different than CI...
* this makes me hate things
* Comments from PR
* Add a `Direction::None`
* LOAD BEARING
* add some GH ids to TODOs
* add a comment
* PR nits from carlos
2019-11-14 23:23:40 +01:00
]
2019-09-27 22:38:49 +02:00
} ,
"keys" : {
"description" : "Defines the key combinations used to call the command." ,
"items" : {
"pattern" : "^(?<modifier>(ctrl|alt|shift)\\+?((ctrl|alt|shift)(?<!\\2)\\+?)?((ctrl|alt|shift)(?<!\\2|\\4))?\\+?)?(?<key>[^+\\s]+?)?(?<=[^+\\s])$" ,
"type" : "string"
} ,
"minItems" : 1 ,
"type" : "array"
}
} ,
"required" : [
"command" ,
"keys"
] ,
"type" : "object"
} ,
"Globals" : {
"additionalProperties" : true ,
"description" : "Properties that affect the entire window, regardless of the profile settings." ,
"properties" : {
"alwaysShowTabs" : {
"default" : true ,
"description" : "When set to true, tabs are always displayed. When set to false and showTabsInTitlebar is set to false, tabs only appear after opening a new tab." ,
"type" : "boolean"
} ,
"copyOnSelect" : {
"default" : false ,
"description" : "When set to true, a selection is immediately copied to your clipboard upon creation. When set to false, the selection persists and awaits further action." ,
"type" : "boolean"
} ,
"defaultProfile" : {
"$ref" : "#/definitions/ProfileGuid" ,
"description" : "Sets the default profile. Opens by clicking the '+' icon or typing the key binding assigned to 'newTab'. The guid of the desired default profile is used as the value."
} ,
"initialCols" : {
"default" : 120 ,
"description" : "The number of columns displayed in the window upon first load." ,
"maximum" : 999 ,
"minimum" : 1 ,
"type" : "integer"
} ,
"initialRows" : {
"default" : 30 ,
"description" : "The number of rows displayed in the window upon first load." ,
"maximum" : 999 ,
"minimum" : 1 ,
"type" : "integer"
} ,
2020-01-06 18:39:02 +01:00
"rowsToScroll" : {
"default" : "system" ,
"description" : "The number of rows to scroll at a time with the mouse wheel. This will override the system setting if the value is not zero or 'system'." ,
"maximum" : 999 ,
"minimum" : 0 ,
2020-01-24 20:46:52 +01:00
"type" : [ "integer" , "string" ]
2020-01-06 18:39:02 +01:00
} ,
2019-09-27 22:38:49 +02:00
"keybindings" : {
"description" : "Properties are specific to each custom key binding." ,
"items" : {
"$ref" : "#/definitions/Keybinding"
} ,
"type" : "array"
} ,
"requestedTheme" : {
"default" : "system" ,
"description" : "Sets the theme of the application." ,
"enum" : [
"light" ,
"dark" ,
"system"
] ,
"type" : "string"
} ,
"showTabsInTitlebar" : {
"default" : true ,
"description" : "When set to true, the tabs are moved into the titlebar and the titlebar disappears. When set to false, the titlebar sits above the tabs." ,
"type" : "boolean"
} ,
"showTerminalTitleInTitlebar" : {
"default" : true ,
"description" : "When set to true, titlebar displays the title of the selected tab. When set to false, titlebar displays 'Windows Terminal'." ,
"type" : "boolean"
} ,
2020-01-09 18:19:21 +01:00
"snapToGridOnResize" : {
"default" : false ,
"description" : "When set to `true`, the window will snap to the nearest character boundary on resize. When `false`, the window will resize 'smoothly'" ,
"type" : "boolean"
} ,
2020-01-10 01:16:54 +01:00
"tabWidthMode" : {
"default" : "equal" ,
"description" : "Sets the width of the tabs." ,
"enum" : [
"equal" ,
"titleLength"
] ,
"type" : "string"
} ,
2019-09-27 22:38:49 +02:00
"wordDelimiters" : {
"default" : " ./\\()\"'-:,.;<>~!@#$%^&*|+=[]{}~?│" ,
"description" : "Determines the delimiters used in a double click selection." ,
"type" : "string"
}
} ,
"required" : [
"defaultProfile"
] ,
"type" : "object"
} ,
2019-12-11 01:39:29 +01:00
"Profile" : {
"description" : "Properties specific to a unique profile." ,
"additionalProperties" : false ,
"properties" : {
"acrylicOpacity" : {
"default" : 0.5 ,
"description" : "When useAcrylic is set to true, it sets the transparency of the window for the profile. Accepts floating point values from 0-1 (default 0.5)." ,
"maximum" : 1 ,
"minimum" : 0 ,
"type" : "number"
} ,
"background" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the background color of the profile. Overrides background set in color scheme if colorscheme is set. Uses hex color format: \"#rrggbb\". Default \"#000000\" (black)." ,
"type" : [ "string" , "null" ]
} ,
"backgroundImage" : {
"description" : "Sets the file location of the Image to draw over the window background." ,
"type" : "string"
} ,
"backgroundImageAlignment" : {
"default" : "center" ,
"enum" : [
"bottom" ,
"bottomLeft" ,
"bottomRight" ,
"center" ,
"left" ,
"right" ,
"top" ,
"topLeft" ,
"topRight"
] ,
"type" : "string"
} ,
"backgroundImageOpacity" : {
"description" : "(Not in SettingsSchema.md)" ,
"maximum" : 1 ,
"minimum" : 0 ,
"type" : "number"
} ,
"backgroundImageStretchMode" : {
"default" : "uniformToFill" ,
"description" : "Sets how the background image is resized to fill the window." ,
"enum" : [
"fill" ,
"none" ,
"uniform" ,
"uniformToFill"
] ,
"type" : "string"
} ,
"closeOnExit" : {
"default" : "graceful" ,
"description" : "Sets how the profile reacts to termination or failure to launch. Possible values: \"graceful\" (close when exit is typed or the process exits normally), \"always\" (always close) and \"never\" (never close). true and false are accepted as synonyms for \"graceful\" and \"never\" respectively." ,
"oneOf" : [
{
"enum" : [
"never" ,
"graceful" ,
"always"
] ,
"type" : "string"
} ,
{
"type" : "boolean"
}
]
} ,
"colorScheme" : {
"default" : "Campbell" ,
"description" : "Name of the terminal color scheme to use. Color schemes are defined under \"schemes\"." ,
"type" : "string"
} ,
"colorTable" : {
"description" : "Array of colors used in the profile if colorscheme is not set. Colors use hex color format: \"#rrggbb\". Ordering is as follows: [black, red, green, yellow, blue, magenta, cyan, white, bright black, bright red, bright green, bright yellow, bright blue, bright magenta, bright cyan, bright white]" ,
"items" : {
"additionalProperties" : false ,
"properties" : {
"background" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the background color of the color table."
2019-11-25 23:22:29 +01:00
} ,
2019-12-11 01:39:29 +01:00
"black" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI black."
} ,
"blue" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI blue."
} ,
"brightBlack" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright black."
} ,
"brightBlue" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright blue."
} ,
"brightCyan" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright cyan."
} ,
"brightGreen" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright green."
} ,
"brightPurple" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright purple."
} ,
"brightRed" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright red."
} ,
"brightWhite" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright white."
} ,
"brightYellow" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright yellow."
2019-09-27 22:38:49 +02:00
} ,
2019-12-11 01:39:29 +01:00
"cyan" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI cyan."
} ,
"foreground" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the foreground color of the color table."
} ,
"green" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI green."
} ,
"purple" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI purple."
} ,
"red" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI red."
} ,
"white" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI white."
} ,
"yellow" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI yellow."
}
2019-09-27 22:38:49 +02:00
} ,
2019-12-11 01:39:29 +01:00
"type" : "object"
2019-09-27 22:38:49 +02:00
} ,
2019-12-11 01:39:29 +01:00
"type" : "array"
} ,
"commandline" : {
"description" : "Executable used in the profile." ,
"type" : "string"
} ,
"connectionType" : {
"$ref" : "#/definitions/ProfileGuid" ,
"description" : "A GUID reference to a connection type. Currently undocumented as of 0.3, this is used for Azure Cloud Shell"
} ,
"cursorColor" : {
"$ref" : "#/definitions/Color" ,
"default" : "#FFFFFF" ,
"description" : "Sets the cursor color for the profile. Uses hex color format: \"#rrggbb\"."
} ,
"cursorHeight" : {
"description" : "Sets the percentage height of the cursor starting from the bottom. Only works when cursorShape is set to \"vintage\". Accepts values from 25-100." ,
"maximum" : 100 ,
"minimum" : 25 ,
"type" : "integer"
} ,
"cursorShape" : {
"default" : "bar" ,
"description" : "Sets the cursor shape for the profile. Possible values: \"vintage\" ( ▃ ), \"bar\" ( ┃, default ), \"underscore\" ( ▁ ), \"filledBox\" ( █ ), \"emptyBox\" ( ▯ )" ,
"enum" : [
"bar" ,
"emptyBox" ,
"filledBox" ,
"underscore" ,
"vintage"
] ,
"type" : "string"
} ,
2019-12-12 19:55:26 +01:00
"experimental.retroTerminalEffect" : {
"description" : "When set to true, enable retro terminal effects. This is an experimental feature, and its continued existence is not guaranteed." ,
"type" : "boolean"
} ,
2019-12-11 01:39:29 +01:00
"fontFace" : {
"default" : "Consolas" ,
"description" : "Name of the font face used in the profile." ,
"type" : "string"
} ,
"fontSize" : {
"default" : 12 ,
"description" : "Sets the font size." ,
"minimum" : 1 ,
"type" : "integer"
} ,
"foreground" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the foreground color of the profile. Overrides foreground set in color scheme if colorscheme is set. Uses hex color format: \"#rrggbb\". Default \"#ffffff\" (white)." ,
"type" : [ "string" , "null" ]
} ,
"guid" : {
"$ref" : "#/definitions/ProfileGuid" ,
"description" : "Unique identifier of the profile. Written in registry format: \"{00000000-0000-0000-0000-000000000000}\"."
} ,
"hidden" : {
"default" : false ,
"description" : "If set to true, the profile will not appear in the list of profiles. This can be used to hide default profiles and dynamicially generated profiles, while leaving them in your settings file." ,
"type" : "boolean"
} ,
"historySize" : {
"default" : 9001 ,
"description" : "The number of lines above the ones displayed in the window you can scroll back to." ,
"minimum" : -1 ,
"type" : "integer"
} ,
"icon" : {
"description" : "Image file location of the icon used in the profile. Displays within the tab and the dropdown menu." ,
"type" : "string"
} ,
"name" : {
"description" : "Name of the profile. Displays in the dropdown menu." ,
"minLength" : 1 ,
"type" : "string"
} ,
"padding" : {
"default" : "8, 8, 8, 8" ,
"description" : "Sets the padding around the text within the window. Can have three different formats: \"#\" sets the same padding for all sides, \"#, #\" sets the same padding for left-right and top-bottom, and \"#, #, #, #\" sets the padding individually for left, top, right, and bottom." ,
"pattern" : "^-?[0-9]+(\\.[0-9]+)?( *, *-?[0-9]+(\\.[0-9]+)?|( *, *-?[0-9]+(\\.[0-9]+)?){3})?$" ,
"type" : "string"
} ,
"scrollbarState" : {
"default" : "visible" ,
"description" : "Defines the visibility of the scrollbar." ,
"enum" : [
"visible" ,
"hidden"
] ,
"type" : "string"
2019-09-27 22:38:49 +02:00
} ,
2019-12-11 01:39:29 +01:00
"selectionBackground" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the selection background color of the profile. Overrides selection background set in color scheme if colorscheme is set. Uses hex color format: \"#rrggbb\"."
} ,
"snapOnInput" : {
"default" : true ,
"description" : "When set to true, the window will scroll to the command input line when typing. When set to false, the window will not scroll when you start typing." ,
"type" : "boolean"
} ,
"source" : {
"description" : "Stores the name of the profile generator that originated this profile." ,
"type" : "string"
} ,
"startingDirectory" : {
"description" : "The directory the shell starts in when it is loaded." ,
"type" : "string"
} ,
"suppressApplicationTitle" : {
"description" : "When set to `true`, `tabTitle` overrides the default title of the tab and any title change messages from the application will be suppressed. When set to `false`, `tabTitle` behaves as normal." ,
"type" : "boolean"
} ,
"tabTitle" : {
"description" : "If set, will replace the name as the title to pass to the shell on startup. Some shells (like bash) may choose to ignore this initial value, while others (cmd, powershell) may use this value over the lifetime of the application." ,
"type" : "string"
} ,
"useAcrylic" : {
"default" : false ,
"description" : "When set to true, the window will have an acrylic background. When set to false, the window will have a plain, untextured background." ,
"type" : "boolean"
}
} ,
"type" : "object"
} ,
"ProfileList" : {
"description" : "A list of profiles and the properties specific to each." ,
"items" : {
"$ref" : "#/definitions/Profile" ,
2019-09-27 22:38:49 +02:00
"required" : [
"guid" ,
"name"
2019-12-11 01:39:29 +01:00
]
2019-09-27 22:38:49 +02:00
} ,
"type" : "array"
} ,
2019-12-11 01:39:29 +01:00
"ProfilesObject" : {
"description" : "A list of profiles and default settings that apply to all of them" ,
"properties" : {
"list" : {
"$ref" : "#/definitions/ProfileList"
} ,
"defaults" : {
"description" : "The default settings that apply to every profile." ,
"$ref" : "#/definitions/Profile"
}
2019-12-30 15:15:50 +01:00
} ,
"type" : "object"
2019-12-11 01:39:29 +01:00
} ,
2019-09-27 22:38:49 +02:00
"SchemeList" : {
"description" : "Properties are specific to each color scheme. ColorTool is a great tool you can use to create and explore new color schemes. All colors use hex color format." ,
"items" : {
"additionalProperties" : false ,
"properties" : {
"name" : {
"description" : "Name of the color scheme." ,
"minLength" : 1 ,
"type" : "string"
} ,
"background" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the background color of the color scheme."
} ,
"black" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI black."
} ,
"blue" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI blue."
} ,
"brightBlack" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright black."
} ,
"brightBlue" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright blue."
} ,
"brightCyan" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright cyan."
} ,
"brightGreen" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright green."
} ,
"brightPurple" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright purple."
} ,
"brightRed" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright red."
} ,
"brightWhite" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright white."
} ,
"brightYellow" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI bright yellow."
} ,
"cyan" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI cyan."
} ,
"foreground" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the foreground color of the color scheme."
} ,
"green" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI green."
} ,
"purple" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI purple."
} ,
"red" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI red."
} ,
2019-11-13 19:17:39 +01:00
"selectionBackground" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the selection background color of the color scheme."
} ,
2019-09-27 22:38:49 +02:00
"white" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI white."
} ,
"yellow" : {
"$ref" : "#/definitions/Color" ,
"description" : "Sets the color used as ANSI yellow."
}
} ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"oneOf" : [
{
"allOf" : [
{ "$ref" : "#/definitions/Globals" } ,
{
"additionalItems" : true ,
"properties" : {
2019-12-11 01:39:29 +01:00
"profiles" : {
"oneOf" : [
{ "$ref" : "#/definitions/ProfileList" } ,
{ "$ref" : "#/definitions/ProfilesObject" }
]
} ,
2019-09-27 22:38:49 +02:00
"schemes" : { "$ref" : "#/definitions/SchemeList" }
} ,
"required" : [
"profiles" ,
"schemes" ,
"defaultProfile"
]
}
]
} ,
{
"additionalItems" : false ,
"properties" : {
"globals" : { "$ref" : "#/definitions/Globals" } ,
2019-12-11 01:39:29 +01:00
"profiles" : {
"oneOf" : [
{ "$ref" : "#/definitions/ProfileList" } ,
{ "$ref" : "#/definitions/ProfilesObject" }
]
} ,
2019-09-27 22:38:49 +02:00
"schemes" : { "$ref" : "#/definitions/SchemeList" }
} ,
"required" : [
"profiles" ,
"schemes" ,
"globals"
]
}
]
Enable fullscreen mode (#3408)
## Summary of the Pull Request
Enables the `toggleFullscreen` action to be able to enter fullscreen mode, bound by default to <kbd>alt+enter</kbd>.
The action is bubbled up to the WindowsTerminal (Win32) layer, where the window resizes itself to take the entire size of the monitor.
This largely reuses code from conhost. Conhost already had a fullscreen mode, so I figured I might as well re-use that.
## References
Unfortunately there are still very thin borders around the window when the NonClientIslandWindow is fullscreened. I think I know where the problem is. However, that area of code is about to get a massive overhaul with #3064, so I didn't want to necessarily make it worse right now.
A follow up should be filed to add support for "Always show / reveal / never show tabs in fullscreen mode". Currently, the only mode is "never show tabs".
Additionally, some of this code (particularily re:drawing the nonclient area) could be re-used for #2238.
## PR Checklist
* [x] Closes #531, #3411
* [x] I work here
* [n/a] Tests added/passed 😭
* [x] Requires documentation to be updated
## Validation Steps Performed
* Manually tested both the NonClientIslandWindow and the IslandWindow.
* Cherry-pick commit 8e56bfe
* Don't draw the tab strip when maximized
(cherry picked from commit bac4be7c0f3ed1cdcd4f9ae8980fc98103538613)
* Fix the vista window flash for the NCIW
(cherry picked from commit 7d3a18a893c02bd2ed75026f2aac52e20321a1cf)
* Some code cleanup for review
(cherry picked from commit 9e22b7730bba426adcbfd9e7025f192dbf8efb32)
* A tad bit more notes and cleanup
* Update schema, docs
* Most of the PR comments
* I'm not sure this actually works, so I'm committing it to revert it and check
* Update some comments that were lost.
* Fix a build break?
* oh no
2019-11-05 20:40:29 +01:00
}
