feat(vscode): add ability to specify project path (#4520)

Author: benfdking

sqlmesh/lsp/main.py

@@ -69,10 +69,7 @@ def initialize(ls: LanguageServer, params: types.InitializeParams) -> None:
                                     # Use user-provided instantiator to build the context
                                     created_context = self.context_class(paths=[folder_path])
                                     self.lsp_context = LSPContext(created_context)
-                                    ls.show_message(
-                                        f"Loaded SQLMesh context from {config_path}",
-                                        types.MessageType.Info,
-                                    )
+                                    loaded_sqlmesh_message(ls, folder_path)
                                     return  # Exit after successfully loading any config
                                 except Exception as e:
                                     ls.show_message(
@@ -94,6 +91,9 @@ def all_models(ls: LanguageServer, params: AllModelsRequest) -> AllModelsRespons
         @self.server.feature(API_FEATURE)
         def api(ls: LanguageServer, request: ApiRequest) -> t.Dict[str, t.Any]:
             ls.log_trace(f"API request: {request}")
+            if self.lsp_context is None:
+                current_path = Path.cwd()
+                self._ensure_context_in_folder(current_path)
             if self.lsp_context is None:
                 raise RuntimeError("No context found")
 
@@ -291,6 +291,20 @@ def _context_get_or_load(self, document_uri: URI) -> LSPContext:
             raise RuntimeError("No context found")
         return self.lsp_context
 
+    def _ensure_context_in_folder(self, folder_uri: Path) -> None:
+        if self.lsp_context is not None:
+            return
+        for ext in ("py", "yml", "yaml"):
+            config_path = folder_uri / f"config.{ext}"
+            if config_path.exists():
+                try:
+                    created_context = self.context_class(paths=[folder_uri])
+                    self.lsp_context = LSPContext(created_context)
+                    loaded_sqlmesh_message(self.server, folder_uri)
+                    return
+                except Exception as e:
+                    self.server.show_message(f"Error loading context: {e}", types.MessageType.Error)
+
     def _ensure_context_for_document(
         self,
         document_uri: URI,
@@ -382,6 +396,13 @@ def start(self) -> None:
         self.server.start_io()
 
 
+def loaded_sqlmesh_message(ls: LanguageServer, folder: Path) -> None:
+    ls.show_message(
+        f"Loaded SQLMesh context from {folder}",
+        types.MessageType.Info,
+    )
+
+
 def main() -> None:
     # Example instantiator that just uses the same signature as your original `Context` usage.
     sqlmesh_server = SQLMeshLanguageServer(context_class=Context)

vscode/extension/package.json

@@ -27,6 +27,17 @@
     "ms-python.python"
   ],
   "contributes": {
+    "configuration": {
+      "type": "object",
+      "title": "SQLMesh",
+      "properties": {
+        "sqlmesh.projectPath": {
+          "type": "string",
+          "default": "",
+          "markdownDescription": "The path to the SQLMesh project. If not set, the extension will try to find the project root automatically. If set, the extension will use the project root as the workspace path, e.g. it will run `sqlmesh` and `sqlmesh_lsp` in the project root. The path can be absolute `/Users/sqlmesh_user/sqlmesh_project/sushi` or relative `./project_folder/sushi` to the workspace root."
+        }
+      }
+    },
     "viewsContainers": {
       "panel": [
         {

vscode/extension/src/lsp/lsp.ts

@@ -8,7 +8,7 @@ import {
 import { sqlmeshLspExec } from '../utilities/sqlmesh/sqlmesh'
 import { err, isErr, ok, Result } from '@bus/result'
 import { getWorkspaceFolders } from '../utilities/common/vscodeapi'
-import { traceError } from '../utilities/common/log'
+import { traceError, traceInfo } from '../utilities/common/log'
 import { ErrorType } from '../utilities/errors'
 import { CustomLSPMethods } from './custom'
 
@@ -43,9 +43,7 @@ export class LSPClient implements Disposable {
         message: 'Invalid number of workspace folders',
       })
     }
-
-    const folder = workspaceFolders[0]
-    const workspacePath = workspaceFolders[0].uri.fsPath
+    const workspacePath = sqlmesh.value.workspacePath
     const serverOptions: ServerOptions = {
       run: {
         command: sqlmesh.value.bin,
@@ -66,11 +64,13 @@ export class LSPClient implements Disposable {
     }
     const clientOptions: LanguageClientOptions = {
       documentSelector: [{ scheme: 'file', pattern: `**/*.sql` }],
-      workspaceFolder: folder,
       diagnosticCollectionName: 'sqlmesh',
       outputChannel: outputChannel,
     }
 
+    traceInfo(
+      `Starting SQLMesh Language Server with workspace path: ${workspacePath} with server options ${JSON.stringify(serverOptions)} and client options ${JSON.stringify(clientOptions)}`,
+    )
     this.client = new LanguageClient(
       'sqlmesh-lsp',
       'SQLMesh Language Server',

vscode/extension/src/utilities/config.ts

@@ -0,0 +1,77 @@
+import { workspace, WorkspaceFolder } from 'vscode'
+import path from 'path'
+import fs from 'fs'
+import { Result, err, ok } from '@bus/result'
+import { traceVerbose, traceInfo } from './common/log'
+
+export interface SqlmeshConfiguration {
+  projectPath: string
+}
+
+/**
+ * Get the SQLMesh configuration from VS Code settings.
+ *
+ * @returns The SQLMesh configuration
+ */
+export function getSqlmeshConfiguration(): SqlmeshConfiguration {
+  const config = workspace.getConfiguration('sqlmesh')
+  const projectPath = config.get<string>('projectPath', '')
+  return {
+    projectPath,
+  }
+}
+
+/**
+ * Validate and resolve the project path from configuration.
+ * If no project path is configured, use the workspace folder.
+ * If the project path is configured, it must be a directory that contains a SQLMesh project.
+ *
+ * @param workspaceFolder The current workspace folder
+ * @returns A Result containing the resolved project path or an error
+ */
+export function resolveProjectPath(
+  workspaceFolder: WorkspaceFolder,
+): Result<string, string> {
+  const config = getSqlmeshConfiguration()
+
+  if (!config.projectPath) {
+    // If no project path is configured, use the workspace folder
+    traceVerbose('No project path configured, using workspace folder')
+    return ok(workspaceFolder.uri.fsPath)
+  }
+  let resolvedPath: string
+
+  // Check if the path is absolute
+  if (path.isAbsolute(config.projectPath)) {
+    resolvedPath = config.projectPath
+  } else {
+    // Resolve relative path from workspace root
+    resolvedPath = path.join(workspaceFolder.uri.fsPath, config.projectPath)
+  }
+
+  // Normalize the path
+  resolvedPath = path.normalize(resolvedPath)
+
+  // Validate that the path exists
+  if (!fs.existsSync(resolvedPath)) {
+    return err(`Configured project path does not exist: ${resolvedPath}`)
+  }
+
+  // Validate that it's a directory
+  const stats = fs.statSync(resolvedPath)
+  if (!stats.isDirectory()) {
+    return err(`Configured project path is not a directory: ${resolvedPath}`)
+  }
+
+  // Check if it contains SQLMesh project files (config.yaml, config.yml, or config.py)
+  const configFiles = ['config.yaml', 'config.yml', 'config.py']
+  const hasConfigFile = configFiles.some(file =>
+    fs.existsSync(path.join(resolvedPath, file)),
+  )
+  if (!hasConfigFile) {
+    traceInfo(`Warning: No SQLMesh configuration file found in ${resolvedPath}`)
+  }
+
+  traceVerbose(`Using project path: ${resolvedPath}`)
+  return ok(resolvedPath)
+}

vscode/extension/src/utilities/sqlmesh/sqlmesh.ts

@@ -11,6 +11,7 @@ import { execAsync } from '../exec'
 import z from 'zod'
 import { ProgressLocation, window } from 'vscode'
 import { IS_WINDOWS } from '../isWindows'
+import { resolveProjectPath } from '../config'
 
 export interface SqlmeshExecInfo {
   workspacePath: string
@@ -28,8 +29,12 @@ export interface SqlmeshExecInfo {
  */
 export const isTcloudProject = async (): Promise<Result<boolean, string>> => {
   const projectRoot = await getProjectRoot()
-  const tcloudYamlPath = path.join(projectRoot.uri.fsPath, 'tcloud.yaml')
-  const tcloudYmlPath = path.join(projectRoot.uri.fsPath, 'tcloud.yml')
+  const resolvedPath = resolveProjectPath(projectRoot)
+  if (isErr(resolvedPath)) {
+    return err(resolvedPath.error)
+  }
+  const tcloudYamlPath = path.join(resolvedPath.value, 'tcloud.yaml')
+  const tcloudYmlPath = path.join(resolvedPath.value, 'tcloud.yml')
   const isTcloudYamlFilePresent = fs.existsSync(tcloudYamlPath)
   const isTcloudYmlFilePresent = fs.existsSync(tcloudYmlPath)
   if (isTcloudYamlFilePresent || isTcloudYmlFilePresent) {
@@ -83,8 +88,15 @@ export const isSqlmeshEnterpriseInstalled = async (): Promise<
     return tcloudBin
   }
   const projectRoot = await getProjectRoot()
+  const resolvedPath = resolveProjectPath(projectRoot)
+  if (isErr(resolvedPath)) {
+    return err({
+      type: 'generic',
+      message: resolvedPath.error,
+    })
+  }
   const called = await execAsync(tcloudBin.value, ['is_sqlmesh_installed'], {
-    cwd: projectRoot.uri.fsPath,
+    cwd: resolvedPath.value,
   })
   if (called.exitCode !== 0) {
     return err({
@@ -183,7 +195,14 @@ export const sqlmeshExec = async (): Promise<
 > => {
   const sqlmesh = IS_WINDOWS ? 'sqlmesh.exe' : 'sqlmesh'
   const projectRoot = await getProjectRoot()
-  const workspacePath = projectRoot.uri.fsPath
+  const resolvedPath = resolveProjectPath(projectRoot)
+  if (isErr(resolvedPath)) {
+    return err({
+      type: 'generic',
+      message: resolvedPath.error,
+    })
+  }
+  const workspacePath = resolvedPath.value
   const interpreterDetails = await getInterpreterDetails()
   traceLog(`Interpreter details: ${JSON.stringify(interpreterDetails)}`)
   if (interpreterDetails.path) {
@@ -300,7 +319,14 @@ export const sqlmeshLspExec = async (): Promise<
 > => {
   const sqlmeshLSP = IS_WINDOWS ? 'sqlmesh_lsp.exe' : 'sqlmesh_lsp'
   const projectRoot = await getProjectRoot()
-  const workspacePath = projectRoot.uri.fsPath
+  const resolvedPath = resolveProjectPath(projectRoot)
+  if (isErr(resolvedPath)) {
+    return err({
+      type: 'generic',
+      message: resolvedPath.error,
+    })
+  }
+  const workspacePath = resolvedPath.value
   const interpreterDetails = await getInterpreterDetails()
   traceLog(`Interpreter details: ${JSON.stringify(interpreterDetails)}`)
   if (interpreterDetails.path) {