opening extension in right place

registered logging

[ci skip]

format works

making progress

making progress sharing node modules

creating the docs

progress

getting react server to show

making progress with the server

temp

get calling api now need to add lineage tab

making progress on vscode lineage

temp

progress: showing the lineage graph

[ci skip]

cleaning up lineage

[ci skip]

added ability to open files

temp [ci skip]

trying to implement lsp

[ci skip]

temp

[ci skip]

test [ci skip]

temp [ci skip]

temp [ci skip]

temp [ci skip]

temp

[ci skip]

progress [ci skip]

temp [ci skip]

temp

temp [ci skip]

temp sending messages [ci skip]

making progress [ci skip]

temp

temp [ci skip]

temp

[ci skip]

temp [ci skip]

progress [ci skip]

progress [ci skip]

Author: benfdking

Makefile

@@ -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 && npm run generate:api

docs/development.md

@@ -4,7 +4,11 @@ SQLMesh is licensed under [Apache 2.0](https://github.com/TobikoData/sqlmesh/blo
 
 ## Prerequisites
 
+<<<<<<< HEAD
 Before you begin, ensure you have the following installed on your machine. Exactly how to install these is dependent on your operating system.
+=======
+Before you begin, ensure you have the following installed on your machine. Exacltly how to install these is dependent on your operating system.
+>>>>>>> afd4b2c1 (opening extension in right place)
 
 * Docker
 * Docker Compose V2
@@ -25,9 +29,47 @@ Once you have activated your virtual environment, you can install the dependenci
 ```bash
 make install-dev
 ```
+<<<<<<< HEAD
 
 Optionally, you can use pre-commit to automatically run linters/formatters:
 
+=======
+<<<<<<< HEAD
+Run linters and formatters:
+```bash
+make style
+```
+Run faster tests for quicker local feedback:
+```bash
+make fast-test
+```
+Run more comprehensive tests that run on each commit:
+```bash
+make slow-test
+```
+Install docs dependencies:
+```bash
+make install-doc
+```
+Run docs server:
+```bash
+make docs-serve
+```
+Run docs tests:
+```bash
+make doc-test
+```
+Run ide:
+```bash
+make ui-up
+```
+(Optional) Use pre-commit to automatically run linters/formatters:
+=======
+
+Optionally, you can use pre-commit to automatically run linters/formatters:
+
+>>>>>>> 61520e5a (creating the docs)
+>>>>>>> afd4b2c1 (opening extension in right place)
 ```bash
 make install-pre-commit
 ```
@@ -52,6 +94,15 @@ Run more comprehensive tests that run on each commit:
 make slow-test
 ```
 
+<<<<<<< HEAD
+=======
+Run Airflow tests that will run when PR is merged to main:
+
+```bash
+make airflow-docker-test-with-env
+```
+
+>>>>>>> afd4b2c1 (opening extension in right place)
 ## Documentation
 
 In order to run the documentation server, you will need to install the dependencies by running the following command.
@@ -90,6 +141,7 @@ make ui-up
 
 ## Developing the VSCode extension
 
+<<<<<<< HEAD
 Similar to UI development, you can also develop the VSCode extension. To do so, make sure you have the dependencies installed by running the following command inside the `vscode/extension` directory.
 
 ```bash
@@ -101,3 +153,37 @@ Once that is done, developing the VSCode extension is most easily done by launch
 ```bash 
 make vscode_settings
 ```
+=======
+Developing the VSCode extension is most easily done by launching the debug process from a visual studio code workspace.
+
+By default, the VSCode extension will run the SQLMesh server locally and open a new visual studio code window that allows you to try out the SQLMesh IDE. It by default opens the `examples/sushi` project. 
+
+Please see the below diagram for a high level overview of the UI.
+
+```mermaid
+graph TD
+    A[VSCode Extension] --> |start server| B[SQLMesh Server]
+    A --> |creates webviews| C[Webviews]
+    C --> |reads react webpages from| B
+    A --> |calls lsp| B
+    React[React App] --> |embedded in| B
+```
+
+For development purposes, the React app is not embedded into the python server. Instead a separate instance of the React app is run. This allows you to make changes to the UI and see them immediately.
+
+This makes the architecture diagram at development time look like the following.
+
+```mermaid
+graph TD
+    A[VSCode Extension] --> |start server| B[SQLMesh Server]
+    A --> |creates webviews| C[Webviews]
+    React [React Server] --> |passes on api requests| B
+    C --> |reads react webpages from| React
+```
+ 
+In development mode, the React app is not embedded into the python server. Instead a separate instance of the React app is run. This allows you to make changes to the UI and see them immediately.
+
+The React App runs on the port 5173. The VSCode extension will automatically open the React app in a new tab.
+The python server will run on the port 5174.
+
+>>>>>>> afd4b2c1 (opening extension in right place)