Add Installation & erste Schritte

kuro 2026-10-10 00:03:52 +00:00
parent 4a8d334ece
commit c6dcaa1970
1 changed files with 65 additions and 0 deletions

@ -0,0 +1,65 @@
# 🚀 Installation & Erste Schritte
Diese Seite führt dich durch die Installation der **BMC TPL Code All around** Extension in Visual Studio Code und zeigt dir, wie du direkt loslegen kannst.
---
## 📦 Installation (Der einfache Weg)
Da das Plugin aktuell über dieses Repository verteilt wird, kannst du es ganz bequem als `.vsix`-Paket (Visual Studio Extension) installieren.
1. Gehe in diesem Repository auf den Bereich **Releases**.
2. Lade dir die aktuellste Datei mit der Endung `.vsix` herunter (z.B. `bmc-tpl-code-all-around-0.0.1.vsix`).
3. Öffne **Visual Studio Code**.
4. Wechsle auf der linken Seitenleiste in den Bereich **Extensions / Erweiterungen** (`Ctrl + Shift + X`).
5. Klicke oben rechts im Extensions-Menü auf das **Drei-Punkte-Symbol (...)** und wähle **"Install from VSIX..."** (Aus VSIX installieren...).
6. Wähle die heruntergeladene `.vsix` Datei aus.
7. *Fertig!* VS Code meldet nach wenigen Sekunden, dass die Erweiterung erfolgreich installiert wurde.
Alternativ kannst du die heruntergeladene Datei auch per Drag'n'drop in den Marketplace von Visual Studio Code ziehen, Manuelle Updates kannst du so auch ausführen.
---
## 🛠️ Installation aus dem Quellcode (Für Entwickler)
Wenn du selbst an der Erweiterung mitarbeiten oder die aktuellste (vielleicht noch nicht releaste) Version testen willst, kannst du sie direkt aus dem Code kompilieren:
1. **Voraussetzungen:** Du benötigst [Node.js](https://nodejs.org/) und `npm` auf deinem System.
2. **Repository klonen:**
```bash
git clone [https://wiccafe.de/kuro/bmc-tpl-code-all-around.git](https://wiccafe.de/kuro/bmc-tpl-code-all-around.git)
cd bmc-tpl-code-all-around
npm install
```
3. Kompilieren & in VS Code starten:
Öffne den Ordner in VS Code. Drücke einfach F5. Daraufhin öffnet sich ein neues VS Code-Fenster ("Extension Development Host"), in dem das Plugin geladen und sofort einsatzbereit ist.
4. Eigene VSIX bauen:
Wenn du das Paket selbst schnüren willst, nutze den Befehl:
```
npm run package
```
(Hierfür muss vsce global installiert sein: npm install -g @vscode/vsce)
## 🏁 Erste Schritte
Sobald das Plugin installiert ist, wird es automatisch aktiviert, sobald du eine Datei mit der Endung .tpl öffnest.
Hier sind drei Dinge, die du sofort ausprobieren solltest:
1. Das Grundgerüst generieren
Erstelle eine leere Datei namens test.tpl. Tippe das Wort tpl ein. Die Autovervollständigung sollte dir nun das Snippet tpl_skeleton vorschlagen.
Drücke Enter oder Tab – und das komplette Modul-Grundgerüst (inklusive Metadaten, Pattern, Triggern und Log-Statement) wird generiert!
2. Die eigenen Daten hinterlegen
Damit du beim Generieren von neuen Dateien nicht immer deinen Namen und deine Firmenstruktur eintippen musst:
Öffne die VS Code Einstellungen (Ctrl + , oder über das Zahnrad unten links).
Suche nach TPL.
Trage unter BMC TPL Einstellungen deinen Namen (Author), den Publisher und den Start deines Tree-Paths ein.
Tipp: Diese Einstellungen werden sofort und ohne Neustart vom Plugin übernommen!
3. Den Linter ärgern
Lösche in deinem generierten Code absichtlich mal ein Semikolon am Ende einer Zeile oder ändere eine Zuweisung von := zu einem einfachen =. Der intelligente Linter sollte sofort anspringen und die Stelle rot oder gelb markieren. Fährst du mit der Maus darüber, wird dir genau erklärt, was falsch ist.