refactor: use language server for config

carsakiller · carsakiller · commit 9bd8cd0e673e · 2023-01-31T22:28:20.000-05:00
diff --git a/client/src/addon_manager/commands/disable.ts b/client/src/addon_manager/commands/disable.ts
@@ -1,7 +1,7 @@
 import * as vscode from "vscode";
 import addonManager from "../services/addonManager.service";
 import { createChildLogger } from "../services/logging.service";
-import { setSetting } from "../services/settings.service";
+import { setConfig } from "../../languageserver";
 
 type Message = {
     data: {
@@ -15,49 +15,40 @@ export default async (context: vscode.ExtensionContext, message: Message) => {
     const addon = addonManager.addons.get(message.data.name);
     const workspaceFolders = vscode.workspace.workspaceFolders;
 
-    try {
-        if (workspaceFolders.length === 1) {
-            await addon.disable(workspaceFolders[0]);
-        } else {
-            const folderOptions = await (
-                await addon.getEnabled()
-            )
-                .filter((entry) => entry.enabled === true)
-                .map((entry) => {
-                    return {
-                        label: entry.folder.name,
-                        detail: entry.folder.uri.path,
-                    };
-                });
-            const targetFolders = await vscode.window.showQuickPick(
-                folderOptions,
-                {
-                    canPickMany: true,
-                    ignoreFocusOut: true,
-                    title: `Disable ${addon.name} in which folders?`,
-                }
-            );
-            if (!targetFolders) {
-                localLogger.warn("User did not pick workspace folder");
-                await addon.setLock(false);
-                return;
-            }
-            for (const target of targetFolders) {
-                const folder = workspaceFolders.find(
-                    (folder) => folder.name === target.label
-                );
-                await addon.disable(folder);
-                await setSetting(
-                    folder,
-                    "Lua.workspace.checkThirdParty",
-                    false
-                );
-            }
+    let selectedFolders: vscode.WorkspaceFolder[];
+
+    if (workspaceFolders.length === 1) {
+        selectedFolders = [workspaceFolders[0]];
+    } else {
+        const folderOptions = await addon.getQuickPickerOptions(true);
+        const pickResult = await vscode.window.showQuickPick(folderOptions, {
+            canPickMany: true,
+            ignoreFocusOut: true,
+            title: `Disable ${addon.name} in which folders?`,
+        });
+        if (!pickResult) {
+            localLogger.warn("User did not pick workspace folder");
+            await addon.setLock(false);
+            return;
         }
-    } catch (e) {
-        localLogger.error(e);
-        return;
-    } finally {
-        await addon.setLock(false);
+        selectedFolders = pickResult.map((selection) => {
+            return workspaceFolders.find(
+                (folder) => folder.name === selection.label
+            );
+        });
     }
+
+    for (const folder of selectedFolders) {
+        await addon.disable(folder);
+        await setConfig([
+            {
+                action: "set",
+                key: "Lua.workspace.checkThirdParty",
+                value: false,
+                uri: folder.uri,
+            },
+        ]);
+    }
+
+    return addon.setLock(false);
 };
diff --git a/client/src/addon_manager/commands/enable.ts b/client/src/addon_manager/commands/enable.ts
@@ -1,7 +1,7 @@
 import * as vscode from "vscode";
 import addonManager from "../services/addonManager.service";
 import { createChildLogger } from "../services/logging.service";
-import { setSetting } from "../services/settings.service";
+import { setConfig } from "../../languageserver";
 
 type Message = {
     data: {
@@ -14,52 +14,41 @@ const localLogger = createChildLogger("Enable Addon");
 export default async (context: vscode.ExtensionContext, message: Message) => {
     const addon = addonManager.addons.get(message.data.name);
     const workspaceFolders = vscode.workspace.workspaceFolders;
+    let selectedFolders: vscode.WorkspaceFolder[];
 
-    try {
-        if (workspaceFolders.length === 1) {
-            await addon.enable(workspaceFolders[0]);
-            await setSetting(workspaceFolders[0], "Lua.workspace.checkThirdParty", false);
-        } else {
-            const folderOptions = await (
-                await addon.getEnabled()
-            )
-                .filter((entry) => entry.enabled === false)
-                .map((entry) => {
-                    return {
-                        label: entry.folder.name,
-                        detail: entry.folder.uri.path,
-                    };
-                });
+    if (workspaceFolders.length === 1) {
+        selectedFolders = [workspaceFolders[0]];
+    } else {
+        const folderOptions = await addon.getQuickPickerOptions(false);
 
-            const targetFolders = await vscode.window.showQuickPick(
-                folderOptions,
-                {
-                    canPickMany: true,
-                    ignoreFocusOut: true,
-                    title: `Enable ${addon.name} in which folders?`,
-                }
-            );
-            if (!targetFolders) {
-                localLogger.warn("User did not pick workspace folder");
-                await addon.setLock(false);
-                return;
-            }
-            for (const target of targetFolders) {
-                const folder = workspaceFolders.find(
-                    (folder) => folder.name === target.label
-                );
-                await addon.enable(folder);
-                await setSetting(
-                    folder,
-                    "Lua.workspace.checkThirdParty",
-                    false
-                );
-            }
+        const pickResult = await vscode.window.showQuickPick(folderOptions, {
+            canPickMany: true,
+            ignoreFocusOut: true,
+            title: `Enable ${addon.name} in which folders?`,
+        });
+        if (!pickResult) {
+            localLogger.warn("User did not pick workspace folder");
+            await addon.setLock(false);
+            return;
         }
-    } catch (e) {
-        localLogger.error(e);
-        return;
-    } finally {
-        await addon.setLock(false);
+        selectedFolders = pickResult.map((selection) => {
+            return workspaceFolders.find(
+                (folder) => folder.name === selection.label
+            );
+        });
     }
+
+    for (const folder of selectedFolders) {
+        await addon.enable(folder);
+        await setConfig([
+            {
+                action: "set",
+                key: "Lua.workspace.checkThirdParty",
+                value: false,
+                uri: folder.uri,
+            },
+        ]);
+    }
+
+    return addon.setLock(false);
 };
diff --git a/client/src/addon_manager/config.ts b/client/src/addon_manager/config.ts
@@ -9,11 +9,11 @@ export const REPOSITORY_DEFAULT_BRANCH = "main";
 export const REPOSITORY_ISSUES_URL =
     "https://github.com/carsakiller/vscode-lua-webvue/issues/new?template=bug_report.yml";
 export const ADDONS_DIRECTORY = "addons";
-export const INFO_FILENAME = "info.json";
 
 // settings.json file info
 export const LIBRARY_SETTING = "Lua.workspace.library";
 
 // Addon files
 export const PLUGIN_FILENAME = "plugin.lua";
 export const CONFIG_FILENAME = "config.json";
+export const INFO_FILENAME = "info.json";
diff --git a/client/src/addon_manager/models/addon.ts b/client/src/addon_manager/models/addon.ts
@@ -5,14 +5,13 @@ import { AddonConfig, AddonInfo } from "../types/addon";
 import { WebVue } from "../panels/WebVue";
 import {
     applyAddonSettings,
-    getSetting,
     getLibraryPaths,
     revokeAddonSettings,
-    setSetting,
 } from "../services/settings.service";
 import { git } from "../services/git.service";
 import filesystem from "../services/filesystem.service";
 import { DiffResultTextFile } from "simple-git";
+import { getConfig, setConfig } from "../../languageserver";
 
 const localLogger = createChildLogger("Addon");
 
@@ -23,7 +22,7 @@ export class Addon {
     /** Whether or not this addon is currently processing an operation. */
     #processing?: boolean;
     /** The workspace folders that this addon is enabled in. */
-    #enabled?: boolean[];
+    #enabled: boolean[];
     /** Whether or not this addon has an update available from git. */
     #hasUpdate?: boolean;
     /** Whether or not this addon is installed */
@@ -53,7 +52,7 @@ export class Addon {
     }
 
     /** Get the `config.json` for this addon. */
-    public async getConfig() {
+    public async getConfigurationFile() {
         const configURI = vscode.Uri.joinPath(
             this.uri,
             "module",
@@ -119,10 +118,10 @@ export class Addon {
     }
 
     public async enable(folder: vscode.WorkspaceFolder) {
-        const librarySetting = (await getSetting(
+        const librarySetting = ((await getConfig(
             LIBRARY_SETTING,
-            folder
-        )) as string[];
+            folder.uri
+        )) ?? []) as string[];
 
         const enabled = await this.checkIfEnabled(librarySetting);
         if (enabled) {
@@ -152,12 +151,18 @@ export class Addon {
         // Apply addon settings
         const libraryUri = vscode.Uri.joinPath(this.uri, "module", "library");
         const libraryPath = libraryUri.path.substring(1);
-        librarySetting.push(libraryPath);
 
-        const configValues = await this.getConfig();
+        const configValues = await this.getConfigurationFile();
 
         try {
-            await setSetting(folder, LIBRARY_SETTING, librarySetting);
+            await setConfig([
+                {
+                    action: "add",
+                    key: LIBRARY_SETTING,
+                    value: libraryPath,
+                    uri: folder.uri,
+                },
+            ]);
             if (configValues.settings)
                 await applyAddonSettings(folder, configValues.settings);
         } catch (e) {
@@ -170,10 +175,10 @@ export class Addon {
     }
 
     public async disable(folder: vscode.WorkspaceFolder, silent = false) {
-        const librarySetting = (await getSetting(
+        const librarySetting = ((await getConfig(
             LIBRARY_SETTING,
-            folder
-        )) as string[];
+            folder.uri
+        )) ?? []) as string[];
 
         const regex = new RegExp(
             `/sumneko.lua/addonManager/addons/${this.name}`,
@@ -188,12 +193,19 @@ export class Addon {
         }
 
         // Remove setting for Language Server
-        librarySetting.splice(index);
-        const configValues = await this.getConfig();
+        librarySetting.splice(index, 1);
+        const configValues = await this.getConfigurationFile();
 
         // Revoke settings
         try {
-            await setSetting(folder, LIBRARY_SETTING, librarySetting);
+            await setConfig([
+                {
+                    action: "set",
+                    key: LIBRARY_SETTING,
+                    value: librarySetting,
+                    uri: folder.uri,
+                },
+            ]);
             if (configValues.settings)
                 await revokeAddonSettings(folder, configValues.settings);
         } catch (e) {
@@ -255,6 +267,23 @@ export class Addon {
         return this.#hasUpdate;
     }
 
+    /** Get a list of options for a quick picker that lists the workspace
+     * folders that the addon is enabled/disabled in.
+     * @param enabledState The state the addon must be in in a folder to be included.
+     * `true` will only return the folders that the addon is **enabled** in.
+     * `false` will only return the folders that the addon is **disabled** in
+     */
+    public async getQuickPickerOptions(enabledState: boolean) {
+        return (await this.getEnabled())
+            .filter((entry) => entry.enabled === enabledState)
+            .map((entry) => {
+                return {
+                    label: entry.folder.name,
+                    detail: entry.folder.uri.path,
+                };
+            });
+    }
+
     public async setLock(state: boolean) {
         this.#processing = state;
         return this.sendToWebVue();
diff --git a/client/src/addon_manager/services/settings.service.ts b/client/src/addon_manager/services/settings.service.ts
diff --git a/client/src/languageserver.ts b/client/src/languageserver.ts
