Add Lokale Entwicklung

kuro 2026-10-10 00:19:11 +00:00
parent 375336a0a6
commit 8f5b2171f8
1 changed files with 70 additions and 0 deletions

70
Lokale-Entwicklung.md Normal file

@ -0,0 +1,70 @@
# 💻 Lokale Entwicklung
Diese Seite beschreibt, wie du die **BMC TPL Code All around** Extension lokal auf deinem Rechner einrichtest, den Quellcode kompilierst und eigene Anpassungen testest.
---
## 🛠️ Voraussetzungen
Bevor du startest, stelle sicher, dass folgende Tools auf deinem System installiert sind:
* **Node.js** (inklusive `npm`)
* **Visual Studio Code**
* **Git**
* *(Optional, aber empfohlen)* `vsce` für das Bauen von `.vsix` Paketen (`npm install -g @vscode/vsce`)
---
## 🚀 Setup & Installation
1. **Repository klonen:**
```
git clone https://wiccafe.de/kuro/bmc-tpl-code-all-around.git
cd bmc-tpl-code-all-around
```
2. **Abhängigkeiten installieren:**
```
npm install
```
3. **Projekt in VS Code öffnen:**
```
code .
```
---
## 🔄 Entwicklungs-Workflow
Der Standard-Workflow für die Entwicklung von VS Code Extensions ist extrem komfortabel:
1. **Code ändern:** Nimm deine gewünschten Änderungen am TypeScript-Code im `src`-Ordner vor.
2. **Lokal ausführen (Debug-Modus):** Drücke einfach `F5` in VS Code.
* Im Hintergrund wird das Skript `npm run watch` gestartet (kompiliert TypeScript und esbuild automatisch bei jeder Änderung).
* Es öffnet sich ein neues, isoliertes VS Code-Fenster (der **Extension Development Host**). In diesem Fenster ist die Entwicklungsversion des Plugins sofort aktiv.
3. **Änderungen testen:** Öffne eine `.tpl` Datei im Development Host. Wenn du im Hauptfenster Code änderst, kannst du im Development Host einfach `Ctrl + R` (bzw. `Cmd + R`) drücken, um das Plugin sofort neu zu laden, ohne das Fenster schließen zu müssen.
---
## 📜 Wichtige Skripte
In der `package.json` sind verschiedene Hilfsskripte definiert, die du über das Terminal ausführen kannst:
| Befehl | Beschreibung |
| :--- | :--- |
| `npm run watch` | Startet den Compiler (esbuild & tsc) im Watch-Modus. Ideal für die laufende Entwicklung. |
| `npm run compile` | Kompiliert den Code einmalig (Typ-Check & esbuild). |
| `npm run lint` | Führt ESLint aus, um den Code auf saubere Formatierung und Syntaxfehler zu prüfen. |
| `npm run package` | Führt Checks durch und bündelt die Erweiterung in eine fertige `.vsix` Datei für den Release. |
| `npm run test` | Führt die automatisierten Tests (`vscode-test`) der Extension aus. |
---
## 📦 Release bauen (VSIX)
Wenn du eine neue Version fertiggestellt hast und sie im Gitea-Repository hochladen möchtest, baust du das Release-Paket mit:
```
npm run package
```
*(Dies setzt voraus, dass `vsce` global auf deinem System installiert ist.)*
Dieser Befehl generiert eine saubere `.vsix` Datei im Projektverzeichnis, die du direkt verteilen, hochladen oder in deiner regulären VS Code Instanz installieren kannst.