Merge pull request #39 from MetamediaTechnology/refactoring

Change config name

Author: bankjirapan

CHANGELOG.md

@@ -7,8 +7,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 ## [Released]
 ### [0.2.8] : 21/04/2568
 - feat: Set spell checking on save as the default behavior
+- refactor: Change configuration name from longdo-spell-checker to Longdo Spell Checker.
 - feat: Enhanced status bar to reflect different states:
-    - Checkmark when no spelling errors are found
+    - Check mark when no spelling errors are found
     - Disconnection icon when API key is missing
     - Offline indicator when internet connection is unavailable
 

package.json

@@ -41,17 +41,17 @@
     "configuration": {
       "title": "Longdo Spell",
       "properties": {
-        "longdo-spell-checker.apiKey": {
+        "longdoSpellChecker.apiKey": {
           "type": "string",
           "default": "",
           "description": "Longdo Spell Checker Api Key"
         },
-        "longdo-spell-checker.checkOnSave": {
+        "longdoSpellChecker.checkOnSave": {
           "type": "boolean",
           "default": true,
           "description": "Check spelling on save"
         },
-        "longdo-spell-checker.locale": {
+        "longdoSpellChecker.locale": {
           "type": "string",
           "enum": [
             "Thai",
@@ -60,7 +60,7 @@
           "default": "Thai",
           "description": "Set the primary language for spell checking"
         },
-        "longdo-spell-checker.language": {
+        "longdoSpellChecker.language": {
           "type": "array",
           "default": [
             "Thai",

src/api.ts

@@ -34,7 +34,7 @@ async function postProof(text: string) {
       throw new Error("NetworkError");
     }
 
-    const apiKey = vscode.workspace.getConfiguration("longdo-spell-checker").get("apiKey");
+    const apiKey = vscode.workspace.getConfiguration("longdoSpellChecker").get("apiKey");
     if (!apiKey) {
       updateEmoji("$(debug-disconnect)");
       throw new Error("API key is not set. Please set it in the settings.");

src/extension.ts

@@ -9,27 +9,10 @@ import { showStatusBar, updateEmoji } from "./ui";
 
 let errorsResult: ErrorsResult[] = [];
 let markCheckList: ErrorsResult[] = [];
-let isEnableOnSave = false;
 
 export function activate(context: vscode.ExtensionContext) {
   showStatusBar(context);
 
-  vscode.workspace.onDidChangeConfiguration((event) => {
-    if (event.affectsConfiguration("longdo-spell-checker.checkOnSave")) {
-      vscode.window
-        .showInformationMessage(
-          "Longdo Spell Checker: Settings changed. Restart window for changes to take effect?",
-          "Restart",
-          "Later"
-        )
-        .then((selection) => {
-          if (selection === "Restart") {
-            vscode.commands.executeCommand("workbench.action.reloadWindow");
-          }
-        });
-    }
-  });
-
   context.subscriptions.push(
     vscode.languages.registerCodeActionsProvider(
       Configuration.languages,
@@ -52,12 +35,12 @@ export function activate(context: vscode.ExtensionContext) {
     async () => {
       const url = "https://map.longdo.com/console";
       try {
-          vscode.env.openExternal(vscode.Uri.parse(url));
+        vscode.env.openExternal(vscode.Uri.parse(url));
       } catch (error) {
-          console.error("Failed to open URL:", error);
-          vscode.window.showErrorMessage(
-            "Failed to open Longdo Web Console. Please check your internet connection."
-          );
+        console.error("Failed to open URL:", error);
+        vscode.window.showErrorMessage(
+          "Failed to open Longdo Web Console. Please check your internet connection."
+        );
       }
     }
   );
@@ -95,7 +78,7 @@ export function activate(context: vscode.ExtensionContext) {
     Command.OpenSetKey,
     async () => {
       const currentAPIKey = vscode.workspace
-        .getConfiguration("longdo-spell-checker")
+        .getConfiguration("longdoSpellChecker")
         .get("apiKey") as string;
       if (currentAPIKey) {
         const confirm = await vscode.window.showInformationMessage(
@@ -116,7 +99,7 @@ export function activate(context: vscode.ExtensionContext) {
       });
 
       if (apiKey) {
-        const config = vscode.workspace.getConfiguration("longdo-spell-checker");
+        const config = vscode.workspace.getConfiguration("longdoSpellChecker");
         try {
           await config.update(
             "apiKey",
@@ -166,7 +149,10 @@ export function activate(context: vscode.ExtensionContext) {
           vscode.commands.executeCommand(Command.OpenSetKey);
           break;
         case "Longdo Spell Checker: Open Settings":
-          vscode.commands.executeCommand('workbench.action.openSettings', 'longdo-spell-checker');
+          vscode.commands.executeCommand(
+            "workbench.action.openSettings",
+            "longdo-spell-checker"
+          );
           break;
         case "Longdo Spell Checker: Open Web Console":
           vscode.commands.executeCommand(Command.openWebAPI);
@@ -175,10 +161,6 @@ export function activate(context: vscode.ExtensionContext) {
     }
   );
 
-  isEnableOnSave = vscode.workspace
-    .getConfiguration("longdo-spell-checker")
-    .get("checkOnSave", false);
-
   context.subscriptions.push(openWebConsole);
   context.subscriptions.push(disposable);
   context.subscriptions.push(clearCommand);
@@ -201,12 +183,16 @@ async function onSpellCheck() {
 
   try {
     let results = await spellCheckPromises();
-    results = results.filter(error => 
-      !markCheckList.some(mark => mark.word === error.word)
+    results = results.filter(
+      (error) => !markCheckList.some((mark) => mark.word === error.word)
     );
-    
+
     if (results.length === 0) {
-      if (!isEnableOnSave) {
+      if (
+        vscode.workspace
+          .getConfiguration("longdoSpellChecker")
+          .get("checkOnSave")
+      ) {
         vscode.window.showInformationMessage("No spelling errors found.");
       }
       updateEmoji("$(pass)");
@@ -229,7 +215,7 @@ async function onSpellCheck() {
         "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") {
@@ -278,17 +264,18 @@ function listenerDocumentChanged() {
 }
 
 function listenerDocumentSaved(): vscode.Disposable {
-  if (!isEnableOnSave) {
-    return { dispose: () => {} };
-  }
   return vscode.workspace.onDidSaveTextDocument((document) => {
     const editor = vscode.window.activeTextEditor;
     if (!editor) {
       return;
     }
-    textProcessor.processDocument({ document }).then(() => {
-      onSpellCheck();
-    });
+    if (
+      vscode.workspace.getConfiguration("longdoSpellChecker").get("checkOnSave")
+    ) {
+      textProcessor.processDocument({ document }).then(() => {
+        onSpellCheck();
+      });
+    }
   });
 }
 

src/language.ts

@@ -33,18 +33,18 @@ export class Language {
    */
   public switchLanguage() {
     const currentLanguage =
-      vscode.workspace.getConfiguration("longdo-spell-checker").get("locale") ?? "en";
+      vscode.workspace.getConfiguration("longdoSpellChecker").get("locale") ?? "en";
     const newLanguage = currentLanguage === "en" ? "fr" : "en";
     vscode.workspace
-      .getConfiguration("longdo-spell-checker")
+      .getConfiguration("longdoSpellChecker")
       .update("locale", newLanguage, vscode.ConfigurationTarget.Global);
   }
 
   /**
    * Returns the language of the current editor
    */
   public getLanguage(): string {
-    const locale = vscode.workspace.getConfiguration("longdo-spell-checker").get("locale") as string;
+    const locale = vscode.workspace.getConfiguration("longdoSpellChecker").get("locale") as string;
     return locale === "Thai" ? "th" : "en";
   }
 

src/text.ts

@@ -70,7 +70,7 @@ export class TextProcessor {
       document.fileName.split(".").pop()?.toLowerCase() || "txt";
     const isSupportedFile = fileExtension in languageMap;
 
-    const config = vscode.workspace.getConfiguration("longdo-spell-checker");
+    const config = vscode.workspace.getConfiguration("longdoSpellChecker");
     const languages = config.get<string[]>("language") || [];
     const isEnglishEnabled = languages.includes("English");