update

Author: ccagml

package-lock.json

@@ -9,10 +9,16 @@
 
 import { eventService } from "../service/EventService";
 // 事件的控制器
+/* The EventController class has a method called add_event that calls the add_event method on the
+eventService class */
 class EventContorller {
   /**
    * 监听事件
    */
+  /**
+   * The function `add_event()` is a public function that calls the `add_event()` function in the
+   * `eventService` service
+   */
   public add_event() {
     eventService.add_event();
   }

src/controller/EventController.ts

@@ -10,6 +10,7 @@
 import { ConfigurationChangeEvent, Disposable, languages, workspace } from "vscode";
 import { fileButtonService } from "../service/FileButtonService";
 // 文件按钮的控制器
+/* It listens to configuration changes and refreshes the file button service */
 class FileButtonController implements Disposable {
   private registeredProvider: Disposable | undefined;
   private configurationChangeListener: Disposable;

src/controller/FileButtonController.ts

@@ -23,6 +23,7 @@ import { getLeetCodeEndpoint } from "../utils/ConfigUtils";
 class LoginContorller {
   constructor() {}
 
+  /* A login function. */
   // 登录操作
   public async signIn(): Promise<void> {
     const picks: Array<IQuickItemEx<string>> = [];
@@ -165,6 +166,9 @@ class LoginContorller {
   }
 
   // 登出
+  /**
+   * It signs out the user
+   */
   public async signOut(): Promise<void> {
     try {
       await executeService.signOut();
@@ -176,11 +180,18 @@ class LoginContorller {
   }
 
   // 获取登录状态
+  /**
+   * It returns the login status of the user.
+   * @returns The login status of the user.
+   */
   public async getLoginStatus() {
     return await statusBarService.getLoginStatus();
   }
 
   // 删除所有缓存
+  /**
+   * It signs out, removes old cache, switches to the default endpoint, and refreshes the tree data
+   */
   public async deleteAllCache(): Promise<void> {
     await this.signOut();
     await executeService.removeOldCache();

src/controller/LoginController.ts

@@ -59,6 +59,9 @@ class MainContorller {
   }
 
   // 删除缓存
+/**
+ * It deletes the cache.
+ */
   public async deleteCache() {
     await executeService.deleteCache();
   }

src/controller/MainController.ts

@@ -80,6 +80,11 @@ class TreeViewController implements Disposable {
   private waitUserContest: boolean;
 
   // 获取当前文件的路径
+  /**
+   * It returns the path of the currently active file, or undefined if there is no active file
+   * @param [uri] - The file path to open.
+   * @returns A promise that resolves to a string or undefined.
+   */
   public async getActiveFilePath(uri?: vscode.Uri): Promise<string | undefined> {
     let textEditor: vscode.TextEditor | undefined;
     if (uri) {
@@ -103,6 +108,13 @@ class TreeViewController implements Disposable {
   }
 
   // 提交问题
+  /**
+   * It gets the active file path, then submits the solution to the server, and finally refreshes the
+   * tree view
+   * @param [uri] - The URI of the file to be submitted. If not provided, the currently active file will
+   * be submitted.
+   * @returns A promise that resolves to a string.
+   */
   public async submitSolution(uri?: vscode.Uri): Promise<void> {
     if (!statusBarService.getUser()) {
       promptForSignIn();
@@ -127,6 +139,11 @@ class TreeViewController implements Disposable {
   }
 
   // 提交测试用例
+  /**
+   * It takes the current file, and sends it to the server to be tested
+   * @param [uri] - The file path of the file to be submitted. If it is not passed, the currently active
+   * file is submitted.
+   */
   public async testSolution(uri?: vscode.Uri): Promise<void> {
     try {
       if (statusBarService.getStatus() === UserStatus.SignedOut) {
@@ -217,6 +234,13 @@ class TreeViewController implements Disposable {
       await promptForOpenOutputChannel("提交测试出错了. 请查看控制台信息~", DialogType.error);
     }
   }
+  /**
+   * "Show a file selection dialog, and return the selected file's URI."
+   *
+   * The function is async, so it returns a promise
+   * @param {string} [fsPath] - The path of the file that is currently open in the editor.
+   * @returns An array of file URIs or undefined.
+   */
   public async showFileSelectDialog(fsPath?: string): Promise<vscode.Uri[] | undefined> {
     const defaultUri: vscode.Uri | undefined = this.getBelongingWorkspaceFolderUri(fsPath);
     const options: vscode.OpenDialogOptions = {
@@ -229,6 +253,14 @@ class TreeViewController implements Disposable {
     return await vscode.window.showOpenDialog(options);
   }
 
+  /**
+   * It gets the active file path, and then calls the executeService.testSolution function to test the
+   * solution
+   * @param [uri] - The path of the file to be submitted. If it is not passed, the currently active file
+   * is submitted.
+   * @param {boolean} [allCase] - Whether to submit all cases.
+   * @returns a promise that resolves to void.
+   */
   public async testSolutionDefault(uri?: vscode.Uri, allCase?: boolean): Promise<void> {
     try {
       if (statusBarService.getStatus() === UserStatus.SignedOut) {
@@ -251,6 +283,15 @@ class TreeViewController implements Disposable {
     }
   }
 
+  /**
+   * It gets the active file path, then calls the executeService.testSolution function to test the
+   * solution
+   * @param [uri] - The file path of the file to be submitted. If it is not passed in, the currently
+   * active file is submitted.
+   * @param {string} [testcase] - The test case to be tested. If it is not specified, the test case will
+   * be randomly selected.
+   * @returns a promise that resolves to void.
+   */
   public async testSolutionArea(uri?: vscode.Uri, testcase?: string): Promise<void> {
     try {
       if (statusBarService.getStatus() === UserStatus.SignedOut) {
@@ -273,6 +314,13 @@ class TreeViewController implements Disposable {
     }
   }
 
+  /**
+   * "If the ComSpec environment variable is not set, or if it is set to cmd.exe, then return true."
+   *
+   * The ComSpec environment variable is set to the path of the command processor. On Windows, this is
+   * usually cmd.exe. On Linux, it is usually bash
+   * @returns A boolean value.
+   */
   public usingCmd(): boolean {
     const comSpec: string | undefined = process.env.ComSpec;
     // 'cmd.exe' is used as a fallback if process.env.ComSpec is unavailable.
@@ -286,6 +334,12 @@ class TreeViewController implements Disposable {
     return false;
   }
 
+  /**
+   * If you're on Windows, and you're using cmd.exe, then you need to escape double quotes with
+   * backslashes. Otherwise, you don't
+   * @param {string} test - The test string to be parsed.
+   * @returns a string.
+   */
   public parseTestString(test: string): string {
     if (systemUtils.useWsl() || !systemUtils.isWindows()) {
       if (systemUtils.useVscodeNode()) {
@@ -310,6 +364,10 @@ class TreeViewController implements Disposable {
     }
   }
 
+  /**
+   * It switches the endpoint of LeetCode, and then signs out and signs in again
+   * @returns a promise that resolves to a void.
+   */
   public async switchEndpoint(): Promise<void> {
     const isCnEnabled: boolean = getLeetCodeEndpoint() === Endpoint.LeetCodeCN;
     const picks: Array<IQuickItemEx<string>> = [];
@@ -350,6 +408,11 @@ class TreeViewController implements Disposable {
     }
   }
 
+  /**
+   * It shows a quick pick menu with the available sorting strategies, and if the user selects one, it
+   * updates the sorting strategy and refreshes the tree view
+   * @returns A promise that resolves to a void.
+   */
   public async switchSortingStrategy(): Promise<void> {
     const currentStrategy: SortingStrategy = getSortingStrategy();
     const picks: Array<IQuickItemEx<string>> = [];
@@ -371,6 +434,10 @@ class TreeViewController implements Disposable {
     await treeDataService.refresh();
   }
 
+  /**
+   * It adds a node to the user's favorites
+   * @param {NodeModel} node - NodeModel
+   */
   public async addFavorite(node: NodeModel): Promise<void> {
     try {
       await executeService.toggleFavorite(node, true);
@@ -383,6 +450,10 @@ class TreeViewController implements Disposable {
     }
   }
 
+  /**
+   * It removes a node from the user's favorites
+   * @param {NodeModel} node - The node that is currently selected in the tree.
+   */
   public async removeFavorite(node: NodeModel): Promise<void> {
     try {
       await executeService.toggleFavorite(node, false);
@@ -395,6 +466,10 @@ class TreeViewController implements Disposable {
     }
   }
 
+  /**
+   * It returns a list of problems
+   * @returns An array of problems.
+   */
   public async listProblems(): Promise<IProblem[]> {
     try {
       if (statusBarService.getStatus() === UserStatus.SignedOut) {

src/controller/TreeViewController.ts

@@ -13,6 +13,7 @@ import { storageUtils } from "../utils/storageUtils";
 import { commUtils } from "../utils/commUtils";
 import { ChainNodeBase } from "./chainNodeBase";
 
+/* It's a class that manages a chain of plugins */
 export class ChainManager {
   id;
   name;
@@ -25,10 +26,19 @@ export class ChainManager {
 
   constructor() {}
 
+  /**
+   * Return the head of the chain.
+   * @returns The head of the chain.
+   */
   public getChainHead(): ChainNodeBase {
     return this.head;
   }
 
+  /**
+   * It loads all the plugins in the directory and initializes them.
+   * @param {ChainNodeBase | undefined} head - The first node in the chain of responsibility.
+   * @returns The return value is a boolean.
+   */
   public init(head: ChainNodeBase | undefined): Object | undefined {
     if (head) {
       this.head = head;
@@ -72,6 +82,9 @@ export class ChainManager {
     return true;
   }
 
+  /**
+   * For each plugin in the plugins array, call the save function.
+   */
   public save_all(): void {
     for (let p of this.plugins) {
       p.save();

src/rpc/actionChain/chainManager.ts

@@ -15,6 +15,7 @@ import { storageUtils } from "../../utils/storageUtils";
 import { commUtils } from "../../utils/commUtils";
 import { sessionUtils } from "../../utils/sessionUtils";
 
+/* It's a plugin that caches the data it gets from the next plugin in the chain */
 class CachePlugin extends ChainNodeBase {
   id = 50;
   name = "cache";
@@ -23,6 +24,7 @@ class CachePlugin extends ChainNodeBase {
     super();
   }
 
+  /* Checking if the translation config has changed. If it has, it clears the cache. */
   clearCacheIfTchanged = (needTranslation) => {
     const translationConfig = storageUtils.getCache(commUtils.KEYS.translation);
     if (!translationConfig || translationConfig["useEndpointTranslation"] != needTranslation) {
@@ -33,6 +35,8 @@ class CachePlugin extends ChainNodeBase {
     }
   };
 
+  /* A method that is used to get problems from the cache. If the cache is empty, it will get the
+problems from the next layer. */
   public getProblems = (needTranslation, cb) => {
     this.clearCacheIfTchanged(needTranslation);
     const problems = storageUtils.getCache(commUtils.KEYS.problems);
@@ -46,9 +50,9 @@ class CachePlugin extends ChainNodeBase {
     });
   };
 
-  /**
-   * getRatingOnline
-   */
+  /* A method that is used to get problems from the cache. If the cache is empty, it will get the
+problems from the next layer. */
+
   public getRatingOnline = (cb) => {
     const cacheRantingData = storageUtils.getCache(commUtils.KEYS.ranting_path);
     if (cacheRantingData) {
@@ -67,6 +71,7 @@ class CachePlugin extends ChainNodeBase {
     });
   };
 
+  /* A cache layer for the getProblem function. */
   public getProblem = (problem, needTranslation, cb) => {
     this.clearCacheIfTchanged(needTranslation);
     const k = commUtils.KEYS.problem(problem);
@@ -95,6 +100,7 @@ class CachePlugin extends ChainNodeBase {
     return storageUtils.setCache(commUtils.KEYS.problem(problem), _problem);
   };
 
+  /* Updating the problem in the cache. */
   updateProblem = (problem, kv) => {
     const problems = storageUtils.getCache(commUtils.KEYS.problems);
     if (!problems) return false;
@@ -106,6 +112,7 @@ class CachePlugin extends ChainNodeBase {
     return storageUtils.setCache(commUtils.KEYS.problems, problems);
   };
 
+  /* Logging out the user and then logging in the user. */
   login = (user, cb) => {
     this.logout(user, false);
     this.next.login(user, function (e, user) {
@@ -115,10 +122,10 @@ class CachePlugin extends ChainNodeBase {
     });
   };
 
+  /* Logging out the user and then logging in the user. */
   logout = (user, purge) => {
     if (!user) user = sessionUtils.getUser();
     if (purge) sessionUtils.deleteUser();
-    // NOTE: need invalidate any user related cache
     sessionUtils.deleteCodingSession();
     return user;
   };