Skip to content

Commit 91a92e4

Browse files
authored
docs: improve development docs (#4404)
1 parent d7bcac0 commit 91a92e4

2 files changed

Lines changed: 15 additions & 27 deletions

File tree

docs/development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ In addition to the Python development, you can also develop the UI.
7979
The UI is built using React and Typescript. To run the UI, you will need to install the dependencies by running the following command.
8080

8181
```bash
82-
npm install
82+
pnpm install
8383
```
8484

8585
Run ide:
@@ -93,7 +93,7 @@ make ui-up
9393
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.
9494

9595
```bash
96-
npm install
96+
pnpm install
9797
```
9898

9999
Once that is done, developing the VSCode extension is most easily done by launching the `Run Extensions` debug task from a Visual Studio Code workspace opened at the root of the SQLMesh repository. 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 opens the `examples/sushi` project by default. To set up Visual Studio Code to run the `Run Extensions` debug task, you can run the following command which will copy the `launch.json` and `tasks.json` files to the `.vscode` directory.

tooling/vscode/tasks.json

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@
77
"label": "extension-watch",
88
"type": "shell",
99
"command": "pnpm run watch",
10-
"problemMatcher": "$ts-webpack-watch",
10+
"problemMatcher": {
11+
"base": "$ts-webpack-watch",
12+
"background": {
13+
"activeOnStart": true,
14+
"beginsPattern": "build started",
15+
"endsPattern": "build finished"
16+
}
17+
},
1118
"isBackground": true,
1219
"presentation": {
1320
"reveal": "never",
@@ -19,7 +26,6 @@
1926
"options": {
2027
"cwd": "${workspaceFolder}/vscode/extension"
2128
},
22-
"dependsOn": ["react-dev"],
2329
"dependsOrder": "parallel"
2430
},
2531
{
@@ -34,20 +40,21 @@
3440
},
3541
"isBackground": true,
3642
"problemMatcher": {
37-
"owner": "npm",
43+
"owner": "webpack",
3844
"pattern": {
3945
"regexp": "."
4046
},
4147
"background": {
4248
"activeOnStart": true,
43-
"beginsPattern": ".",
44-
"endsPattern": "."
49+
"beginsPattern": "Generating routes",
50+
"endsPattern": "built in"
4551
}
4652
},
4753
"presentation": {
4854
"reveal": "never",
4955
"group": "watchers"
50-
}
56+
},
57+
"dependsOrder": "parallel"
5158
},
5259
{
5360
"label": "extension-watch-develop",
@@ -57,25 +64,6 @@
5764
},
5865
"dependsOn": ["react-dev", "extension-watch"],
5966
"dependsOrder": "parallel"
60-
},
61-
{
62-
"type": "shell",
63-
"command": "pnpm run watch-tests",
64-
"problemMatcher": "$tsc-watch",
65-
"isBackground": true,
66-
"presentation": {
67-
"reveal": "never",
68-
"group": "watchers"
69-
},
70-
"group": "build",
71-
"options": {
72-
"cwd": "${workspaceFolder}/vscode"
73-
}
74-
},
75-
{
76-
"label": "tasks: watch-tests",
77-
"dependsOn": ["watch-tests"],
78-
"problemMatcher": []
7967
}
8068
]
8169
}

0 commit comments

Comments
 (0)