|
1 | | -<p align="center"><img src="https://raw.githubusercontent.com/simvia-tech/vs-code-aster/main/resources/images/simvia.png" alt="Simvia Logo" width="50%" /></p> |
| 1 | +<p align="center"><img src="https://raw.githubusercontent.com/simvia-tech/vs-code-aster/main/media/images/simvia.png" alt="Simvia Logo" width="50%" /></p> |
2 | 2 |
|
3 | 3 | <p align="center"> |
4 | | - <a href="/"><img src="https://img.shields.io/badge/version-1.4.3-blue" alt="Version" /></a> |
| 4 | + <a href="/"><img src="https://img.shields.io/badge/version-1.5.0-blue" alt="Version" /></a> |
5 | 5 | <a href="./LICENSE"><img src="https://img.shields.io/badge/license-GPL%203.0-green" alt="License" /></a> |
6 | 6 | </p> |
7 | 7 |
|
@@ -253,17 +253,41 @@ git clone https://github.com/simvia-tech/vs-code-aster.git |
253 | 253 | npm install |
254 | 254 | ``` |
255 | 255 |
|
256 | | -3. Compile extension : |
| 256 | +### 3. Architecture overview |
| 257 | + |
| 258 | +The extension consists of two independently compiled parts : |
| 259 | + |
| 260 | +- **Extension host** (`src/`) — TypeScript compiled with esbuild, runs in Node.js inside VS Code |
| 261 | +- **Webview** (`webviews/viewer/`) — Svelte 5 + Vite app that powers the 3D visualizer; built separately into `webviews/viewer/dist/` |
| 262 | + |
| 263 | +### 4. Running the extension locally |
| 264 | + |
| 265 | +Press `F5` (or go to `Run > Start Debugging`) to launch a new VS Code window running the extension. |
| 266 | + |
| 267 | +This starts three background watch tasks automatically (defined in `.vscode/tasks.json`) : |
| 268 | + |
| 269 | +| Task | What it does | |
| 270 | +|---|---| |
| 271 | +| `npm: watch:esbuild` | Recompiles the extension host on every save | |
| 272 | +| `npm: watch:tsc` | Type-checks the extension host continuously | |
| 273 | +| `npm: watch:webview` | Rebuilds the Svelte webview on every save | |
| 274 | + |
| 275 | +After making changes to the **extension host** (`src/`), reload the debug window with `Ctrl + R`. |
| 276 | + |
| 277 | +After making changes to the **webview** (`webviews/viewer/src/`), wait for the `watch:webview` task to finish rebuilding, then run `Developer: Reload Webviews` from the Command Palette. |
| 278 | + |
| 279 | +### 5. Building manually |
| 280 | + |
| 281 | +To build everything from scratch without starting the debug session : |
257 | 282 |
|
258 | 283 | ```bash |
| 284 | +# Build the webview |
| 285 | +npm run build:webview |
| 286 | + |
| 287 | +# Compile and type-check the extension host |
259 | 288 | npm run compile |
260 | 289 | ``` |
261 | 290 |
|
262 | | -### 3. Running the extension locally |
263 | | - |
264 | | -You can press `F5` or go to `Run > Start Debugging` to launch a new VS Code window running this extension. |
265 | | -After making changes, you can reload the new window using `Ctrl` + `R`. |
266 | | - |
267 | 291 | ## Telemetry |
268 | 292 |
|
269 | 293 | **VS Code Aster** includes optional telemetry features to help improve the tool by collecting anonymous usage data. |
|
0 commit comments