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.

Sign up for GitHub

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

Jump to bottom

Display a warning if a keybinding didn't have a required arg #3522

Closed
zadjii-msft opened this issue Nov 11, 2019 · 0 comments · Fixed by #4746
Closed

Display a warning if a keybinding didn't have a required arg #3522

zadjii-msft opened this issue Nov 11, 2019 · 0 comments · Fixed by #4746
Labels
Area-User Interface Issues pertaining to the user interface of the Console or Terminal Issue-Bug It either shouldn't be doing this or needs an investigation. Priority-3 A description (P3) Product-Terminal The new Windows Terminal. Resolution-Fix-Committed Fix is checked in, but it might be 3-4 weeks until a release.
Milestone
Terminal v1.0

Comments

@zadjii-msft
Copy link
Member

From work in #3391. Some ShortcutActions have required arguments. If a binding has a required arg without a reasonable default value, and the user fails to provide that arg, then we should display a warning dialog.

Case in point, ResizePane and MoveFocus.

related: #3475
@zadjii-msft zadjii-msft added Issue-Bug It either shouldn't be doing this or needs an investigation. Area-User Interface Issues pertaining to the user interface of the Console or Terminal Product-Terminal The new Windows Terminal. Priority-3 A description (P3) labels Nov 11, 2019
@zadjii-msft zadjii-msft added this to the Terminal v1.0 milestone Nov 11, 2019
@ghost ghost added the Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting label Nov 11, 2019
@miniksa miniksa removed the Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting label Nov 11, 2019
zadjii-msft added a commit that referenced this issue Feb 28, 2020
@zadjii-msft
Display these two warning cases
45dc345 
  * When the keybindings are missing required args (#3522)
  * When more than one "keys" aws specified (#4239)
@zadjii-msft zadjii-msft mentioned this issue Feb 28, 2020
Merged
4 tasks
@ghost ghost added the In-PR This issue has a related PR label Feb 28, 2020
@ghost ghost closed this as completed in #4746 Mar 5, 2020
ghost pushed a commit that referenced this issue Mar 5, 2020
Add warning messages for bad keybindings (#4746)
2cba4c6 
## Summary of the Pull Request

Adds warning messages for a pair of keybindings-related scenarios. This covers the following two bugs:
* #4239 - If the user has supplied more than one key chord in their `"keys"` array.
* #3522 - If a keybinding has a _required_ argument, then we'll display a message to the user
  - currently, the only required parameter is the `direction` parameter for both `resizePane` and `moveFocus`

## References

When we get to #1334, we'll want to remove the `TooManyKeysForChord` warning.

## PR Checklist
* [x] Closes #4239
* [x] Closes #3522
* [x] I work here
* [x] Tests added/passed
* [n/a] Requires documentation to be updated

![image](https://user-images.githubusercontent.com/18356694/75593132-f18ec700-5a49-11ea-9d26-6acd0d28b0b7.png)


## Validation Steps Performed
Tested manually, added tests.
@ghost ghost added Resolution-Fix-Committed Fix is checked in, but it might be 3-4 weeks until a release. and removed In-PR This issue has a related PR labels Mar 5, 2020
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area-User Interface Issues pertaining to the user interface of the Console or Terminal Issue-Bug It either shouldn't be doing this or needs an investigation. Priority-3 A description (P3) Product-Terminal The new Windows Terminal. Resolution-Fix-Committed Fix is checked in, but it might be 3-4 weeks until a release.
Projects
None yet
Milestone
Terminal v1.0
Development

Successfully merging a pull request may close this issue.

Add warning messages for bad keybindings microsoft/terminal
3 participants
@miniksa @zadjii-msft @cinnamon-msft