78 lines
6.4 KiB
Markdown
78 lines
6.4 KiB
Markdown
# BMC TPL Code All-Around
|
|
|
|
**Linter, Auto-Formatter, IntelliSense und Hover-Dokumentationen für die BMC TPL (Template Language).**[cite: 5]
|
|
|
|
Diese Visual Studio Code Erweiterung verwandelt deinen Editor in eine vollwertige Entwicklungsumgebung für BMC Discovery TPL-Skripte. Sie nimmt dir Tipparbeit ab, formatiert Code nach strengen Best Practices, verhindert Syntax-Fehler noch vor dem Deployment und versteht projektübergreifende Abhängigkeiten.[cite: 5]
|
|
|
|
---
|
|
|
|
## ✨ Features
|
|
|
|
### 🤖 Intelligenter Linter (Syntax-Scanner)
|
|
Der Linter analysiert den Code in Echtzeit und warnt vor typischen TPL-Fehlern:[cite: 5]
|
|
* **Strikte Hierarchie-Prüfung:** Überwacht die korrekte Reihenfolge der Blöcke innerhalb von Patterns und Syncmappings (`metadata` -> `overview` -> `constants` -> `triggers` -> `mapping`/`removal` -> `body`).[cite: 5]
|
|
* **Semicolon- & Zuweisungs-Check:** Findet fehlende Semikolons (ignoriert sie aber intelligent in `enumeration`-Blöcken) und warnt, wenn `=` anstelle von `:=` für Zuweisungen genutzt wird.[cite: 5]
|
|
* **Block- & Klammer-Tracking:** Erkennt nicht geschlossene Blöcke (wie fehlende `end body;` oder `end pattern;`) und findet ungeschlossene runde `(` oder eckige `[` Klammern.[cite: 5]
|
|
* **Pflichtfeld-Validierung:** Prüft, ob auf Modul-Ebene zwingend benötigte Metadaten (`origin`, `author`, `products`, `publishers`, `tree_path`) vorhanden sind und ob im `body` ein initiales `log.debug` Statement steht.[cite: 5]
|
|
* **Toleranz-Modus:** Erkennt automatisch TPL-Versionen (z.B. > 1.23) und stuft in neueren Versionen Fehler zu reinen Warnungen herab, um zukünftige Kompatibilität zu gewährleisten.[cite: 5]
|
|
|
|
### 🎨 Auto-Formatter & Visual Alignment (`Shift + Alt + F`)
|
|
Schluss mit kaputten Einrückungen! Der Formatter bringt deinen Code in Bestform:[cite: 5]
|
|
* **VS Code Standard:** Erzwingt strikt 4 Leerzeichen pro Einrückungs-Ebene.[cite: 5]
|
|
* **Dynamische Block-Einrückung:** Erkennt automatisch startende und endende Blöcke (`if`, `for`, `pattern`, `table` etc.) und passt die Einrückungsebene an.[cite: 5]
|
|
* **Klammer-Gedächtnis (Visual Alignment):** Die Königsdisziplin! Der Formatter merkt sich die spaltengenaue Position von geöffneten Arrays `[` oder Funktionsaufrufen `(` und richtet alle Folgezeilen makellos an dieser Klammer aus. Schließende Klammern werden auf Wunsch perfekt darunter platziert.[cite: 5]
|
|
|
|
### 💡 IntelliSense & Autovervollständigung (Cross-File)
|
|
Spart extrem viel Zeit beim Coden durch Kontext-Wissen:[cite: 5]
|
|
* **Workspace-Scanning:** Importierst du ein Modul (z.B. `from company.helpers import my_helper`), durchsucht das Plugin im Hintergrund dein gesamtes Projekt. Tippst du `my_helper.`, werden dir automatisch alle verfügbaren `define`-Methoden aus der fremden Datei vorgeschlagen![cite: 5]
|
|
* **Lokale Namespaces:** Erkennt `definitions`-Blöcke in der gleichen Datei und schlägt deren Methoden vor.[cite: 5]
|
|
* **Variablen-Tracking:** Lernt alle Variablen, die du mit `:=` definiert hast, und schlägt sie dir später vor.[cite: 5]
|
|
* **Log-Filter:** Nach dem Tippen von `log.` zeigt VS Code strikt nur noch die validen Methoden (`debug`, `info`, `warn`, `error`) an.[cite: 5]
|
|
|
|
### 🔍 Hover-Dokumentation (Tooltips)
|
|
Wenn du mit der Maus über einem Methodennamen, einem Pattern oder einer Tabelle stehen bleibst:[cite: 5]
|
|
* **DocString Extraction:** Das Plugin liest Multi-Line-Kommentare (`"""` oder `'''`), die direkt unter einer `define` oder `pattern` Deklaration stehen, aus und rendert sie als saubere Markdown-Tooltips.[cite: 5]
|
|
* **Projektübergreifend:** Funktioniert auch für Methoden aus importierten Dateien! Du musst die aktuelle Datei nicht mehr verlassen, um zu sehen, was eine Hilfsfunktion macht.[cite: 5]
|
|
|
|
### ⚡ Quick Fixes (Code Actions / Glühbirne)
|
|
Bietet sofortige Reparaturoptionen mit einem Klick:[cite: 5]
|
|
* **"Fehlende Modul-Metadaten einfügen":** Generiert sofort alle 5 Pflichtfelder im Modul-Metadata-Block.[cite: 5]
|
|
* **"Log-Statement einfügen":** Baut das fehlende `log.debug("Start pattern...");` direkt am Anfang des `body`-Blocks ein.[cite: 5]
|
|
* **"Tabs zu Spaces":** Ersetzt sofort alle illegalen Tabs (`\t`) in einer Zeile durch jeweils 4 korrekte Leerzeichen.[cite: 5]
|
|
|
|
---
|
|
|
|
## 🚀 Snippets (Code-Vorlagen)
|
|
|
|
Einfach das Keyword tippen und `Enter` drücken, um komplette, perfekt eingerückte Blöcke zu generieren:[cite: 5]
|
|
|
|
| Keyword | Beschreibung |
|
|
| :--- | :--- |
|
|
| `tpl_skeleton` | **God-Snippet**: Generiert eine komplett frische `.tpl` Datei inklusive Modul-Definition, Pflicht-Metadaten, Pattern, Triggern und Log-Statements. |[cite: 5]
|
|
| `pattern` | Baut einen leeren Pattern-Block inklusive DocString und `end pattern;`. |[cite: 5]
|
|
| `syncmapping` | Baut einen leeren Syncmapping-Block inklusive DocString. |[cite: 5]
|
|
| `define` | Generiert eine Methodendefinition (`define name(params) ... end define;`). |[cite: 5]
|
|
| `metadata`, `overview`, `body`... | Baut den jeweiligen Block auf und platziert den Cursor in der Mitte. |[cite: 5]
|
|
| `table` | Erstellt eine Tabelle inklusive des `default -> "unknown";` Fallbacks. |[cite: 5]
|
|
| `if`, `for` | Baut Standard-Schleifen und Abfragen. |[cite: 5]
|
|
|
|
---
|
|
|
|
## 🛠️ Installation & Nutzung
|
|
|
|
1. Das Plugin aktivieren. (Von den Releases das neuste runterladen und einfach die vsix datei in die Add-ons von Visual Studio Code ziehen)[cite: 5]
|
|
2. In einem Projekt mit TPL Dateien eine davon öffnen und die Analyse durchlaufen lassen.[cite: 5]
|
|
3. Der Linter startet automatisch bei jedem Tastendruck.[cite: 5]
|
|
4. **Formatieren:** Rechtsklick -> *Dokument formatieren* (oder `Shift + Alt + F`).[cite: 5]
|
|
5. **Autovervollständigung:** Triggert automatisch beim Tippen, speziell nach einem Punkt (`.`) bei Modul-Aufrufen.[cite: 5]
|
|
6. **Quick Fixes:** Auf die gelbe/rote Glühbirne am Zeilenanfang klicken oder `Ctrl + .` (Windows/Linux) / `Cmd + .` (Mac) drücken.[cite: 5]
|
|
|
|
---
|
|
|
|
## 📜 Lizenz
|
|
|
|
Dieses Projekt ist unter der **MIT License** lizenziert.[cite: 6]
|
|
|
|
Copyright (c) 2026 Thomas Wehnert[cite: 6]
|
|
|
|
Jedem, der eine Kopie dieser Software erhält, wird hiermit kostenlos die Erlaubnis erteilt, ohne Einschränkung mit der Software zu handeln, einschließlich und ohne Einschränkung der Rechte zur Nutzung, zum Kopieren, Ändern, Zusammenführen, Veröffentlichen, Verteilen, Unterlizenzieren und/oder Verkaufen von Kopien der Software, sofern der obige Urheberrechtshinweis und dieser Genehmigungshinweis in allen Kopien oder wesentlichen Teilen der Software enthalten sind.[cite: 6] Die Software wird "ohne Mängelgewähr" (as is) zur Verfügung gestellt.[cite: 6] |