refactor: show notification when empty key

Author: bankjirapan

src/api.ts

@@ -33,7 +33,6 @@ async function postProof(text: string, apiKey: string): Promise<ApiResponse> {
       updateEmoji("$(debug-disconnect)");
       throw new Error("NetworkError");
     }
-    console.log("API Key: ", apiKey);
     const response = await fetch("https://api.longdo.com/spell-checker/proof", {
       method: "POST",
       headers: {

src/extension.ts

@@ -6,9 +6,13 @@ import { ErrorsResult } from "./interface/types";
 import { Diagnostics } from "./diagnostics";
 import { Configuration } from "./configuration";
 import { showStatusBar, updateEmoji } from "./statusbar";
+import { showErrorAPIKey, showWarningAPIKey } from "./notification";
 
 let errorsResult: ErrorsResult[] = [];
 let markCheckList: ErrorsResult[] = [];
+let checkCountWithDefaultKey = 0;
+const DEFAULT_API_KEY = "longdospellcheckervscodedemo";
+const NOTIFICATION_THRESHOLD = 3;
 
 export function activate(context: vscode.ExtensionContext) {
   showStatusBar(context);
@@ -171,10 +175,6 @@ export function activate(context: vscode.ExtensionContext) {
   context.subscriptions.push(listenerDocumentSaved());
 }
 
-let checkCountWithDefaultKey = 0;
-const DEFAULT_API_KEY = "longdospellcheckervscodedemo";
-const NOTIFICATION_THRESHOLD = 3;
-
 async function onSpellCheck() {
   errorsResult = [];
   Diagnostics.clearDiagnostics();
@@ -192,19 +192,7 @@ async function onSpellCheck() {
     checkCountWithDefaultKey++;
 
     if (checkCountWithDefaultKey >= NOTIFICATION_THRESHOLD) {
-      const action = await vscode.window.showWarningMessage(
-        "You're using the default API key. For best results, please set your own API key.",
-        "Set API Key", "Get API Key", "Dismiss"
-      );
-      
-      if (action === "Set API Key") {
-        vscode.commands.executeCommand(Command.OpenSetKey);
-        return;
-      } else if (action === "Get API Key") {
-        vscode.commands.executeCommand(Command.openWebAPI);
-        return;
-      }
-      
+      showWarningAPIKey();
       checkCountWithDefaultKey = 0; 
     }
   }
@@ -213,7 +201,14 @@ async function onSpellCheck() {
   await textProcessor.processDocument({ document });
 
   try {
-    let results = await spellCheckPromises(apiKey);
+    const textData = await textProcessor.getTextData();
+    if (textData.length === 0) {
+      return;
+    }
+    if (textData.length >= 3 && apiKey === DEFAULT_API_KEY) {
+      showWarningAPIKey();
+    }
+    let results = await spellCheckPromises(apiKey, textData);
     results = results.filter(
       (error) => !markCheckList.some((mark) => mark.word === error.word)
     );
@@ -231,20 +226,9 @@ async function onSpellCheck() {
         ? error.message
         : "An error occurred while checking spelling.";
     const isErrorNetwork = errorMessage.includes("NetworkError");
-
     const errorApiKeyEmpty = errorMessage.includes("API key is not set");
     if (errorApiKeyEmpty) {
-      const actionItems = ["Yes", "No", "Get API Key"];
-      const notification = await vscode.window.showWarningMessage(
-        "API key is not set. Do you want to set it now?",
-        ...actionItems
-      );
-
-      if (notification === "Yes") {
-        vscode.commands.executeCommand(Command.OpenSetKey);
-      } else if (notification === "Get API Key") {
-        vscode.commands.executeCommand(Command.openWebAPI);
-      }
+      showErrorAPIKey();
       return;
     }
 

src/notification.ts

@@ -0,0 +1,33 @@
+import * as vscode from "vscode";
+import { Command } from "./command";
+
+export async function showWarningAPIKey() {
+  const action = await vscode.window.showWarningMessage(
+    "You're using the default API key. For best results, please set your own API key.",
+    "Set API Key",
+    "Get API Key",
+    "Dismiss"
+  );
+
+  if (action === "Set API Key") {
+    vscode.commands.executeCommand(Command.OpenSetKey);
+    return;
+  } else if (action === "Get API Key") {
+    vscode.commands.executeCommand(Command.openWebAPI);
+    return;
+  }
+}
+
+export async function showErrorAPIKey() {
+  const actionItems = ["Yes", "No", "Get API Key"];
+  const notification = await vscode.window.showWarningMessage(
+    "API key is not set. Do you want to set it now?",
+    ...actionItems
+  );
+
+  if (notification === "Yes") {
+    vscode.commands.executeCommand(Command.OpenSetKey);
+  } else if (notification === "Get API Key") {
+    vscode.commands.executeCommand(Command.openWebAPI);
+  }
+}

src/spell.ts

@@ -1,5 +1,5 @@
 import { postProof } from "./api";
-import { Position, ProofResponse } from "./interface/types";
+import { Position, ProofResponse, TextIndex } from "./interface/types";
 import { textProcessor } from "./text";
 
 type SpellCheckResult = ProofResponse & { originalPosition: Position };
@@ -8,27 +8,33 @@ type SpellCheckResult = ProofResponse & { originalPosition: Position };
  * Performs spell checking on all processed text segments
  * @returns Promise resolving to an array of spell check results with their original positions
  */
-export async function spellCheckPromises(apiKey: string): Promise<SpellCheckResult[]> {
+export async function spellCheckPromises(
+  apiKey: string,
+  textData: { text: string; indices: TextIndex[] }[] = []
+): Promise<SpellCheckResult[]> {
   try {
-    const textData = textProcessor.getTextData();
-    
     const spellCheckPromises = textData.map(async (data) => {
-      const spell = await postProof(data.text,apiKey );
+      const spell = await postProof(data.text, apiKey);
       const results = spell?.result || [];
 
       return results
         .map((item: ProofResponse) => ({
           ...item,
-          originalPosition: textProcessor.findOriginalPosition(item.index, data.indices),
+          originalPosition: textProcessor.findOriginalPosition(
+            item.index,
+            data.indices
+          ),
         }))
-        .filter((result: any): result is SpellCheckResult => 
-          result.originalPosition !== undefined && result.originalPosition !== null
+        .filter(
+          (result: any): result is SpellCheckResult =>
+            result.originalPosition !== undefined &&
+            result.originalPosition !== null
         );
     });
-    
+
     const allResults = await Promise.all(spellCheckPromises);
     return allResults.flat();
   } catch (error) {
-    throw error; 
+    throw error;
   }
 }