feat: vscode extension (#4104)

Author: benfdking

.prettierignore

@@ -17,6 +17,7 @@ node_modules/
 vscode/extension/node_modules/
 vscode/extension/dist
 vscode/extension/out
+vscode/extension/src_react
 vscode/extension/tsconfig.tsbuildinfo
 vscode/extension/.vscode-test/
 

Makefile

@@ -16,7 +16,7 @@ py-style:
 	SKIP=prettier,eslint pre-commit run --all-files
 
 ui-style:
-	npm run lint
+	pnpm run lint
 
 doc-test:
 	python -m pytest --doctest-modules sqlmesh/core sqlmesh/utils
@@ -178,3 +178,7 @@ athena-test: guard-AWS_ACCESS_KEY_ID guard-AWS_SECRET_ACCESS_KEY guard-ATHENA_S3
 vscode_settings:
 	mkdir -p .vscode
 	cp -r ./tooling/vscode/*.json .vscode/
+
+vscode-generate-openapi:
+	python3 web/server/openapi.py --output vscode/extension/openapi.json
+	cd vscode/react && pnpm run generate:api

pnpm-lock.yaml

@@ -1,4 +1,5 @@
 packages:
   - vscode/bus
   - vscode/extension
+  - vscode/react
   - web/client

pnpm-workspace.yaml

@@ -5,8 +5,8 @@
   "tasks": [
     {
       "label": "extension-watch",
-      "type": "npm",
-      "script": "watch",
+      "type": "shell",
+      "command": "pnpm run watch",
       "problemMatcher": "$ts-webpack-watch",
       "isBackground": true,
       "presentation": {
@@ -18,6 +18,35 @@
       },
       "options": {
         "cwd": "${workspaceFolder}/vscode/extension"
+      },
+      "dependsOn": ["react-dev"],
+      "dependsOrder": "parallel"
+    },
+    {
+      "label": "react-dev",
+      "type": "shell",
+      "command": "pnpm run build:watch",
+      "options": {
+        "cwd": "${workspaceFolder}/vscode/react"
+      },
+      "group": {
+        "kind": "build"
+      },
+      "isBackground": true,
+      "problemMatcher": {
+        "owner": "npm",
+        "pattern": {
+          "regexp": "."
+        },
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": ".",
+          "endsPattern": "."
+        }
+      },
+      "presentation": {
+        "reveal": "never",
+        "group": "watchers"
       }
     },
     {
@@ -26,12 +55,12 @@
         "kind": "build",
         "isDefault": true
       },
-      "dependsOn": ["extension-watch"],
+      "dependsOn": ["react-dev", "extension-watch"],
       "dependsOrder": "parallel"
     },
     {
-      "type": "npm",
-      "script": "watch-tests",
+      "type": "shell",
+      "command": "pnpm run watch-tests",
       "problemMatcher": "$tsc-watch",
       "isBackground": true,
       "presentation": {
@@ -40,12 +69,12 @@
       },
       "group": "build",
       "options": {
-        "cwd": "${workspaceFolder}/vscode/extension"
+        "cwd": "${workspaceFolder}/vscode"
       }
     },
     {
       "label": "tasks: watch-tests",
-      "dependsOn": ["npm: watch", "npm: watch-tests"],
+      "dependsOn": ["watch-tests"],
       "problemMatcher": []
     }
   ]

tooling/vscode/tasks.json

@@ -0,0 +1,41 @@
+export type Callback = {
+  openFile: {
+    uri: string
+  }
+  queryRequest: {
+    requestId: string
+    url: string
+    method?: string
+    params?: Record<string, string>
+    body?: Record<string, any>
+  }
+}
+
+/**
+ * A tuple type representing a callback event with its associated payload.
+ * The first element is the callback key (e.g., 'openFile', 'formatProject').
+ * The second element is the payload type associated with that key.
+ *
+ * Example:
+ * const openFileEvent: CallbackEvent<'openFile'> = ['openFile', { path: '/path/to/file' }];
+ */
+export type CallbackEvent = {
+  [K in keyof Callback]: { key: K; payload: Callback[K] }
+}[keyof Callback]
+
+/**
+ * A tuple type representing a VSCode event with its associated payload.
+ */
+export type VSCodeCallback = {
+  changeFocusOnFile: {
+    path: string
+  }
+  queryResponse: {
+    requestId: string
+    response: any
+  }
+}
+
+export type VSCodeEvent = {
+  [K in keyof VSCodeCallback]: { key: K; payload: VSCodeCallback[K] }
+}[keyof VSCodeCallback]

vscode/bus/src/callbacks.ts

@@ -11,7 +11,9 @@
     "noUnusedParameters": true,
     "noEmit": true,
     "moduleResolution": "node",
-    "baseUrl": "./"
+    "baseUrl": "./",
+    "skipLibCheck": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "../../node_modules"]
 }

vscode/bus/tsconfig.json

@@ -4,3 +4,5 @@ out
 .vscode-test
 *.vsix
 LICENSE
+src_react
+!src_react/.gitkeep

vscode/extension/.gitignore

@@ -12,5 +12,8 @@ vsc-extension-quickstart.md
 **/*.map
 **/*.ts
 **/.vscode-test.*
+<<<<<<< HEAD
 assets/logo.svg
 esbuild.js
+=======
+>>>>>>> c5ee2535 (progress)

vscode/extension/.vscodeignore

@@ -25,4 +25,3 @@ The extension allows you to:
 ### Linting
 
 The extension allows you to see linting errors and warnings inline.
-