feat: Customize the shortcuts in editor (LeetCode-OpenSource#340)

Author: jdneo

package.json

@@ -331,7 +331,25 @@
                         "type": "boolean",
                         "default": true,
                         "scope": "application",
-                        "description": "Show the submit and test shortcuts in editor or not."
+                        "description": "[Deprecated] Show the submit and test shortcuts in editor or not."
+                    },
+                    "leetcode.editor.shortcuts": {
+                        "type": "array",
+                        "default": [
+                            "submit",
+                            "test"
+                        ],
+                        "scope": "application",
+                        "items": {
+                            "type": "string",
+                            "enum": [
+                                "submit",
+                                "test",
+                                "solution",
+                                "description"
+                            ]
+                        },
+                        "description": "Customize the shorcuts in editor."
                     },
                     "leetcode.enableSideMode": {
                         "type": "boolean",

src/codelens/CodeLensController.ts

@@ -15,6 +15,8 @@ class CodeLensController implements Disposable {
         this.configurationChangeListener = workspace.onDidChangeConfiguration((event: ConfigurationChangeEvent) => {
             if (event.affectsConfiguration("leetcode.enableShortcuts")) {
                 this.setCodeLensVisibility();
+            } else if (event.affectsConfiguration("leetcode.editor.shortcuts")) {
+                this.internalProvider.refresh();
             }
         }, this);
 

src/codelens/CustomCodeLensProvider.ts

@@ -2,41 +2,67 @@
 // Licensed under the MIT license.
 
 import * as vscode from "vscode";
+import { getEditorShortcuts } from "../utils/settingUtils";
 
 export class CustomCodeLensProvider implements vscode.CodeLensProvider {
 
-    private validFileNamePattern: RegExp = /\d+\..*\.(.+)/;
+    private onDidChangeCodeLensesEmitter: vscode.EventEmitter<void> = new vscode.EventEmitter<void>();
+
+    get onDidChangeCodeLenses(): vscode.Event<void> {
+        return this.onDidChangeCodeLensesEmitter.event;
+    }
+
+    public refresh(): void {
+        this.onDidChangeCodeLensesEmitter.fire();
+    }
 
     public provideCodeLenses(document: vscode.TextDocument): vscode.ProviderResult<vscode.CodeLens[]> {
+        const shortcuts: string[] = getEditorShortcuts();
+        if (!shortcuts) {
+            return;
+        }
+
         const fileName: string = document.fileName.trim();
-        const matchResult: RegExpMatchArray | null = fileName.match(this.validFileNamePattern);
+        const matchResult: RegExpMatchArray | null = fileName.match(/\d+\..*\.(.+)/);
         if (!matchResult) {
             return undefined;
         }
 
         const range: vscode.Range = new vscode.Range(document.lineCount - 1, 0, document.lineCount - 1, 0);
+        const codeLens: vscode.CodeLens[] = [];
 
-        return [
-            new vscode.CodeLens(range, {
+        if (shortcuts.indexOf("submit") >= 0) {
+            codeLens.push(new vscode.CodeLens(range, {
                 title: "Submit",
                 command: "leetcode.submitSolution",
                 arguments: [document.uri],
-            }),
-            new vscode.CodeLens(range, {
+            }));
+        }
+
+        if (shortcuts.indexOf("test") >= 0) {
+            codeLens.push(new vscode.CodeLens(range, {
                 title: "Test",
                 command: "leetcode.testSolution",
                 arguments: [document.uri],
-            }),
-            new vscode.CodeLens(range, {
+            }));
+        }
+
+        if (shortcuts.indexOf("solution") >= 0) {
+            codeLens.push(new vscode.CodeLens(range, {
                 title: "Solution",
                 command: "leetcode.showSolution",
                 arguments: [document.uri],
-            }),
-            new vscode.CodeLens(range, {
-                title: "Preview",
+            }));
+        }
+
+        if (shortcuts.indexOf("description") >= 0) {
+            codeLens.push(new vscode.CodeLens(range, {
+                title: "Description",
                 command: "leetcode.previewProblem",
                 arguments: [document.uri],
-            }),
-        ];
+            }));
+        }
+
+        return codeLens;
     }
 }

src/utils/settingUtils.ts

@@ -10,3 +10,7 @@ export function getWorkspaceConfiguration(): WorkspaceConfiguration {
 export function shouldHideSolvedProblem(): boolean {
     return getWorkspaceConfiguration().get<boolean>("hideSolved", false);
 }
+
+export function getEditorShortcuts(): string[] {
+    return getWorkspaceConfiguration().get<string[]>("editor.shortcuts", ["submit", "test"]);
+}