Provide several hints for better user experience #293
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jdneo
reviewed
Apr 27, 2019
src/commands/show.ts
Outdated
| "commentDescription", | ||
| 'You can generate problem description as comment in the solution code file by enabling "leetcode.showCommentDescription".', | ||
| "Open configuration", | ||
| (): Thenable<any> => vscode.commands.executeCommand("workbench.action.openSettings", "leetcode.showCommentDescription"), |
There was a problem hiding this comment.
We can wrap a method for opening the setting, like
openSettingView(section?: string)
| "commandShortcut", | ||
| 'You can configure custom key bindings with "test", "submit" or any other command in Preferences > Keyboard Shortcuts.', | ||
| "Open Keybindings", | ||
| (): Thenable<any> => commands.executeCommand("workbench.action.openGlobalKeybindings", "leetcode solution"), |
There was a problem hiding this comment.
Same above, wrap a method, like openKeyBindingView(section?: string)
src/utils/uiUtils.ts
Outdated
| @@ -57,6 +58,20 @@ export async function promptForSignIn(): Promise<void> { | |||
| } | |||
| } | |||
|
|
|||
| export async function promptHintMessage(config: string, message: string, choiceConfirm: string, onConfirm: () => Thenable<any>): Promise<void> { | |||
| if (getWorkspaceConfiguration().get<boolean>(`hint.${config}`)) { | |||
There was a problem hiding this comment.
Just pass the entire hint.${config} to the method instead of only the ${config} itself since we may have other setting section in the future.
jdneo
reviewed
Apr 28, 2019
src/commands/show.ts
Outdated
| @@ -120,6 +118,12 @@ async function showProblemInternal(node: IProblem): Promise<void> { | |||
| await Promise.all([ | |||
| vscode.window.showTextDocument(vscode.Uri.file(filePath), { preview: false, viewColumn: vscode.ViewColumn.One }), | |||
| movePreviewAsideIfNeeded(node), | |||
| promptHintMessage( | |||
| "hint.commentDescription", | |||
| 'You can generate problem description as comment in the solution code file by enabling "leetcode.showCommentDescription".', | |||
There was a problem hiding this comment.
You can generate the code file with problem description in the comments by .....
src/utils/uiUtils.ts
Outdated
| await vscode.commands.executeCommand("workbench.action.openGlobalKeybindings", query); | ||
| } | ||
|
|
||
|
|
| private async showKeybindingsHint(): Promise<void> { | ||
| await promptHintMessage( | ||
| "hint.commandShortcut", | ||
| 'You can configure custom key bindings with "test", "submit" or any other command in Preferences > Keyboard Shortcuts.', |
There was a problem hiding this comment.
You can customize the shortcut key bindings in Preferences > Keyboard Shortcuts.
jdneo
approved these changes
Apr 28, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduction
Uniform hint settings:
Demonstration
Config WebView Markdown
Shown upon any webview revealed:
Comment Description
Shown upon code file opened:
Command Shortcut
Shown upon submission webview revealed:
NOTE
User experience could be more better for the future update of vscode:
When executing
workbench.action.openSettingscommand, it can receive arguments as search query, making the hint able to guide the users directly to the specific configs:microsoft/vscode#72352
microsoft/vscode@e5c1c22#diff-dfd9031c00a144c2364595f331243744
Query as args when opening Keybindings Editor is underway:
microsoft/vscode#72878