BMC TPL Code All-Around

Linter, Auto-Formatter, IntelliSense und Hover-Dokumentationen für die BMC TPL (Template Language).

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.

---

✨ Features

🤖 Intelligenter Linter (Syntax-Scanner)

Der Linter analysiert den Code in Echtzeit, merkt sich Zustände über Zeilenumbrüche hinweg und warnt vor typischen TPL-Fehlern:

• Strikte Hierarchie-Prüfung: Überwacht die korrekte Reihenfolge der Blöcke innerhalb von Patterns und Syncmappings (metadata -> overview -> constants -> triggers -> mapping/removal -> body).
• Smarter Zuweisungs-Check: Findet fehlende Semikolons (toleriert sie aber in enumeration-Blöcken oder bei umgebrochenen Code-Zeilen). Warnt streng mit einem Fehler, wenn = anstelle von := für Variablenzuweisungen genutzt wird (außerhalb von legitimen if/where Vergleichen).
• Block- & Klammer-Tracking: Erkennt nicht geschlossene Blöcke (wie fehlende end body; oder end pattern;) und findet ungeschlossene runde ( oder eckige [ Klammern.
• 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.
• Versions-Prüfung: Gleicht die im Modul deklarierte TPL-Version mit der in deinen Settings definierten Version ab und warnt vor veralteten Skripten.

⚙️ Konfigurierbare Plugin-Einstellungen (Settings)

Personalisiere das Plugin direkt über die VS Code Benutzeroberfläche (File > Preferences > Settings > Extensions > BMC TPL Einstellungen):

• Standard Metadaten: Hinterlege deine eigenen Werte für Author, Publisher, Origin und den Tree Path. Diese werden beim Generieren neuer Module automatisch eingesetzt.
• TPL Zielversion: Definiere die TPL-Version (z.B. 23 für 1.23), für die du standardmäßig entwickelst.
• Live-Reload: Änderungen an den Einstellungen greifen sofort, ganz ohne Neustart des Editors.

🎨 Auto-Formatter & Visual Alignment (Shift + Alt + F)

Schluss mit kaputten Einrückungen! Der Formatter bringt deinen Code in Bestform:

• VS Code Standard: Erzwingt strikt 4 Leerzeichen pro Einrückungs-Ebene.
• Dynamische Block-Einrückung: Erkennt automatisch startende und endende Blöcke (if, for, pattern, table etc.) und passt die Einrückungsebene an.
• 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.

💡 IntelliSense & Autovervollständigung (Cross-File)

Spart extrem viel Zeit beim Coden durch massives Kontext-Wissen:

• Volle BMC Standard-Bibliothek: Nahtlose Integration aller Built-In Funktionen (z.B. discovery, number, text, model). Unterstützt Parameter-Überladungen (z.B. number.toText wahlweise mit oder ohne Basis) per Tab-Navigation.
• 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 vorgeschlagen.
• Lokale Namespaces: Erkennt definitions-Blöcke in der gleichen Datei und schlägt deren Methoden vor.
• Variablen-Tracking: Lernt alle Variablen, die du mit := definiert hast, und schlägt sie dir später vor.

🔍 Hover-Dokumentation (Tooltips)

Wenn du mit der Maus über einem Methodennamen, einem Pattern oder einer Tabelle stehen bleibst:

• Offizielle BMC Doku: Volle Integration der originalen, mehrzeiligen BMC Dokumentationen für alle eingebauten Funktionen (kein Browser mehr nötig!).
• DocString Extraction: Liest eigene Multi-Line-Kommentare (""" oder ''') aus, die unter define oder pattern Deklarationen stehen, und rendert sie als saubere Markdown-Tooltips (auch projektübergreifend!).

⚡ Quick Fixes (Code Actions / Glühbirne)

Bietet sofortige Reparaturoptionen mit einem Klick:

• "Fehlende Modul-Metadaten einfügen": Generiert sofort alle 5 Pflichtfelder im Modul-Metadata-Block.
• "Log-Statement einfügen": Baut das fehlende log.debug("Start pattern..."); direkt am Anfang des body-Blocks ein.
• "Tabs zu Spaces": Ersetzt sofort alle illegalen Tabs (\t) in einer Zeile durch jeweils 4 korrekte Leerzeichen.

---

🚀 Snippets (Code-Vorlagen)

Einfach das Keyword tippen und Enter drücken, um komplette, perfekt eingerückte Blöcke zu generieren:

Keyword	Beschreibung
tpl_skeleton	God-Snippet: Generiert ein komplett frisches TPL Modul. Nutzt automatisch deine hinterlegten Settings für Metadaten und Version.
pattern / syncmapping	Baut einen leeren Pattern/Syncmapping-Block inklusive DocString und End-Tag.
define	Generiert eine Methodendefinition (define name(params) ... end define;).
metadata, overview, body...	Baut den jeweiligen Block auf und platziert den Cursor in der Mitte.
table	Erstellt eine Tabelle inklusive des default -> "unknown"; Fallbacks.
if, elif, else	Baut bedingte Abfragen inkl. then und end if; und platziert den Cursor sauber bei der Bedingung.
for, while	Baut Standard-Schleifen inkl. do und End-Tag und lässt dich direkt iterieren.

---

🛠️ Installation & Nutzung

1. Das Plugin aktivieren. (Von den Releases das neueste herunterladen und einfach die .vsix Datei in die Add-ons von Visual Studio Code ziehen).
2. In einem Projekt mit TPL Dateien eine davon öffnen und die Analyse durchlaufen lassen.
3. Der Linter startet automatisch bei jedem Tastendruck.
4. Formatieren: Rechtsklick -> Dokument formatieren (oder Shift + Alt + F).
5. Autovervollständigung: Triggert automatisch beim Tippen, speziell nach einem Punkt (.) bei Modul-Aufrufen.
6. Quick Fixes: Auf die gelbe/rote Glühbirne am Zeilenanfang klicken oder Ctrl + . (Windows/Linux) / Cmd + . (Mac) drücken.

---

📜 Lizenz

Dieses Projekt ist unter der MIT License lizenziert.

Copyright (c) 2026 Thomas Wehnert

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. Die Software wird "ohne Mängelgewähr" (as is) zur Verfügung gestellt.