Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spec for global action IDs #6902

Closed

Conversation

zadjii-msft
Copy link
Member

Summary of the Pull Request

⚠️ THIS SPEC IS MERGING INTO #5888 ⚠️ It builds off that one heavily. Go read that one first!

This document is intended to serve as an addition to the [Command Palette Spec],
as well as the [New Tab Menu Customization Spec].

As we come to rely more on actions being a mechanism by which the user defines
"do something in the Terminal", we'll want to make it even easier for users to
re-use the actions that they've already defined, as to reduce duplicated json as
much as possible. This spec proposes a mechanism by which actions could be
uniquely identifiable, so that the user could refer to bindings in other
contexts without needing to replicate an entire json blob.

PR Checklist

Detailed Description of the Pull Request / Additional comments

*** read the spec ***

doc/specs/#6899 - Action IDs/#6899 - Action IDs.md Outdated Show resolved Hide resolved
Comment on lines +106 to +126
```json
{
"newTabMenu": [
{ "type":"action", "id": "Terminal.IncreaseFontSize" },
{ "type":"action", "id": "Terminal.DecreaseFontSize" },
{ "type":"action", "id": "Terminal.ResetFontSize" },
{ "type":"profile", "profile": "cmd" },
{ "type":"profile", "profile": "Windows PowerShell" },
{ "type":"separator" },
{
"type":"folder",
"name": "Settings...",
"icon": "C:\\path\\to\\icon.png",
"entries":[
{ "type":"action", "id": "Terminal.OpenDefaultSettings" },
{ "type":"action", "id": "Terminal.OpenSettings" },
]
}
]
}
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! I love this. It looks a lot cleaner.

@DHowett
Copy link
Member

DHowett commented Jul 13, 2020

This PR is unreviewable for me because it looks like this branch merged master but new-tab-menu didn't

@zadjii-msft
Copy link
Member Author

@DHowett whoops, didn't push my local updates to dev/migrie/s/#1571-new-tab-menu. Should be fixed now.

@DHowett DHowett changed the base branch from dev/migrie/s/#1571-new-tab-menu to master July 13, 2020 19:18
@DHowett DHowett changed the base branch from master to dev/migrie/s/#1571-new-tab-menu July 13, 2020 19:18
@DHowett
Copy link
Member

DHowett commented Jul 13, 2020

double-retargeted the branch, now it looks 💯

@zadjii-msft zadjii-msft added Area-Settings Issues related to settings and customizability, for console or terminal Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs Product-Terminal The new Windows Terminal. labels Jul 14, 2020
@zadjii-msft zadjii-msft changed the base branch from dev/migrie/s/#1571-new-tab-menu to master July 22, 2020 14:55
@zadjii-msft zadjii-msft changed the base branch from master to dev/migrie/s/#1571-new-tab-menu July 22, 2020 14:56
@zadjii-msft zadjii-msft mentioned this pull request Aug 4, 2020
3 tasks
@zadjii-msft
Copy link
Member Author

Moved to #7175

@zadjii-msft zadjii-msft closed this Aug 4, 2020
zadjii-msft added a commit that referenced this pull request Aug 12, 2020
## Summary of the Pull Request

⚠️ This spec has been moved from #6902. That version was branched off the new tab menu customization, and had a terribly convoluted git history. After discussion with the team, we've decided that it's best that this spec is merged atomically _first_, and used as the basis for #5888, as opposed to the other way around.

> This document is intended to serve as an addition to the [Command Palette Spec],
> as well as the [New Tab Menu Customization Spec].
> 
> As we come to rely more on actions being a mechanism by which the user defines
> "do something in the Terminal", we'll want to make it even easier for users to
> re-use the actions that they've already defined, as to reduce duplicated json as
> much as possible. This spec proposes a mechanism by which actions could be
> uniquely identifiable, so that the user could refer to bindings in other
> contexts without needing to replicate an entire json blob.
> 

## PR Checklist
* [x] Specs: #6899
* [x] References: #1571, #1912, #3337, #5025, #5524, #5633
* [x] I work here

## Detailed Description of the Pull Request / Additional comments
_\*<sup>\*</sup><sub>\*</sub> read the spec  <sub>\*</sub><sup>\*</sup>\*_



[Command Palette Spec]: https://github.com/microsoft/terminal/blob/master/doc/specs/%232046%20-%20Command%20Palette.md
[New Tab Menu Customization Spec]: https://github.com/microsoft/terminal/blob/master/doc/specs/%231571%20-%20New%20Tab%20Menu%20Customization.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Settings Issues related to settings and customizability, for console or terminal Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs Product-Terminal The new Windows Terminal.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants