Add soluton command and solution webview provider

Vigilans · Vigilans · commit f23bfa2b9cd7 · 2019-03-07T21:32:33.000+08:00
diff --git a/package.json b/package.json
@@ -103,6 +103,11 @@
                     "dark": "resources/dark/search.svg"
                 }
             },
+            {
+                "command": "leetcode.showSolution",
+                "title": "Show Top Voted Solution",
+                "category": "LeetCode"
+            },
             {
                 "command": "leetcode.testSolution",
                 "title": "Test in LeetCode",
@@ -164,12 +169,21 @@
                     "command": "leetcode.showProblem",
                     "when": "view == leetCodeExplorer && viewItem == problem",
                     "group": "leetcode@1"
+                },
+                {
+                    "command": "leetcode.showSolution",
+                    "when": "view == leetCodeExplorer && viewItem == problem",
+                    "group": "leetcode@2"
                 }
             ],
             "commandPalette": [
                 {
                     "command": "leetcode.showProblem",
                     "when": "never"
+                },
+                {
+                    "command": "leetcode.showSolution",
+                    "when": "never"
                 }
             ],
             "explorer/context": [
diff --git a/src/commands/show.ts b/src/commands/show.ts
@@ -8,6 +8,7 @@ import { LeetCodeNode } from "../explorer/LeetCodeNode";
 import { leetCodeChannel } from "../leetCodeChannel";
 import { leetCodeExecutor } from "../leetCodeExecutor";
 import { leetCodeManager } from "../leetCodeManager";
+import { leetCodeSolutionProvider } from "../leetCodeSolutionProvider";
 import { IProblem, IQuickItemEx, languages, ProblemState } from "../shared";
 import { DialogOptions, DialogType, promptForOpenOutputChannel, promptForSignIn } from "../utils/uiUtils";
 import { selectWorkspaceFolder } from "../utils/workspaceUtils";
@@ -39,18 +40,58 @@ export async function searchProblem(): Promise<void> {
     await showProblemInternal(choice.value);
 }
 
-async function showProblemInternal(node: IProblem): Promise<void> {
+export async function showSolution(node?: LeetCodeNode): Promise<void> {
+    if (!node) {
+        return;
+    }
+    const language: string | undefined = await fetchProblemLanguage();
+    if (!language) {
+        return;
+    }
     try {
-        const leetCodeConfig: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration("leetcode");
-        let defaultLanguage: string | undefined = leetCodeConfig.get<string>("defaultLanguage");
-        if (defaultLanguage && languages.indexOf(defaultLanguage) < 0) {
-            defaultLanguage = undefined;
+        const solution: string = await leetCodeExecutor.showSolution(node, language);
+        await leetCodeSolutionProvider.show(solution);
+    } catch (error) {
+        await promptForOpenOutputChannel("Failed to fetch the top voted solution. Please open the output channel for details.", DialogType.error);
+    }
+}
+
+// SUGGESTION: group config retriving into one file
+async function fetchProblemLanguage(): Promise<string | undefined> {
+    const leetCodeConfig: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration("leetcode");
+    let defaultLanguage: string | undefined = leetCodeConfig.get<string>("defaultLanguage");
+    if (defaultLanguage && languages.indexOf(defaultLanguage) < 0) {
+        defaultLanguage = undefined;
+    }
+    const language: string | undefined = defaultLanguage || await vscode.window.showQuickPick(languages, { placeHolder: "Select the language you want to use" });
+    // fire-and-forget default language query
+    (async (): Promise<void> => {
+        if (!defaultLanguage && leetCodeConfig.get<boolean>("showSetDefaultLanguageHint")) {
+            const choice: vscode.MessageItem | undefined = await vscode.window.showInformationMessage(
+                `Would you like to set '${language}' as your default language?`,
+                DialogOptions.yes,
+                DialogOptions.no,
+                DialogOptions.never,
+            );
+            if (choice === DialogOptions.yes) {
+                leetCodeConfig.update("defaultLanguage", language, true /* UserSetting */);
+            } else if (choice === DialogOptions.never) {
+                leetCodeConfig.update("showSetDefaultLanguageHint", false, true /* UserSetting */);
+            }
         }
-        const language: string | undefined = defaultLanguage || await vscode.window.showQuickPick(languages, { placeHolder: "Select the language you want to use" });
+    })();
+    return language;
+}
+
+async function showProblemInternal(node: IProblem): Promise<void> {
+    try {
+        const language: string | undefined = await fetchProblemLanguage();
         if (!language) {
             return;
         }
 
+        // SUGGESTION: group config retriving into one file
+        const leetCodeConfig: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration("leetcode");
         let outDir: string = await selectWorkspaceFolder();
         let relativePath: string = (leetCodeConfig.get<string>("outputFolder") || "").trim();
         const matchResult: RegExpMatchArray | null = relativePath.match(/\$\{(.*?)\}/);
@@ -69,20 +110,6 @@ async function showProblemInternal(node: IProblem): Promise<void> {
         const originFilePath: string = await leetCodeExecutor.showProblem(node, language, outDir);
         const filePath: string = wsl.useWsl() ? await wsl.toWinPath(originFilePath) : originFilePath;
         await vscode.window.showTextDocument(vscode.Uri.file(filePath), { preview: false });
-
-        if (!defaultLanguage && leetCodeConfig.get<boolean>("showSetDefaultLanguageHint")) {
-            const choice: vscode.MessageItem | undefined = await vscode.window.showInformationMessage(
-                `Would you like to set '${language}' as your default language?`,
-                DialogOptions.yes,
-                DialogOptions.no,
-                DialogOptions.never,
-            );
-            if (choice === DialogOptions.yes) {
-                leetCodeConfig.update("defaultLanguage", language, true /* UserSetting */);
-            } else if (choice === DialogOptions.never) {
-                leetCodeConfig.update("showSetDefaultLanguageHint", false, true /* UserSetting */);
-            }
-        }
     } catch (error) {
         await promptForOpenOutputChannel("Failed to show the problem. Please open the output channel for details.", DialogType.error);
     }
diff --git a/src/extension.ts b/src/extension.ts
@@ -16,6 +16,7 @@ import { leetCodeChannel } from "./leetCodeChannel";
 import { leetCodeExecutor } from "./leetCodeExecutor";
 import { leetCodeManager } from "./leetCodeManager";
 import { leetCodeResultProvider } from "./leetCodeResultProvider";
+import { leetCodeSolutionProvider } from "./leetCodeSolutionProvider";
 import { leetCodeStatusBarItem } from "./leetCodeStatusBarItem";
 
 export async function activate(context: vscode.ExtensionContext): Promise<void> {
@@ -30,11 +31,13 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
 
     const leetCodeTreeDataProvider: LeetCodeTreeDataProvider = new LeetCodeTreeDataProvider(context);
     leetCodeResultProvider.initialize(context);
+    leetCodeSolutionProvider.initialize(context);
 
     context.subscriptions.push(
         leetCodeStatusBarItem,
         leetCodeChannel,
         leetCodeResultProvider,
+        leetCodeSolutionProvider,
         vscode.window.registerTreeDataProvider("leetCodeExplorer", leetCodeTreeDataProvider),
         vscode.languages.registerCodeLensProvider({ scheme: "file" }, codeLensProvider),
         vscode.commands.registerCommand("leetcode.deleteCache", () => cache.deleteCache()),
@@ -45,6 +48,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
         vscode.commands.registerCommand("leetcode.createSession", () => session.createSession()),
         vscode.commands.registerCommand("leetcode.showProblem", (node: LeetCodeNode) => show.showProblem(node)),
         vscode.commands.registerCommand("leetcode.searchProblem", () => show.searchProblem()),
+        vscode.commands.registerCommand("leetcode.showSolution", (node: LeetCodeNode) => show.showSolution(node)),
         vscode.commands.registerCommand("leetcode.refreshExplorer", () => leetCodeTreeDataProvider.refresh()),
         vscode.commands.registerCommand("leetcode.testSolution", (uri?: vscode.Uri) => test.testSolution(uri)),
         vscode.commands.registerCommand("leetcode.submitSolution", (uri?: vscode.Uri) => submit.submitSolution(uri)),
diff --git a/src/leetCodeExecutor.ts b/src/leetCodeExecutor.ts
@@ -48,10 +48,12 @@ class LeetCodeExecutor {
             }
             return false;
         }
-        try { // Check company plugin
-            await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "plugin", "-e", "company"]);
-        } catch (error) { // Download company plugin and activate
-            await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "plugin", "-i", "company"]);
+        for (const plugin of ["company", "solution.discuss"]) {
+            try { // Check plugin
+                await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "plugin", "-e", plugin]);
+            } catch (error) { // Download plugin and activate
+                await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "plugin", "-i", plugin]);
+            }
         }
         return true;
     }
@@ -87,6 +89,11 @@ class LeetCodeExecutor {
         return filePath;
     }
 
+    public async showSolution(node: IProblem, language: string): Promise<string> {
+        const solution: string = await this.executeCommandWithProgressEx("Fetching top voted solution from discussions...", "node", [await this.getLeetCodeBinaryPath(), "show", node.id, "--solution", "-l", language]);
+        return solution;
+    }
+
     public async listSessions(): Promise<string> {
         return await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "session"]);
     }
diff --git a/src/leetCodeSolutionProvider.ts b/src/leetCodeSolutionProvider.ts
@@ -0,0 +1,54 @@
+// Copyright (c) jdneo. All rights reserved.
+// Licensed under the MIT license.
+
+import { Disposable, ExtensionContext, ViewColumn, WebviewPanel, window } from "vscode";
+
+class LeetCodeSolutionProvider implements Disposable {
+
+    private context: ExtensionContext;
+    private panel: WebviewPanel | undefined;
+
+    public initialize(context: ExtensionContext): void {
+        this.context = context;
+    }
+
+    public async show(result: string): Promise<void> {
+        if (!this.panel) {
+            this.panel = window.createWebviewPanel("leetCode", "LeetCode Top Voted Solution", ViewColumn.Active, {
+                retainContextWhenHidden: true,
+                enableFindWidget: true,
+            });
+
+            this.panel.onDidDispose(() => {
+                this.panel = undefined;
+            }, null, this.context.subscriptions);
+        }
+
+        this.panel.webview.html = this.getWebViewContent(result);
+        this.panel.reveal(ViewColumn.Active);
+    }
+
+    public dispose(): void {
+        if (this.panel) {
+            this.panel.dispose();
+        }
+    }
+
+    private getWebViewContent(result: string): string {
+        return `
+            <!DOCTYPE html>
+            <html lang="en">
+            <head>
+                <meta charset="UTF-8">
+                <meta name="viewport" content="width=device-width, initial-scale=1.0">
+                <title>LeetCode Top Voted Solution</title>
+            </head>
+            <body>
+                <pre>${result.trim()}</pre>
+            </body>
+            </html>
+        `;
+    }
+}
+
+export const leetCodeSolutionProvider: LeetCodeSolutionProvider = new LeetCodeSolutionProvider();

Original file line number	Diff line number	Diff line change
`@@ -48,10 +48,12 @@ class LeetCodeExecutor {`
`48`	`48`	`}`
`49`	`49`	`return false;`
`50`	`50`	`}`
`51`		`- try { // Check company plugin`
`52`		`- await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "plugin", "-e", "company"]);`
`53`		`- } catch (error) { // Download company plugin and activate`
`54`		`- await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "plugin", "-i", "company"]);`
	`51`	`+ for (const plugin of ["company", "solution.discuss"]) {`
	`52`	`+ try { // Check plugin`
	`53`	`+ await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "plugin", "-e", plugin]);`
	`54`	`+ } catch (error) { // Download plugin and activate`
	`55`	`+ await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "plugin", "-i", plugin]);`
	`56`	`+ }`
`55`	`57`	`}`
`56`	`58`	`return true;`
`57`	`59`	`}`
`@@ -87,6 +89,11 @@ class LeetCodeExecutor {`
`87`	`89`	`return filePath;`
`88`	`90`	`}`
`89`	`91`
	`92`	`+ public async showSolution(node: IProblem, language: string): Promise<string> {`
	`93`	`+ const solution: string = await this.executeCommandWithProgressEx("Fetching top voted solution from discussions...", "node", [await this.getLeetCodeBinaryPath(), "show", node.id, "--solution", "-l", language]);`
	`94`	`+ return solution;`
	`95`	`+ }`
	`96`	`+`
`90`	`97`	`public async listSessions(): Promise<string> {`
`91`	`98`	`return await this.executeCommandEx("node", [await this.getLeetCodeBinaryPath(), "session"]);`
`92`	`99`	`}`