feat: ${env:ENV} syntax for config (#63)

Author: juleswritescode

package-lock.json

@@ -3,7 +3,7 @@
   "publisher": "Supabase",
   "displayName": "postgres-language-server",
   "description": "Postgres Language Server right in your IDE.",
-  "version": "1.3.5",
+  "version": "1.4.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/supabase-community/postgres-language-server-vscode"
@@ -136,27 +136,32 @@
         },
         "postgres-language-server.configFile": {
           "type": "string",
-          "description": "Path to the `postgres-language-server.jsonc` file. You don't need to set this if the file is on root level of your project.",
+          "description": "Path to the `postgres-language-server.jsonc` file. Supports environment variables with ${env:VAR_NAME} syntax. You don't need to set this if the file is on root level of your project.",
+          "examples": [
+            "./configs/postgres-language-server.jsonc",
+            "${env:POSTGRES_CONFIG_DIR}/postgres-language-server.jsonc"
+          ],
           "scope": "resource"
         },
         "postgres-language-server.bin": {
           "oneOf": [
             {
               "type": "string",
-              "description": "Path to the postgres-language-server Language Server binary",
+              "description": "Path to the postgres-language-server Language Server binary. Supports environment variables with ${env:VAR_NAME} syntax.",
               "examples": [
                 "/path/to/postgres-language-server",
-                "./path/to/postgres-language-server"
+                "./path/to/postgres-language-server",
+                "${env:POSTGRES_TOOLS_DIR}/postgres-language-server"
               ]
             },
             {
               "type": "object",
-              "description": "Platform-specific paths to the postgres-language-server Language Server binary",
+              "description": "Platform-specific paths to the postgres-language-server Language Server binary. Supports environment variables with ${env:VAR_NAME} syntax.",
               "examples": [
                 {
                   "linux-x64": "/path/to/postgres-language-server",
                   "darwin-arm64": "./path/to/postgres-language-server",
-                  "win32-x64": "/path/to/postgres-language-server.exe"
+                  "win32-x64": "${env:POSTGRES_TOOLS_DIR}/postgres-language-server.exe"
                 }
               ]
             }

package.json

@@ -2,7 +2,7 @@ import { Uri, window } from "vscode";
 import { logger } from "./logger";
 import { delimiter, dirname, join } from "node:path";
 import { CONSTANTS, OperatingMode } from "./constants";
-import { fileExists } from "./utils";
+import { expandEnvVariables, fileExists } from "./utils";
 import { createRequire } from "node:module";
 import { getConfig } from "./config";
 import { downloadPglt, getDownloadedBinary } from "./downloader";
@@ -71,6 +71,8 @@ export const vsCodeSettingsStrategy: BinaryFindStrategy = {
     if (typeof binSetting === "string") {
       logger.debug("Binary Setting is a string", { binSetting });
 
+      binSetting = expandEnvVariables(binSetting);
+
       let resolvedPath: string;
 
       if (binSetting.startsWith(".")) {

src/binary-finder-strategies.ts

@@ -1,5 +1,5 @@
 import { Uri, window, type WorkspaceFolder } from "vscode";
-import { fileExists } from "./utils";
+import { expandEnvVariables, fileExists } from "./utils";
 import { getConfig, isEnabledForFolder } from "./config";
 import { logger } from "./logger";
 import { state } from "./state";
@@ -16,7 +16,11 @@ export async function getActiveProjectsForMultiRoot(
   let globalConfig: Uri | undefined = undefined;
 
   if (!globalConfig) {
-    const globalConfigSetting = getConfig<string>("configFile");
+    let globalConfigSetting = getConfig<string>("configFile");
+
+    if (globalConfigSetting) {
+      globalConfigSetting = expandEnvVariables(globalConfigSetting);
+    }
 
     if (globalConfigSetting && globalConfigSetting.startsWith(".")) {
       window.showErrorMessage(
@@ -90,12 +94,17 @@ export async function getActiveProjectForSingleRoot(
 ): Promise<Project | null> {
   let configPath: Uri;
 
-  const userConfig = getConfig<string>("configFile", { scope: first.uri });
+  let userConfig = getConfig<string>("configFile", { scope: first.uri });
   if (userConfig) {
+    userConfig = expandEnvVariables(userConfig);
     logger.info("User has specified path to config file.", {
       path: userConfig,
     });
-    configPath = Uri.joinPath(first.uri, userConfig);
+    if (userConfig.startsWith(".")) {
+      configPath = Uri.joinPath(first.uri, userConfig);
+    } else {
+      configPath = Uri.file(userConfig);
+    }
   } else {
     logger.info("User did not specify path to config file. Using default.");
 

src/project.ts

@@ -133,3 +133,14 @@ export async function getVersion(bin: Uri): Promise<string | null> {
 export function daysToMs(days: number) {
   return days * 24 * 60 * 60 * 1000;
 }
+
+export function expandEnvVariables(path: string): string {
+  return path.replace(/\$\{env:([^}]+)\}/g, (match, varName) => {
+    const value = process.env[varName];
+    if (value === undefined || value === "") {
+      logger.warn(`Environment variable '${varName}' is not set`);
+      return match;
+    }
+    return value;
+  });
+}

src/utils.ts

@@ -1,4 +1,4 @@
 {
-  "postgres-language-server.configFile": "./configs/conf.jsonc",
-  "postgres-language-server.bin": "./bin/postgrestools"
+  "postgres-language-server.configFile": "${env:POSTGRESTOOLS_DIR}/test/fixtures/vscode-settings-strat/configs/conf.jsonc",
+  "postgres-language-server.bin": "${env:POSTGRESTOOLS_DIR}/test/fixtures/vscode-settings-strat/bin/postgrestools"
 }