fix: resolve workspace folder in config path for better compatibility (#70)

* fix: resolve workspace folder in config path for better compatibility

see #66

this allows use of relative path to the config file and  variable use and makes the following valid configuration options:

{
  vale.valeCLI.config: /home/patrick/github.com/davidsneighbour/kollitsch.dev/src/config/vale/vale.ini,
  vale.valeCLI.config: /src/config/vale/vale.ini,
  vale.valeCLI.config: ./src/config/vale/vale.ini,
}

Signed-off-by: Patrick Kollitsch <[email protected]>

* Add details to read me and settings UI

---------

Signed-off-by: Patrick Kollitsch <[email protected]>
Co-authored-by: Chris Chinchilla <[email protected]>

Author: davidsneighbour

README.md

@@ -64,7 +64,7 @@ The extension doesn't support adding words to dictionaries. For now, the best op
 
 The extension offers a number of settings and configuration options (_Preferences > Extensions > Vale_).
 
-- `vale.valeCLI.config` (default: `null`): Absolute path to a Vale configuration file.
+- `vale.valeCLI.config` (default: `null`): Absolute or relative path to a Vale configuration file.
 - `vale.valeCLI.minAlertLevel` (default: `inherited`): Defines from which level of errors and above to display in the problems view.
 - `vale.doNotShowWarningForFileToBeSavedBeforeLinting` (default: `false`): Toggle display of warning dialog that you must save a file before Vale lints it.
 - `vale.readabilityProblemLocation` (default: `status`): If you have any `Readability` or `metric` styles, the extension can display the readability score in the status bar, the problems view, or both.

package.json

@@ -56,7 +56,7 @@
           "scope": "resource",
           "type": "string",
           "default": null,
-          "description": "Absolute path to a Vale config file. If not specified, the default search process is used (relative to the current file)."
+          "description": "Absolute or relative path to a Vale config file. If not specified, the default search process is used (relative to the current file)."
         },
         "vale.valeCLI.syncOnStartup": {
           "scope": "resource",

src/lsp.ts

@@ -148,8 +148,26 @@ export async function activate(context: ExtensionContext) {
     valeFilter = filters.join(" and ") as unknown as valeArgs;
   }
 
+  // Get the config path as a string
+  let configPathRaw = configuration.get<string>("vale.valeCLI.config") || "";
+
+  // Resolve workspace folder
+  let resolvedConfigPath = configPathRaw;
+  if (vscode.workspace.workspaceFolders && vscode.workspace.workspaceFolders.length > 0) {
+    const workspaceRoot = vscode.workspace.workspaceFolders[0].uri.fsPath;
+
+    if (configPathRaw.includes("${workspaceFolder}")) {
+      resolvedConfigPath = configPathRaw.replace(/\$\{workspaceFolder\}/g, workspaceRoot);
+    } else if (
+      configPathRaw.startsWith("./") ||
+      (!path.isAbsolute(configPathRaw) && configPathRaw.length > 0)
+    ) {
+      resolvedConfigPath = path.join(workspaceRoot, configPathRaw);
+    }
+  }
+
   let valeConfig: Record<valeConfigOptions, valeArgs> = {
-    configPath: configuration.get("vale.valeCLI.config") as valeArgs,
+    configPath: { value: resolvedConfigPath } as valeArgs,
     syncOnStartup: configuration.get("vale.valeCLI.syncOnStartup") as valeArgs,
     filter: valeFilter as unknown as valeArgs,
     // TODO: Build into proper onboarding