Compare commits
19 Commits
| Author | SHA1 | Date |
|---|---|---|
|
|
939d9073e6 | |
|
|
4f5b7fe1f0 | |
|
|
21e6833cb1 | |
|
|
a63c490276 | |
|
|
3b597e6df4 | |
|
|
1c160c3e1b | |
|
|
f3506cc10b | |
|
|
43bb2fa250 | |
|
|
0063862a24 | |
|
|
d6e97bea98 | |
|
|
387f3793df | |
|
|
9dcbf58f3a | |
|
|
13b873cf8f | |
|
|
00bdc8744d | |
|
|
b9035feb99 | |
|
|
9299eb6387 | |
|
|
bda2c0a069 | |
|
|
1910b0def2 | |
|
|
ba836ee30f |
|
|
@ -0,0 +1,46 @@
|
|||
name: Nightly Build
|
||||
|
||||
on:
|
||||
schedule:
|
||||
# Läuft jeden Tag um 02:00 Uhr nachts
|
||||
- cron: '0 2 * * *'
|
||||
# Erlaubt es dir, den Build im Gitea-Webinterface auch manuell per Button zu starten
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build-nightly:
|
||||
runs-on: ubuntu-latest # Pass das an das Label deines Gitea-Runners an
|
||||
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '24' # Passend zu deiner package.json Umgebung
|
||||
|
||||
- name: Install System Dependencies for Headless Tests
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y xvfb libx11-xcb1 libxcomposite1 libxcursor1 libxdamage1 libxi6 libxtst6 libnss3 libcups2 libxss1 libxrandr2 libasound2 libatk1.0-0 libatk-bridge2.0-0 libgtk-3-0
|
||||
|
||||
- name: Install NPM Packages
|
||||
run: npm ci
|
||||
|
||||
- name: Inject Nightly Version
|
||||
run: |
|
||||
NIGHTLY_DATE=$(date +%Y%m%d)
|
||||
sed -i "s/\"version\": \"\(.*\)\"/\"version\": \"\1-nightly-$NIGHTLY_DATE\"/" package.json
|
||||
echo "Building Nightly Version for $NIGHTLY_DATE..."
|
||||
|
||||
- name: Package & Test (with xvfb)
|
||||
# xvfb-run fängt die GUI-Aufrufe der VS Code Test-Engine ab
|
||||
run: xvfb-run -a npm run package
|
||||
|
||||
- name: Upload VSIX Artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: bmc-tpl-code-all-around-nightly
|
||||
path: '*.vsix'
|
||||
retention-days: 14
|
||||
129
README.md
129
README.md
|
|
@ -1,3 +1,108 @@
|
|||
English Description first - after that comes the German Version.
|
||||
|
||||
---
|
||||
|
||||
# BMC TPL Code All-Around
|
||||
|
||||
**Linter, Auto-Formatter, IntelliSense, and Hover Documentation for the BMC TPL (Topology Pattern Language).**
|
||||
|
||||
This Visual Studio Code extension transforms your editor into a fully-fledged development environment for BMC Discovery TPL scripts. It saves you typing, formats code according to strict best practices, prevents syntax errors before deployment, and understands cross-project dependencies.
|
||||
|
||||
---
|
||||
|
||||
## ✨ Features
|
||||
|
||||
### 🤖 Intelligent Linter (Syntax Scanner)
|
||||
The linter analyzes the code in real-time, remembers states across line breaks, and warns you about typical TPL errors:
|
||||
* **Strict Hierarchy Checking:** Monitors the correct order of blocks within patterns and syncmappings (`metadata` -> `overview` -> `constants` -> `triggers` -> `mapping`/`removal` -> `body`).
|
||||
* **Smart Assignment Check:** Finds missing semicolons (but tolerates them in `enumeration` blocks or multi-line statements). Warns strictly with an error if `=` is used instead of `:=` for variable assignments (outside of legitimate `if`/`where` comparisons).
|
||||
* **Block & Bracket Tracking:** Detects unclosed blocks (like missing `end body;` or `end pattern;`) and finds unclosed parentheses `(` or brackets `[`.
|
||||
* **Mandatory Field Validation:** Checks if mandatory module-level metadata (`origin`, `author`, `products`, `publishers`, `tree_path`) are present based on your dynamic compliance settings, and if an initial `log.debug` statement exists in the `body`.
|
||||
* **Indentation Checking:** Instantly highlights messy indentation (any space count that is not a clean multiple of 4) with a warning, reminding you to use the Auto-Formatter.
|
||||
* **Unbreakable Lexer (New):** Built-in state-machine lexer correctly parses complex strings, triple-quotes (`"""`), and comments, ensuring accurate parameter counting and avoiding false-positive errors on complex TPL syntax.
|
||||
* **Version Checking:** Compares the TPL version declared in the module with the target version defined in your settings and warns about outdated scripts.
|
||||
|
||||
### ⚙️ Configurable Plugin Settings & Compliance
|
||||
Personalize the plugin directly via the VS Code user interface (File > Preferences > Settings > Extensions > BMC TPL Settings):
|
||||
* **Metadata Compliance:** Define exact compliance rules for your workspace. Choose which metadata fields are mandatory and configure the `tree_path` strictly (e.g., minimum depth and forced static base nodes like `['MyCompany', 'IT']`).
|
||||
* **Default Metadata:** Store your own values for `Author`, `Publisher`, `Origin`, etc. These are automatically inserted when generating new modules.
|
||||
* **TPL Target Version:** Define the default TPL version (e.g., `23` for 1.23) you are developing for.
|
||||
* **Live Reload:** Changes to settings take effect immediately, no editor restart required.
|
||||
|
||||
### 🎨 Auto-Formatter & Visual Alignment (`Shift + Alt + F`)
|
||||
No more broken indentations! The formatter gets your code in top shape:
|
||||
* **VS Code Standard:** Strictly enforces 4 spaces per indentation level.
|
||||
* **Dynamic Block Indentation:** Automatically detects starting and ending blocks (`if`, `for`, `pattern`, `table`, etc.) and adjusts the indentation level.
|
||||
* **Bracket Memory (Visual Alignment):** The ultimate discipline! The formatter remembers the exact column position of opened arrays `[` or function calls `(` and flawlessly aligns all subsequent lines to this bracket.
|
||||
* **Uncompromising Cleanup (New):** Automatically strips all non-standard indentation (like 2, 3, or 6 spaces) and replaces it with exact, mathematically calculated 4-space blocks.
|
||||
|
||||
### 💡 IntelliSense & Autocomplete (Cross-File)
|
||||
Saves an extreme amount of coding time through massive context awareness:
|
||||
* **"Go to Definition" (New):** Instantly navigate your codebase! `Ctrl+Click` (or `F12`) on any function call to jump directly to its declaration. Searches locally first and falls back to the RAM-based workspace index for cross-file jumps.
|
||||
* **Dynamic Taxonomy Support (New):** Full autocomplete support for dynamic BMC scopes. Typing `model.` suggests generic `<NodeKind>` constructors, while `model.rel.` offers dynamic `<Relationship>` constructors with ready-to-use snippets.
|
||||
* **Full BMC Standard Library:** Seamless integration of all built-in functions (e.g., `discovery`, `number`, `text`, `model`). Supports parameter overloads (e.g., `number.toText` optionally with or without a base) via Tab navigation.
|
||||
* **Workspace Scanning:** If you import a module (e.g., `from company.helpers import my_helper`), the plugin scans your entire project in the background. If you type `my_helper.`, it automatically suggests all available `define` methods.
|
||||
* **Case-Insensitive Resolution (New):** All method lookups (both Core and TKU) are completely case-insensitive, meaning `rdbms_functions.xyz` works just as flawlessly as `RDBMS_Functions.Xyz`.
|
||||
* **Local Namespaces:** Detects `definitions` blocks in the same file and suggests their methods.
|
||||
* **Variable Tracking:** Learns all variables you have defined with `:=` and suggests them to you later.
|
||||
|
||||
### 🔍 Hover Documentation (Tooltips)
|
||||
When you hover over a method name, a pattern, or a table:
|
||||
* **Official BMC Docs:** Full integration of the original, multi-line BMC documentation for all built-in functions loaded dynamically (no browser needed anymore!).
|
||||
* **DocString Extraction:** Reads custom multi-line comments (`"""` or `'''`) placed under `define` or `pattern` declarations and renders them as clean Markdown tooltips (even cross-project!).
|
||||
|
||||
### ⚡ Quick Fixes (Code Actions / Lightbulb)
|
||||
Offers immediate repair options with a single click:
|
||||
* **"Insert missing module metadata":** Instantly generates missing mandatory fields in the module metadata block based on your workspace compliance settings.
|
||||
* **"Insert log statement":** Adds the missing `log.debug("Start pattern...");` right at the beginning of the `body` block.
|
||||
* **"Tabs to Spaces":** Instantly replaces all illegal tabs (`\t`) in a line with 4 correct spaces each.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Snippets (Code Templates)
|
||||
|
||||
Just type the keyword and press `Enter` to generate complete, perfectly indented blocks:
|
||||
|
||||
| Keyword | Description |
|
||||
| :--- | :--- |
|
||||
| `tpl_skeleton` | **God-Snippet**: Generates a completely fresh TPL module. Automatically uses your configured compliance rules, settings, and dynamic tree paths. |
|
||||
| `metadata` | **Context-Aware**: Knows where your cursor is. Generates a full module block at the top, or a compact pattern block inside a pattern. |
|
||||
| `pattern` / `syncmapping` | Builds an empty pattern/syncmapping block including DocString and end-tag. |
|
||||
| `define` | Generates a method definition (`define name(params) ... end define;`). |
|
||||
| `overview`, `body`... | Builds the respective block and places the cursor right in the middle. |
|
||||
| `table` | Creates a table including the `default -> "unknown";` fallback. |
|
||||
| `if`, `elif`, `else` | Builds conditional statements incl. `then` and `end if;`, placing the cursor neatly at the condition. |
|
||||
| `for`, `while` | Builds standard loops incl. `do` and end-tag, letting you iterate directly. |
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Installation & Usage
|
||||
|
||||
1. Activate the plugin. (Download the latest from the releases and simply drag the `.vsix` file into the Visual Studio Code add-ons).
|
||||
2. Open a TPL file in your project and let the analysis run.
|
||||
3. The linter starts automatically with every keystroke.
|
||||
4. **Formatting:** Right-click -> *Format Document* (or `Shift + Alt + F`).
|
||||
5. **Autocomplete:** Triggers automatically while typing, especially after a dot (`.`) during module calls.
|
||||
6. **Navigation:** Press `Ctrl` + Click (or `F12`) to jump to function definitions.
|
||||
7. **Quick Fixes:** Click the yellow/red lightbulb at the beginning of the line or press `Ctrl + .` (Windows/Linux) / `Cmd + .` (Mac).
|
||||
|
||||
---
|
||||
|
||||
## 📜 License
|
||||
|
||||
This project is licensed under the **MIT License**.
|
||||
|
||||
Copyright (c) 2026 Thomas Wehnert
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED.
|
||||
|
||||
---
|
||||
---
|
||||
|
||||
# BMC TPL Code All-Around
|
||||
|
||||
**Linter, Auto-Formatter, IntelliSense und Hover-Dokumentationen für die BMC TPL (Template Language).**
|
||||
|
|
@ -13,12 +118,15 @@ Der Linter analysiert den Code in Echtzeit, merkt sich Zustände über Zeilenumb
|
|||
* **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.
|
||||
* **Pflichtfeld-Validierung:** Prüft basierend auf deinen dynamischen Compliance-Settings, ob auf Modul-Ebene zwingend benötigte Metadaten (`origin`, `author`, `tree_path` etc.) vorhanden sind und ob im `body` ein initiales `log.debug` Statement steht.
|
||||
* **Einrückungs-Prüfung:** Ein Check im Hintergrund markiert unsaubere Einrückungen (alles, was kein sauberes Vielfaches von 4 Leerzeichen ist) sofort mit einer Warnung, um an den Auto-Formatter zu erinnern.
|
||||
* **Unzerstörbarer Lexer (Neu):** Ein eingebauter State-Machine-Lexer verarbeitet komplexe Strings, Triple-Quotes (`"""`) und Kommentare fehlerfrei. Dadurch zählt der Linter Parameter immer korrekt und wirft keine falschen Fehler bei komplexer TPL-Syntax.
|
||||
* **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)
|
||||
### ⚙️ Konfigurierbare Plugin-Einstellungen & Compliance
|
||||
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.
|
||||
* **Metadaten-Compliance:** Definiere exakte Regeln für deinen Workspace. Wähle, welche Felder Pflicht sind und konfiguriere den `tree_path` strikt (z.B. Mindest-Ebenen und feste Basis-Nodes wie `['MeineFirma', 'IT']`).
|
||||
* **Standard Metadaten:** Hinterlege deine eigenen Werte für `Author`, `Publisher`, `Origin` etc. 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.
|
||||
|
||||
|
|
@ -27,11 +135,15 @@ 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.
|
||||
* **Kompromisslose Bereinigung (Neu):** Unsaubere Einrückungen (z.B. 2, 3 oder 6 Leerzeichen) werden restlos rasiert und durch exakt berechnete 4-Space-Blöcke ersetzt.
|
||||
|
||||
### 💡 IntelliSense & Autovervollständigung (Cross-File)
|
||||
Spart extrem viel Zeit beim Coden durch massives Kontext-Wissen:
|
||||
* **"Go to Definition" (Neu):** Navigiere sofort durch deine Codebase! `Strg+Klick` (oder `F12`) auf einen Funktionsaufruf springt direkt zur Deklaration. Sucht erst lokal und weicht für dateiübergreifende Aufrufe blitzschnell auf den RAM-Index aus.
|
||||
* **Dynamische Taxonomie (Neu):** Voller Support für dynamische BMC-Scopes. Das Tippen von `model.` schlägt einen generischen `<NodeKind>`-Konstruktor vor, während `model.rel.` dynamische `<Relationship>`-Konstruktoren mit fertigen Snippets anbietet.
|
||||
* **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.
|
||||
* **Case-Insensitive Auswertung (Neu):** Alle Methoden (Core und TKU) werden nun komplett groß-/kleinschreibungsunabhängig aufgelöst (`rdbms_functions.xyz` funktioniert genauso tadellos wie `RDBMS_Functions.Xyz`).
|
||||
* **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.
|
||||
|
||||
|
|
@ -42,7 +154,7 @@ Wenn du mit der Maus über einem Methodennamen, einem Pattern oder einer Tabelle
|
|||
|
||||
### ⚡ 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.
|
||||
* **"Fehlende Modul-Metadaten einfügen":** Generiert sofort alle fehlenden Pflichtfelder im Modul-Metadata-Block, basierend auf deinen Compliance-Settings.
|
||||
* **"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.
|
||||
|
||||
|
|
@ -54,10 +166,11 @@ Einfach das Keyword tippen und `Enter` drücken, um komplette, perfekt eingerüc
|
|||
|
||||
| Keyword | Beschreibung |
|
||||
| :--- | :--- |
|
||||
| `tpl_skeleton` | **God-Snippet**: Generiert ein komplett frisches TPL Modul. Nutzt automatisch deine hinterlegten Settings für Metadaten und Version. |
|
||||
| `tpl_skeleton` | **God-Snippet**: Generiert ein komplett frisches TPL Modul. Nutzt automatisch deine hinterlegten Settings, dynamischen Tree-Paths und Compliance-Regeln. |
|
||||
| `metadata` | **Kontext-sensitiv**: Weiß genau, wo dein Cursor steht. Generiert einen großen Modul-Block ganz oben oder einen kompakten Pattern-Block innerhalb eines Patterns. |
|
||||
| `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. |
|
||||
| `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. |
|
||||
|
|
@ -71,7 +184,8 @@ Einfach das Keyword tippen und `Enter` drücken, um komplette, perfekt eingerüc
|
|||
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.
|
||||
6. **Navigieren:** Mit `Strg` + Klick (oder `F12`) direkt zu Funktionsdefinitionen springen.
|
||||
7. **Quick Fixes:** Auf die gelbe/rote Glühbirne am Zeilenanfang klicken oder `Ctrl + .` (Windows/Linux) / `Cmd + .` (Mac) drücken.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -82,3 +196,4 @@ 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.
|
||||
```eof
|
||||
|
|
@ -0,0 +1 @@
|
|||
npm run lint -- --fix
|
||||
64
package.json
64
package.json
|
|
@ -35,34 +35,81 @@
|
|||
"main": "./dist/extension.js",
|
||||
"contributes": {
|
||||
"configuration": {
|
||||
"title": "BMC TPL Einstellungen",
|
||||
"title": "BMC TPL Settings",
|
||||
"properties": {
|
||||
"tpl.metadata.author": {
|
||||
"type": "string",
|
||||
"default": "Autor",
|
||||
"description": "Standard-Autor für neu generierte TPL-Module."
|
||||
"description": "Standard-Author for new generated TPL-Modules."
|
||||
},
|
||||
"tpl.metadata.origin": {
|
||||
"type": "string",
|
||||
"default": "Custom",
|
||||
"description": "Standard-Origin für neu generierte TPL-Module."
|
||||
"description": "Standard-Origin for new generated TPL-Modules."
|
||||
},
|
||||
"tpl.metadata.publisher": {
|
||||
"type": "string",
|
||||
"default": "IT-Operations",
|
||||
"description": "Standard-Publisher für neu generierte TPL-Module."
|
||||
"description": "Standard-Publisher for new generated TPL-Modules."
|
||||
},
|
||||
"tpl.metadata.treePathBase": {
|
||||
"type": "string",
|
||||
"default": "Company",
|
||||
"description": "Erster Teil (Basis) des tree_paths in den Metadaten."
|
||||
"description": "First Part (Basis) of the tree_paths in the Metadata."
|
||||
},
|
||||
"tpl.metadata.require.origin": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "Marks 'origin' as Required on module level."
|
||||
},
|
||||
"tpl.metadata.require.author": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "Marks 'author' as Required on module level."
|
||||
},
|
||||
"tpl.metadata.require.products": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "Marks 'products' aas Required on module level."
|
||||
},
|
||||
"tpl.metadata.require.publishers": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "Marks 'publishers' as Required on module level."
|
||||
},
|
||||
"tpl.metadata.require.treePath": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "Marks 'tree_path' as Required on module level."
|
||||
},
|
||||
"tpl.metadata.treePath.minLevels": {
|
||||
"type": "number",
|
||||
"default": 3,
|
||||
"description": "How many levels should the tree_path in Metadata at least have? (e.g. 3 for 'Base', 'Category', 'Subcategory')."
|
||||
},
|
||||
"tpl.metadata.treePath.staticNodes": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"default": [""],
|
||||
"description": "Fixed definitions for the tree_path left to right (e.g. ['Company', 'Software']). The rest of the levels are free to choose."
|
||||
},
|
||||
"tpl.version": {
|
||||
"type": "number",
|
||||
"default": 23,
|
||||
"description": "Aktuelle TPL-Nebenversion (z. B. 23 für TPL 1.23). Wird genutzt um veraltete Module zu erkennen und beim Generieren eingefügt."
|
||||
"description": "Current TPL-Subversion (e. g. 23 for TPL 1.23). Used to find old Modules and for auto generating the sceleton."
|
||||
},
|
||||
"tpl.rules.requireBodyLog": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "Require a log.debug statement at the start of a pattern's body phase."
|
||||
}
|
||||
},
|
||||
"commands": [
|
||||
{
|
||||
"command": "tpl.scanWorkspace",
|
||||
"title": "TPL: Gesamten Workspace prüfen"
|
||||
}
|
||||
]
|
||||
},
|
||||
"languages": [
|
||||
{
|
||||
|
|
@ -86,13 +133,14 @@
|
|||
"watch": "npm-run-all -p watch:*",
|
||||
"watch:esbuild": "node esbuild.js --watch",
|
||||
"watch:tsc": "tsc --noEmit --watch --project tsconfig.json",
|
||||
"package": "npm run check-types && npm run lint && node esbuild.js --production",
|
||||
"package": "npm run check-types && npm run lint && npm run test && node esbuild.js --production",
|
||||
"compile-tests": "tsc -p . --outDir out",
|
||||
"watch-tests": "tsc -p . -w --outDir out",
|
||||
"pretest": "npm run compile-tests && npm run compile && npm run lint",
|
||||
"check-types": "tsc --noEmit",
|
||||
"lint": "eslint src",
|
||||
"test": "vscode-test"
|
||||
"test": "vscode-test",
|
||||
"generate-builtins": "python scripts/generate_builtins.py ."
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/vscode": "^1.140.0",
|
||||
|
|
|
|||
|
|
@ -14,6 +14,10 @@ export class LinterContext {
|
|||
public inMultiLineComment = false;
|
||||
public inConditionBlock = false;
|
||||
|
||||
// Multi-Line Import-Tracking
|
||||
public inImportBlock = false;
|
||||
public currentImportModule = "";
|
||||
|
||||
// String-Tracking (Basis-Lexer)
|
||||
public inTripleDouble = false;
|
||||
public inTripleSingle = false;
|
||||
|
|
@ -29,12 +33,13 @@ export class LinterContext {
|
|||
public inModuleMetadata = false;
|
||||
public hasModuleMetadata = false;
|
||||
public moduleMetadataBlockLine = -1;
|
||||
public foundModuleMetadata = { origin: false, author: false, products: false, publishers: false, tree_path: false };
|
||||
public foundModuleMetadata = new Set<string>();
|
||||
|
||||
// Klammer-Tracking
|
||||
public parenStack: number[] = [];
|
||||
public bracketStack: number[] = [];
|
||||
public openDefines: number[] = [];
|
||||
public openControlBlocks: { type: string, lineIdx: number }[] = [];
|
||||
|
||||
public addDiag(lineIdx: number, start: number, end: number, msg: string, severity: vscode.DiagnosticSeverity): vscode.Diagnostic {
|
||||
const diag = new vscode.Diagnostic(new vscode.Range(lineIdx, start, lineIdx, end), msg, severity);
|
||||
|
|
|
|||
|
|
@ -1,43 +1,38 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { LinterContext } from './LinterContext';
|
||||
import { LinterRule } from './rules/LinterRule';
|
||||
import { SyntaxRule } from './rules/SyntaxRule';
|
||||
import { BlockRule } from './rules/BlockRule';
|
||||
import { MetadataRule } from './rules/MetadataRule';
|
||||
import { IndentationRule } from './rules/IndentationRule';
|
||||
import { ParameterRule } from './rules/ParameterRule';
|
||||
|
||||
export function validateTplDocument(document: vscode.TextDocument, collection: vscode.DiagnosticCollection) {
|
||||
if (document.languageId !== 'tpl') { return; }
|
||||
|
||||
const ctx = new LinterContext();
|
||||
const config = vscode.workspace.getConfiguration('tpl');
|
||||
ctx.configuredTplVersion = config.get<number>('version', 23);
|
||||
if (document.languageId !== 'tpl') {return;}
|
||||
|
||||
const text = document.getText();
|
||||
const lines = text.split('\n');
|
||||
const ctx = new LinterContext();
|
||||
|
||||
// 1. Version prüfen
|
||||
const versionMatch = text.match(/tpl\s+1\.(\d+)\s+module/);
|
||||
if (versionMatch) {
|
||||
ctx.tplVersion = parseInt(versionMatch[1], 10);
|
||||
if (ctx.tplVersion < ctx.configuredTplVersion) {
|
||||
const linesToSearch = text.substring(0, versionMatch.index! + 30).split('\n');
|
||||
ctx.addDiag(linesToSearch.length - 1, 0, versionMatch[0].length, `Das Modul nutzt eine alte TPL Version (1.${ctx.tplVersion}). Aktuell in den Settings definiert ist 1.${ctx.configuredTplVersion}.`, vscode.DiagnosticSeverity.Warning);
|
||||
}
|
||||
}
|
||||
|
||||
// 2. Regeln laden
|
||||
const rules: LinterRule[] = [
|
||||
const rules = [
|
||||
new IndentationRule(),
|
||||
new SyntaxRule(),
|
||||
new BlockRule()
|
||||
new MetadataRule(),
|
||||
new BlockRule(),
|
||||
new ParameterRule()
|
||||
];
|
||||
|
||||
// 3. Zeilenweise iterieren
|
||||
for (let i = 0; i < lines.length; i++) {
|
||||
const rawLine = lines[i];
|
||||
const line = rawLine.trim();
|
||||
|
||||
ctx.resetLineStates();
|
||||
|
||||
// Basis-Lexer: Strings & Kommentare tracken (läuft vor den Regeln!)
|
||||
// NEU: TODO-Check hier im Linter, BEVOR Kommentare ignoriert werden!
|
||||
const todoMatch = rawLine.match(/\bTODO\b\s*:?\s*(.*)/i);
|
||||
if (todoMatch) {
|
||||
ctx.addDiag(i, todoMatch.index!, rawLine.length, `TODO: ${todoMatch[1].trim()}`, vscode.DiagnosticSeverity.Information);
|
||||
}
|
||||
|
||||
trackStrings(rawLine, line, ctx);
|
||||
|
||||
if (ctx.isInternalStringLine && (ctx.inTripleDouble || ctx.inTripleSingle)) { continue; }
|
||||
|
|
@ -54,18 +49,17 @@ export function validateTplDocument(document: vscode.TextDocument, collection: v
|
|||
|
||||
// Regeln anwenden
|
||||
for (const rule of rules) {
|
||||
rule.checkLine(line, rawLine, i, ctx, lines); // Hier 'lines' ergänzen!
|
||||
rule.checkLine(line, rawLine, i, ctx, lines);
|
||||
}
|
||||
}
|
||||
|
||||
// 4. Abschluss-Prüfungen durchführen
|
||||
// Sicherer Aufruf für alle Regeln
|
||||
for (const rule of rules) {
|
||||
if (rule.checkEnd) {
|
||||
rule.checkEnd(lines, ctx);
|
||||
}
|
||||
}
|
||||
|
||||
// Diagnostics an VS Code übergeben
|
||||
collection.set(document.uri, ctx.diagnostics);
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,41 @@
|
|||
import { tplBuiltIns } from '../data/TplBuiltIns';
|
||||
import { generatedTplBuiltIns } from '../data/GeneratedTplBuiltIns';
|
||||
|
||||
export class TplLookup {
|
||||
// Holt eine spezifische Methode (Case-Insensitive)
|
||||
public static getBuiltInFunction(namespace: string, funcName: string): any | null {
|
||||
const nsLower = namespace.toLowerCase();
|
||||
const fnLower = funcName.toLowerCase();
|
||||
|
||||
// 1. Suche in Core Built-Ins (discovery, model, etc.)
|
||||
const coreKey = Object.keys(tplBuiltIns).find(k => k.toLowerCase() === nsLower);
|
||||
if (coreKey) {
|
||||
const methods = (tplBuiltIns as any)[coreKey];
|
||||
const mKey = Object.keys(methods).find(k => k.toLowerCase() === fnLower);
|
||||
if (mKey) {return methods[mKey];}
|
||||
}
|
||||
|
||||
// 2. Suche in Generierten TKU Built-Ins (rdbms_functions, etc.)
|
||||
const tkuKey = Object.keys(generatedTplBuiltIns).find(k => k.toLowerCase() === nsLower);
|
||||
if (tkuKey) {
|
||||
const methods = (generatedTplBuiltIns as any)[tkuKey];
|
||||
const mKey = Object.keys(methods).find(k => k.toLowerCase() === fnLower);
|
||||
if (mKey) {return methods[mKey];}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
// Holt alle Methoden eines Moduls für die Autovervollständigung (Case-Insensitive)
|
||||
public static getAllMethodsForNamespace(namespace: string): Record<string, any> | null {
|
||||
const nsLower = namespace.toLowerCase();
|
||||
|
||||
const coreKey = Object.keys(tplBuiltIns).find(k => k.toLowerCase() === nsLower);
|
||||
if (coreKey) {return (tplBuiltIns as any)[coreKey];}
|
||||
|
||||
const tkuKey = Object.keys(generatedTplBuiltIns).find(k => k.toLowerCase() === nsLower);
|
||||
if (tkuKey) {return (generatedTplBuiltIns as any)[tkuKey];}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,133 @@
|
|||
import * as vscode from 'vscode';
|
||||
|
||||
export interface TplFunctionSignature {
|
||||
name: string;
|
||||
moduleName: string;
|
||||
params: string[];
|
||||
docString?: string;
|
||||
hasReturnValue?: boolean;
|
||||
lineIdx: number; // NEU: Für 'Go to Definition'
|
||||
fsPath: string; // NEU: Für 'Go to Definition'
|
||||
}
|
||||
|
||||
export class WorkspaceIndex {
|
||||
private fileIndex = new Map<string, Map<string, TplFunctionSignature>>();
|
||||
private fileModules = new Map<string, string>();
|
||||
private moduleDefinitions = new Map<string, Set<string>>();
|
||||
|
||||
public updateFile(uri: vscode.Uri, text: string) {
|
||||
if (!uri.fsPath.endsWith('.tpl')) {return;}
|
||||
|
||||
const fsPath = uri.fsPath;
|
||||
const lines = text.split('\n');
|
||||
let currentModule = "";
|
||||
let currentDefBlock = "";
|
||||
const functions = new Map<string, TplFunctionSignature>();
|
||||
const defBlocks = new Set<string>();
|
||||
|
||||
const modMatch = text.match(/tpl\s+1\.\d+\s+module\s+([a-zA-Z0-9_.]+)\s*;/);
|
||||
if (modMatch) {
|
||||
currentModule = modMatch[1];
|
||||
}
|
||||
this.fileModules.set(fsPath, currentModule);
|
||||
|
||||
for (let i = 0; i < lines.length; i++) {
|
||||
const line = lines[i];
|
||||
|
||||
const defBlockMatch = line.match(/^\s*definitions?\s+([a-zA-Z0-9_]+)/);
|
||||
if (defBlockMatch) {
|
||||
currentDefBlock = defBlockMatch[1];
|
||||
defBlocks.add(currentDefBlock);
|
||||
continue;
|
||||
}
|
||||
if (line.match(/^\s*end\s+definitions?/)) {
|
||||
currentDefBlock = "";
|
||||
continue;
|
||||
}
|
||||
|
||||
const structMatch = line.match(/^\s*(?:pattern|syncmapping|table)\s+([a-zA-Z0-9_]+)/);
|
||||
if (structMatch) {
|
||||
defBlocks.add(structMatch[1]);
|
||||
}
|
||||
|
||||
const defineMatch = line.match(/^\s*define\s+([a-zA-Z0-9_]+)\b(?:\s*\((.*?)\))?/);
|
||||
if (defineMatch) {
|
||||
const funcName = defineMatch[1];
|
||||
const paramString = defineMatch[2] || "";
|
||||
const fullName = currentDefBlock ? `${currentDefBlock}.${funcName}` : funcName;
|
||||
const params = paramString.split(',').map(p => p.trim()).filter(p => p.length > 0);
|
||||
|
||||
let docString = undefined;
|
||||
const textAfterDefine = text.substring(text.indexOf(line) + line.length);
|
||||
const docMatch = textAfterDefine.match(/^\s*(?:"""|''')([\s\S]*?)(?:"""|''')/);
|
||||
if (docMatch) { docString = docMatch[1].trim(); }
|
||||
|
||||
let hasReturnValue = false;
|
||||
for (let j = i + 1; j < lines.length; j++) {
|
||||
if (lines[j].match(/^\s*end\s+define/)) {break;}
|
||||
if (lines[j].match(/^\s*return\b/)) {
|
||||
hasReturnValue = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
functions.set(fullName, {
|
||||
name: fullName,
|
||||
moduleName: currentModule,
|
||||
params: params,
|
||||
docString: docString,
|
||||
hasReturnValue: hasReturnValue,
|
||||
lineIdx: i,
|
||||
fsPath: fsPath
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
this.fileIndex.set(fsPath, functions);
|
||||
if (currentModule) {
|
||||
this.moduleDefinitions.set(currentModule, defBlocks);
|
||||
}
|
||||
}
|
||||
|
||||
public removeFile(uri: vscode.Uri) {
|
||||
const moduleName = this.fileModules.get(uri.fsPath);
|
||||
if (moduleName) {
|
||||
this.moduleDefinitions.delete(moduleName);
|
||||
}
|
||||
this.fileIndex.delete(uri.fsPath);
|
||||
this.fileModules.delete(uri.fsPath);
|
||||
}
|
||||
|
||||
public getAllModules(): string[] {
|
||||
return Array.from(this.moduleDefinitions.keys());
|
||||
}
|
||||
|
||||
public getDefinitionBlocksForModule(moduleName: string): string[] {
|
||||
const blocks = this.moduleDefinitions.get(moduleName);
|
||||
return blocks ? Array.from(blocks) : [];
|
||||
}
|
||||
|
||||
public getFunctionsForModule(moduleName: string): TplFunctionSignature[] {
|
||||
const result: TplFunctionSignature[] = [];
|
||||
for (const [fsPath, map] of this.fileIndex.entries()) {
|
||||
if (this.fileModules.get(fsPath) === moduleName) {
|
||||
result.push(...map.values());
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
public getFunctionSignatures(funcName: string): TplFunctionSignature[] {
|
||||
const result: TplFunctionSignature[] = [];
|
||||
for (const map of this.fileIndex.values()) {
|
||||
for (const sig of map.values()) {
|
||||
if (sig.name === funcName || sig.name.endsWith(`.${funcName}`)) {
|
||||
result.push(sig);
|
||||
}
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
||||
export const workspaceIndex = new WorkspaceIndex();
|
||||
|
|
@ -4,35 +4,27 @@ import { LinterContext, PatternPhase } from '../LinterContext';
|
|||
|
||||
export class BlockRule implements LinterRule {
|
||||
|
||||
// HIER GEFIXT: 'lines: string[]' wurde zur Signatur hinzugefügt!
|
||||
public checkLine(line: string, rawLine: string, lineIdx: number, ctx: LinterContext, lines: string[]): void {
|
||||
if (!ctx.hasModuleDef) {
|
||||
if (line.startsWith('tpl ')) { ctx.hasModuleDef = true; }
|
||||
else { ctx.addDiag(lineIdx, 0, rawLine.length, "Jede Datei muss mit 'tpl 1.x module <name>;' beginnen.", vscode.DiagnosticSeverity.Error); ctx.hasModuleDef = true; }
|
||||
else { ctx.addDiag(lineIdx, 0, rawLine.length, "Every file must start with 'tpl 1.x module <name>;'.", vscode.DiagnosticSeverity.Error); ctx.hasModuleDef = true; }
|
||||
}
|
||||
|
||||
if (line.startsWith('metadata') && ctx.inBlock === 'none') {
|
||||
ctx.inModuleMetadata = true;
|
||||
ctx.hasModuleMetadata = true;
|
||||
ctx.moduleMetadataBlockLine = lineIdx;
|
||||
return;
|
||||
}
|
||||
|
||||
if (ctx.inModuleMetadata) {
|
||||
this.trackModuleMetadata(line, lineIdx, ctx);
|
||||
// If we are inside the metadata block, we ignore the rest. MetadataRule handles it!
|
||||
if (ctx.inModuleMetadata || (line.startsWith('metadata') && ctx.inBlock === 'none')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (line.match(/^(pattern|syncmapping|table|definitions?|enumeration|configuration)\b/)) {
|
||||
if (!ctx.hasModuleMetadata && ctx.inBlock === 'none') {
|
||||
ctx.addDiag(lineIdx, 0, line.length, "Ein 'metadata' Block auf Modul-Ebene ist Pflicht, bevor andere Blöcke definiert werden.", vscode.DiagnosticSeverity.Error);
|
||||
ctx.addDiag(lineIdx, 0, line.length, "A 'metadata' block at the module level is mandatory before defining other blocks.", vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
}
|
||||
|
||||
this.handleBlockOpenings(line, rawLine, lineIdx, ctx);
|
||||
this.handleControlBlocks(line, rawLine, lineIdx, ctx);
|
||||
|
||||
if (ctx.inBlock === 'pattern') {
|
||||
// HIER GEFIXT: 'lines' wird jetzt korrekt an die Methode weitergereicht
|
||||
this.checkPatternPhases(line, rawLine, lineIdx, ctx, lines);
|
||||
}
|
||||
|
||||
|
|
@ -41,43 +33,52 @@ export class BlockRule implements LinterRule {
|
|||
|
||||
public checkEnd(lines: string[], ctx: LinterContext): void {
|
||||
for (const unclosedLine of ctx.openDefines) {
|
||||
ctx.addDiag(unclosedLine, 0, lines[unclosedLine].length, "Block 'define' wurde nicht mit 'end define;' geschlossen!", vscode.DiagnosticSeverity.Error);
|
||||
ctx.addDiag(unclosedLine, 0, lines[unclosedLine].length, "Block 'define' was not closed with 'end define;'!", vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
for (const block of ctx.openControlBlocks) {
|
||||
ctx.addDiag(block.lineIdx, 0, lines[block.lineIdx].length, `Block '${block.type}' was not closed with 'end ${block.type};'!`, vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
}
|
||||
|
||||
private trackModuleMetadata(line: string, lineIdx: number, ctx: LinterContext) {
|
||||
if (line.match(/^origin\b/)) { ctx.foundModuleMetadata.origin = true; }
|
||||
if (line.match(/^author\b/)) { ctx.foundModuleMetadata.author = true; }
|
||||
if (line.match(/^products\b/)) { ctx.foundModuleMetadata.products = true; }
|
||||
if (line.match(/^publishers\b/)) { ctx.foundModuleMetadata.publishers = true; }
|
||||
if (line.match(/^tree_path\b/)) { ctx.foundModuleMetadata.tree_path = true; }
|
||||
private handleControlBlocks(line: string, rawLine: string, lineIdx: number, ctx: LinterContext) {
|
||||
if (/^if\b/.test(line)) { ctx.openControlBlocks.push({ type: 'if', lineIdx }); }
|
||||
else if (/^for\b/.test(line)) { ctx.openControlBlocks.push({ type: 'for', lineIdx }); }
|
||||
else if (/^while\b/.test(line)) { ctx.openControlBlocks.push({ type: 'while', lineIdx }); }
|
||||
|
||||
if (line.startsWith('end metadata')) {
|
||||
ctx.inModuleMetadata = false;
|
||||
const missing = Object.keys(ctx.foundModuleMetadata).filter(k => !(ctx.foundModuleMetadata as any)[k]);
|
||||
if (missing.length > 0 && ctx.moduleMetadataBlockLine !== -1) {
|
||||
const diag = ctx.addDiag(ctx.moduleMetadataBlockLine, 0, 8, `Fehlende Pflicht-Metadaten (Modul-Ebene): ${missing.join(', ')}`, vscode.DiagnosticSeverity.Error);
|
||||
diag.code = 'missing_module_metadata';
|
||||
}
|
||||
if (line.startsWith('end if')) { this.closeControlBlock('if', line, lineIdx, ctx); }
|
||||
else if (line.startsWith('end for')) { this.closeControlBlock('for', line, lineIdx, ctx); }
|
||||
else if (line.startsWith('end while')) { this.closeControlBlock('while', line, lineIdx, ctx); }
|
||||
}
|
||||
|
||||
private closeControlBlock(expectedType: string, line: string, lineIdx: number, ctx: LinterContext) {
|
||||
if (ctx.openControlBlocks.length === 0) {
|
||||
ctx.addDiag(lineIdx, 0, line.length, `Found 'end ${expectedType}' without an open block.`, vscode.DiagnosticSeverity.Error);
|
||||
return;
|
||||
}
|
||||
|
||||
const lastBlock = ctx.openControlBlocks.pop()!;
|
||||
if (lastBlock.type !== expectedType) {
|
||||
ctx.addDiag(lineIdx, 0, line.length, `Wrong end. Expected: 'end ${lastBlock.type};', found: 'end ${expectedType};'.`, vscode.DiagnosticSeverity.Error);
|
||||
ctx.openControlBlocks.push(lastBlock);
|
||||
}
|
||||
}
|
||||
|
||||
private handleBlockOpenings(line: string, rawLine: string, lineIdx: number, ctx: LinterContext) {
|
||||
if (line.startsWith('definitions ') || line.startsWith('definition ')) {
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, line.length, "Ein Definitions-Block muss auf oberster Ebene deklariert werden.", vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, line.length, "A 'definitions' block must be declared at the top level.", vscode.DiagnosticSeverity.Error); }
|
||||
ctx.inBlock = 'definitions';
|
||||
}
|
||||
else if (line.startsWith('define ')) { ctx.openDefines.push(lineIdx); }
|
||||
else if (line.startsWith('enumeration ')) {
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, line.length, "Eine Enumeration muss auf oberster Ebene deklariert werden.", vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, line.length, "An 'enumeration' must be declared at the top level.", vscode.DiagnosticSeverity.Error); }
|
||||
ctx.inBlock = 'enumeration';
|
||||
}
|
||||
else if (line.startsWith('configuration ')) {
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, line.length, "Eine Konfiguration muss auf oberster Ebene deklariert werden.", vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, line.length, "A 'configuration' must be declared at the top level.", vscode.DiagnosticSeverity.Error); }
|
||||
ctx.inBlock = 'configuration';
|
||||
}
|
||||
else if (line.startsWith('pattern ') || line.startsWith('syncmapping ')) {
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, 7, "Ein Pattern/Syncmapping kann nicht innerhalb eines anderen Blocks deklariert werden.", vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, 7, "A pattern or syncmapping cannot be declared inside another block.", vscode.DiagnosticSeverity.Error); }
|
||||
ctx.inBlock = 'pattern';
|
||||
ctx.currentPatternPhase = PatternPhase.None;
|
||||
ctx.activePhaseName = "";
|
||||
|
|
@ -85,10 +86,10 @@ export class BlockRule implements LinterRule {
|
|||
|
||||
const nameMatch = line.match(/(pattern|syncmapping)\s+([a-zA-Z0-9_]+)\s+\d+\.\d+/);
|
||||
if (nameMatch) { ctx.currentPatternName = nameMatch[2]; }
|
||||
else { ctx.addDiag(lineIdx, 0, rawLine.length, "Ungültige Pattern-Deklaration. Erwartet: 'pattern <Name> <Version>'", vscode.DiagnosticSeverity.Error); }
|
||||
else { ctx.addDiag(lineIdx, 0, rawLine.length, "Invalid pattern declaration. Expected: 'pattern <Name> <Version>'", vscode.DiagnosticSeverity.Error); }
|
||||
}
|
||||
else if (line.startsWith('table ')) {
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, 5, "Eine Tabelle kann nicht innerhalb eines anderen Blocks deklariert werden.", vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.inBlock !== 'none') { ctx.addDiag(lineIdx, 0, 5, "A table cannot be declared inside another block.", vscode.DiagnosticSeverity.Error); }
|
||||
ctx.inBlock = 'table';
|
||||
}
|
||||
}
|
||||
|
|
@ -96,8 +97,8 @@ export class BlockRule implements LinterRule {
|
|||
private checkPatternPhases(line: string, rawLine: string, lineIdx: number, ctx: LinterContext, lines: string[]) {
|
||||
const checkPhase = (phaseName: string, phaseEnum: PatternPhase) => {
|
||||
if (line.startsWith(phaseName)) {
|
||||
if (ctx.activePhaseName !== "") { ctx.addDiag(ctx.activePhaseLine, 0, ctx.activePhaseName.length, `Block '${ctx.activePhaseName}' wurde nicht mit 'end ${ctx.activePhaseName};' geschlossen.`, vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.currentPatternPhase >= phaseEnum) { ctx.addDiag(lineIdx, 0, phaseName.length, `'${phaseName}' Block ist hier nicht erlaubt.`, vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.activePhaseName !== "") { ctx.addDiag(ctx.activePhaseLine, 0, ctx.activePhaseName.length, `Block '${ctx.activePhaseName}' was not closed with 'end ${ctx.activePhaseName};'.`, vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.currentPatternPhase >= phaseEnum) { ctx.addDiag(lineIdx, 0, phaseName.length, `Block '${phaseName}' is not allowed here.`, vscode.DiagnosticSeverity.Error); }
|
||||
|
||||
ctx.currentPatternPhase = phaseEnum;
|
||||
ctx.activePhaseName = phaseName;
|
||||
|
|
@ -113,23 +114,27 @@ export class BlockRule implements LinterRule {
|
|||
checkPhase('removal', PatternPhase.Removal);
|
||||
|
||||
if (line.startsWith('body')) {
|
||||
if (ctx.activePhaseName !== "") { ctx.addDiag(ctx.activePhaseLine, 0, ctx.activePhaseName.length, `Block '${ctx.activePhaseName}' wurde nicht mit 'end ${ctx.activePhaseName};' geschlossen.`, vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.activePhaseName !== "") { ctx.addDiag(ctx.activePhaseLine, 0, ctx.activePhaseName.length, `Block '${ctx.activePhaseName}' was not closed with 'end ${ctx.activePhaseName};'.`, vscode.DiagnosticSeverity.Error); }
|
||||
ctx.activePhaseName = "body";
|
||||
ctx.activePhaseLine = lineIdx;
|
||||
|
||||
// DER LOG-CHECK IST ZURÜCK!
|
||||
let foundLog = false;
|
||||
for (let j = lineIdx + 1; j < lines.length; j++) {
|
||||
const aheadLine = lines[j].trim();
|
||||
if (aheadLine.startsWith('end pattern') || aheadLine.startsWith('end syncmapping')) { break; }
|
||||
if (aheadLine.includes('log.debug') && aheadLine.includes(ctx.currentPatternName)) { foundLog = true; break; }
|
||||
}
|
||||
const config = vscode.workspace.getConfiguration('tpl');
|
||||
const requireLog = config.get<boolean>('rules.requireBodyLog', true);
|
||||
|
||||
if (!foundLog) {
|
||||
const expectedLog = `log.debug("Start pattern ${ctx.currentPatternName}");`;
|
||||
const diag = ctx.addDiag(lineIdx, 0, rawLine.length, `Im Body fehlt das Log-Statement mit dem Pattern-Namen. Bsp: ${expectedLog}`, vscode.DiagnosticSeverity.Error);
|
||||
diag.code = 'missing_log_start';
|
||||
diag.source = expectedLog;
|
||||
if (requireLog) {
|
||||
let foundLog = false;
|
||||
for (let j = lineIdx + 1; j < lines.length; j++) {
|
||||
const aheadLine = lines[j].trim();
|
||||
if (aheadLine.startsWith('end pattern') || aheadLine.startsWith('end syncmapping')) { break; }
|
||||
if (aheadLine.includes('log.debug') && aheadLine.includes(ctx.currentPatternName)) { foundLog = true; break; }
|
||||
}
|
||||
|
||||
if (!foundLog) {
|
||||
const expectedLog = `log.debug("Start pattern ${ctx.currentPatternName}");`;
|
||||
const diag = ctx.addDiag(lineIdx, 0, rawLine.length, `Missing log statement with pattern name in body. E.g.: ${expectedLog}`, vscode.DiagnosticSeverity.Error);
|
||||
diag.code = 'missing_log_start';
|
||||
diag.source = expectedLog;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -137,7 +142,7 @@ export class BlockRule implements LinterRule {
|
|||
for (const closer of closers) {
|
||||
if (line.startsWith(closer)) {
|
||||
const phase = closer.replace('end ', '').replace(';', '').trim();
|
||||
if (ctx.activePhaseName !== phase) { ctx.addDiag(lineIdx, 0, line.length, `Unerwartetes '${closer}'. Erwartet wurde 'end ${ctx.activePhaseName};'.`, vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.activePhaseName !== phase) { ctx.addDiag(lineIdx, 0, line.length, `Unexpected '${closer}'. Expected 'end ${ctx.activePhaseName};'.`, vscode.DiagnosticSeverity.Error); }
|
||||
else { ctx.activePhaseName = ""; }
|
||||
}
|
||||
}
|
||||
|
|
@ -145,20 +150,20 @@ export class BlockRule implements LinterRule {
|
|||
|
||||
private checkEndBlocks(line: string, rawLine: string, lineIdx: number, ctx: LinterContext) {
|
||||
if (line.startsWith('end pattern') || line.startsWith('end syncmapping')) {
|
||||
if (ctx.activePhaseName !== "") { ctx.addDiag(ctx.activePhaseLine, 0, ctx.activePhaseName.length, `Block '${ctx.activePhaseName}' wurde nicht mit 'end ${ctx.activePhaseName};' geschlossen.`, vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.inBlock !== 'pattern') { ctx.addDiag(lineIdx, 0, 11, "'end pattern' gefunden, ohne offenen Pattern-Block.", vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.activePhaseName !== "") { ctx.addDiag(ctx.activePhaseLine, 0, ctx.activePhaseName.length, `Block '${ctx.activePhaseName}' was not closed with 'end ${ctx.activePhaseName};'.`, vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.inBlock !== 'pattern') { ctx.addDiag(lineIdx, 0, 11, "Found 'end pattern' without an open pattern block.", vscode.DiagnosticSeverity.Error); }
|
||||
ctx.inBlock = 'none';
|
||||
}
|
||||
else if (line.startsWith('end table') || line.startsWith('end enumeration') || line.startsWith('end configuration')) {
|
||||
ctx.inBlock = 'none';
|
||||
}
|
||||
else if (line.startsWith('end definitions') || line.startsWith('end definition')) {
|
||||
if (ctx.inBlock !== 'definitions') { ctx.addDiag(lineIdx, 0, line.length, "'end definitions' gefunden, ohne offenen Definitions-Block.", vscode.DiagnosticSeverity.Error); }
|
||||
if (ctx.inBlock !== 'definitions') { ctx.addDiag(lineIdx, 0, line.length, "Found 'end definitions' without an open definitions block.", vscode.DiagnosticSeverity.Error); }
|
||||
ctx.inBlock = 'none';
|
||||
}
|
||||
else if (line.startsWith('end define')) {
|
||||
if (ctx.openDefines.length > 0) { ctx.openDefines.pop(); }
|
||||
else { ctx.addDiag(lineIdx, 0, line.length, "'end define' gefunden, ohne offenes 'define'.", vscode.DiagnosticSeverity.Error); }
|
||||
else { ctx.addDiag(lineIdx, 0, line.length, "Found 'end define' without an open 'define'.", vscode.DiagnosticSeverity.Error); }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { LinterRule } from './LinterRule';
|
||||
import { LinterContext } from '../LinterContext';
|
||||
|
||||
export class IndentationRule implements LinterRule {
|
||||
|
||||
public checkLine(line: string, rawLine: string, lineIdx: number, ctx: LinterContext, lines: string[]): void {
|
||||
if (rawLine.trim().length === 0) {return;}
|
||||
if (rawLine.includes('\t')) {return;}
|
||||
|
||||
// Sobald wir in Klammern oder einem Multi-Line Import sind (Visual Alignment),
|
||||
// greift die 4-Leerzeichen-Regel nicht!
|
||||
if (ctx.parenStack.length > 0 || ctx.bracketStack.length > 0 || ctx.inImportBlock) {
|
||||
return;
|
||||
}
|
||||
|
||||
const leadingSpacesMatch = rawLine.match(/^ +/);
|
||||
const spaceCount = leadingSpacesMatch ? leadingSpacesMatch[0].length : 0;
|
||||
|
||||
if (spaceCount > 0 && spaceCount % 4 !== 0) {
|
||||
ctx.addDiag(
|
||||
lineIdx,
|
||||
0,
|
||||
spaceCount,
|
||||
`Invalid indentation (${spaceCount} spaces). Please use a multiple of 4. (Tip: Shift+Alt+F to auto-format)`,
|
||||
vscode.DiagnosticSeverity.Warning
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
public checkEnd(lines: string[], ctx: LinterContext): void {
|
||||
// empty
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { LinterRule } from './LinterRule';
|
||||
import { LinterContext } from '../LinterContext';
|
||||
|
||||
export class MetadataRule implements LinterRule {
|
||||
public checkLine(line: string, rawLine: string, lineIdx: number, ctx: LinterContext, lines: string[]): void {
|
||||
if (line.startsWith('metadata') && ctx.inBlock === 'none') {
|
||||
ctx.inModuleMetadata = true;
|
||||
ctx.hasModuleMetadata = true;
|
||||
ctx.moduleMetadataBlockLine = lineIdx;
|
||||
ctx.foundModuleMetadata.clear();
|
||||
return;
|
||||
}
|
||||
|
||||
if (ctx.inModuleMetadata) {
|
||||
const config = vscode.workspace.getConfiguration('tpl');
|
||||
|
||||
if (line.match(/^origin\b/)) {ctx.foundModuleMetadata.add('origin');}
|
||||
if (line.match(/^author\b/)) {ctx.foundModuleMetadata.add('author');}
|
||||
if (line.match(/^products\b/)) {ctx.foundModuleMetadata.add('products');}
|
||||
if (line.match(/^publishers\b/)) {ctx.foundModuleMetadata.add('publishers');}
|
||||
|
||||
if (line.match(/^tree_path\b/)) {
|
||||
ctx.foundModuleMetadata.add('tree_path');
|
||||
if (config.get<boolean>('metadata.require.treePath', true)) {
|
||||
this.checkTreePath(line, rawLine, lineIdx, ctx, config);
|
||||
}
|
||||
}
|
||||
|
||||
if (line.startsWith('end metadata')) {
|
||||
ctx.inModuleMetadata = false;
|
||||
this.checkRequiredFields(ctx, config);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private checkTreePath(line: string, rawLine: string, lineIdx: number, ctx: LinterContext, config: vscode.WorkspaceConfiguration) {
|
||||
const minLevels = config.get<number>('metadata.treePath.minLevels', 3);
|
||||
const staticNodes = config.get<string[]>('metadata.treePath.staticNodes', ['Grafing']); // Fallback
|
||||
|
||||
const match = line.match(/tree_path\s*:=\s*(.*);/);
|
||||
if (match) {
|
||||
const paths = match[1].split(',').map(s => s.trim().replace(/^['"]|['"]$/g, ''));
|
||||
|
||||
if (paths.length < minLevels) {
|
||||
ctx.addDiag(lineIdx, 0, rawLine.length, `The tree_path must contain at least ${minLevels} levels.`, vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
|
||||
for (let i = 0; i < staticNodes.length; i++) {
|
||||
if (paths[i] !== staticNodes[i]) {
|
||||
ctx.addDiag(lineIdx, 0, rawLine.length, `Tree path level ${i + 1} must strictly be '${staticNodes[i]}'.`, vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private checkRequiredFields(ctx: LinterContext, config: vscode.WorkspaceConfiguration) {
|
||||
const requiredFields: string[] = [];
|
||||
if (config.get<boolean>('metadata.require.origin', true)) {requiredFields.push('origin');}
|
||||
if (config.get<boolean>('metadata.require.author', true)) {requiredFields.push('author');}
|
||||
if (config.get<boolean>('metadata.require.products', true)) {requiredFields.push('products');}
|
||||
if (config.get<boolean>('metadata.require.publishers', true)) {requiredFields.push('publishers');}
|
||||
if (config.get<boolean>('metadata.require.treePath', true)) {requiredFields.push('tree_path');}
|
||||
|
||||
const missing = requiredFields.filter(f => !ctx.foundModuleMetadata.has(f));
|
||||
|
||||
if (missing.length > 0 && ctx.moduleMetadataBlockLine !== -1) {
|
||||
const diag = ctx.addDiag(ctx.moduleMetadataBlockLine, 0, 8, `Missing mandatory module metadata fields: ${missing.join(', ')}`, vscode.DiagnosticSeverity.Error);
|
||||
diag.code = 'missing_module_metadata';
|
||||
}
|
||||
}
|
||||
|
||||
public checkEnd(lines: string[], ctx: LinterContext): void {
|
||||
// empty
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,157 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { LinterRule } from './LinterRule';
|
||||
import { LinterContext } from '../LinterContext';
|
||||
import { workspaceIndex, TplFunctionSignature } from '../WorkspaceIndex';
|
||||
import { TplLookup } from '../TplLookup'; // Nutzt ab sofort das zentrale Lexikon
|
||||
|
||||
export class ParameterRule implements LinterRule {
|
||||
public checkLine(line: string, rawLine: string, lineIdx: number, ctx: LinterContext, lines: string[]): void {
|
||||
let cleanLine = "";
|
||||
let inString = false;
|
||||
let stringChar = '';
|
||||
let inTripleQuote = false;
|
||||
|
||||
for (let i = 0; i < line.length; i++) {
|
||||
const char = line[i];
|
||||
|
||||
// 1. Single-Line Kommentare (//) ignorieren
|
||||
if (!inString && !inTripleQuote && char === '/' && line[i+1] === '/') {
|
||||
break;
|
||||
}
|
||||
|
||||
// 2. TPL Triple Quotes (""" oder ''') erkennen
|
||||
if (!inString && !inTripleQuote &&
|
||||
(char === '"' || char === "'") &&
|
||||
line[i+1] === char &&
|
||||
line[i+2] === char) {
|
||||
|
||||
inTripleQuote = true;
|
||||
stringChar = char;
|
||||
cleanLine += char + char + char; // Die """ behalten, damit wir die Zeile nicht komplett leeren
|
||||
i += 2; // Überspringe die nächsten zwei Zeichen
|
||||
continue;
|
||||
}
|
||||
|
||||
// 3. Triple Quotes beenden
|
||||
if (inTripleQuote) {
|
||||
if (char === stringChar && line[i+1] === stringChar && line[i+2] === stringChar) {
|
||||
inTripleQuote = false;
|
||||
cleanLine += char + char + char;
|
||||
i += 2;
|
||||
}
|
||||
continue; // Alles innerhalb von """ ignorieren!
|
||||
}
|
||||
|
||||
// 4. Normale Strings beenden
|
||||
if (inString) {
|
||||
if (char === '\\') {
|
||||
i++; // Escape-Sequenzen ignorieren
|
||||
} else if (char === stringChar) {
|
||||
inString = false;
|
||||
cleanLine += char;
|
||||
}
|
||||
continue; // Alles innerhalb von " ignorieren!
|
||||
}
|
||||
|
||||
// 5. Normale Strings starten
|
||||
if (!inString && !inTripleQuote && (char === '"' || char === "'")) {
|
||||
inString = true;
|
||||
stringChar = char;
|
||||
cleanLine += char;
|
||||
continue;
|
||||
}
|
||||
|
||||
// Wenn wir hier ankommen, sind wir im echten, ausführbaren TPL-Code
|
||||
cleanLine += char;
|
||||
}
|
||||
|
||||
if (cleanLine.trim().length === 0) {return;}
|
||||
|
||||
// Die Definition der Funktion selbst ist kein Aufruf und wird ignoriert.
|
||||
if (/^\s*define\s+/.test(cleanLine)) {return;}
|
||||
|
||||
const callRegex = /\b([a-zA-Z0-9_]+(?:\.[a-zA-Z0-9_]+)?)\s*\(/g;
|
||||
let match;
|
||||
|
||||
while ((match = callRegex.exec(cleanLine)) !== null) {
|
||||
const funcName = match[1];
|
||||
const callStart = match.index;
|
||||
const parenStart = callStart + funcName.length;
|
||||
|
||||
if (/^(if|elif|where|for|while|in|matches|has|subword|defined)\b/.test(funcName)) {continue;}
|
||||
|
||||
let depth = 0;
|
||||
let parenEnd = -1;
|
||||
for (let i = parenStart; i < cleanLine.length; i++) {
|
||||
if (cleanLine[i] === '(') {depth++;}
|
||||
else if (cleanLine[i] === ')') {
|
||||
depth--;
|
||||
if (depth === 0) {
|
||||
parenEnd = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (parenEnd !== -1) {
|
||||
const paramsStr = cleanLine.substring(parenStart + 1, parenEnd).trim();
|
||||
let paramCount = 0;
|
||||
|
||||
if (paramsStr.length > 0) {
|
||||
let paramDepth = 0;
|
||||
let commas = 0;
|
||||
for (let i = 0; i < paramsStr.length; i++) {
|
||||
if (paramsStr[i] === '(' || paramsStr[i] === '[') {paramDepth++;}
|
||||
else if (paramsStr[i] === ')' || paramsStr[i] === ']') {paramDepth--;}
|
||||
else if (paramsStr[i] === ',' && paramDepth === 0) {commas++;}
|
||||
}
|
||||
paramCount = commas + 1;
|
||||
}
|
||||
|
||||
this.validateFunctionParams(funcName, paramCount, lineIdx, rawLine, ctx);
|
||||
this.validateReturnValue(funcName, cleanLine, lineIdx, rawLine, ctx);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public checkEnd(lines: string[], ctx: LinterContext): void {
|
||||
// empty
|
||||
}
|
||||
|
||||
private validateFunctionParams(funcName: string, passedCount: number, lineIdx: number, rawLine: string, ctx: LinterContext) {
|
||||
const parts = funcName.split('.');
|
||||
|
||||
if (parts.length > 1) {
|
||||
// Case-Insensitive Prüfung über den neuen Lookup!
|
||||
if (TplLookup.getBuiltInFunction(parts[0], parts[1])) {
|
||||
return; // Funktion existiert, Linter ist zufrieden.
|
||||
}
|
||||
}
|
||||
|
||||
const signatures = workspaceIndex.getFunctionSignatures(funcName);
|
||||
if (signatures.length > 0) {
|
||||
const matches = signatures.some((sig: TplFunctionSignature) => sig.params.length === passedCount);
|
||||
if (!matches) {
|
||||
const expected = signatures[0].params.length;
|
||||
const idx = rawLine.indexOf(funcName);
|
||||
ctx.addDiag(lineIdx, Math.max(0, idx), Math.max(0, idx) + funcName.length, `Function '${funcName}' expects ${expected} parameter(s), but ${passedCount} were provided.`, vscode.DiagnosticSeverity.Warning);
|
||||
}
|
||||
} else if (parts.length > 1) {
|
||||
const idx = rawLine.indexOf(funcName);
|
||||
ctx.addDiag(lineIdx, Math.max(0, idx), Math.max(0, idx) + funcName.length, `Unknown function '${funcName}'. Please check your imports or contact the plugin provider.`, vscode.DiagnosticSeverity.Information);
|
||||
}
|
||||
}
|
||||
|
||||
private validateReturnValue(funcName: string, cleanLine: string, lineIdx: number, rawLine: string, ctx: LinterContext) {
|
||||
const signatures = workspaceIndex.getFunctionSignatures(funcName);
|
||||
if (signatures.length > 0 && signatures[0].hasReturnValue) {
|
||||
const isAssigned = cleanLine.includes(':=');
|
||||
const isUsedInCondition = /\b(if|elif|while)\b/.test(cleanLine);
|
||||
|
||||
if (!isAssigned && !isUsedInCondition) {
|
||||
const idx = rawLine.indexOf(funcName);
|
||||
ctx.addDiag(lineIdx, Math.max(0, idx), Math.max(0, idx) + funcName.length, `The return value of '${funcName}' is not used. Did you forget an assignment (:=)?`, vscode.DiagnosticSeverity.Warning);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,79 +1,145 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { LinterRule } from './LinterRule';
|
||||
import { LinterContext } from '../LinterContext';
|
||||
import { workspaceIndex } from '../WorkspaceIndex';
|
||||
|
||||
export class SyntaxRule implements LinterRule {
|
||||
|
||||
public checkLine(line: string, rawLine: string, lineIdx: number, ctx: LinterContext): void {
|
||||
public checkLine(line: string, rawLine: string, lineIdx: number, ctx: LinterContext, lines: string[]): void {
|
||||
this.checkTabs(rawLine, lineIdx, ctx);
|
||||
this.checkBrackets(line, rawLine, lineIdx, ctx);
|
||||
this.checkAssignments(rawLine, lineIdx, ctx);
|
||||
this.checkSemicolons(line, rawLine, lineIdx, ctx);
|
||||
|
||||
let cleanLine = line.replace(/"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'/g, '""');
|
||||
const commentIdx = cleanLine.indexOf('//');
|
||||
let codePart = commentIdx !== -1 ? cleanLine.substring(0, commentIdx).trim() : cleanLine.trim();
|
||||
|
||||
if (codePart.length === 0) {return;}
|
||||
|
||||
// --- MULTI-LINE IMPORT HANDLING & VALIDATION ---
|
||||
if (codePart.startsWith('from ')) {
|
||||
const match = codePart.match(/^from\s+([a-zA-Z0-9_.]+)\s+import/);
|
||||
if (match) {
|
||||
ctx.inImportBlock = true;
|
||||
ctx.currentImportModule = match[1];
|
||||
}
|
||||
}
|
||||
|
||||
if (ctx.inImportBlock) {
|
||||
// Remove 'from X import' and any trailing semicolons
|
||||
const importString = codePart.replace(/^from\s+[a-zA-Z0-9_.]+\s+import/, '').replace(/;$/, '');
|
||||
const imports = importString.split(',').filter(i => i.trim().length > 0);
|
||||
|
||||
// Check against RAM index
|
||||
const availableItems = workspaceIndex.getDefinitionBlocksForModule(ctx.currentImportModule);
|
||||
|
||||
// Only warn if we actually have the module in RAM, but the specific item is missing
|
||||
if (availableItems.length > 0) {
|
||||
for (const imp of imports) {
|
||||
const cleanImp = imp.trim().split(/\s+/)[0]; // Trims version number (e.g. "HostToPoolMember 2.0" -> "HostToPoolMember")
|
||||
if (cleanImp.length > 0 && !availableItems.includes(cleanImp)) {
|
||||
const idx = rawLine.indexOf(cleanImp);
|
||||
ctx.addDiag(lineIdx, Math.max(0, idx), Math.max(0, idx) + cleanImp.length, `The item '${cleanImp}' does not exist in module '${ctx.currentImportModule}'.`, vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If the line ends with a semicolon, the import block is closed
|
||||
if (codePart.endsWith(';')) {
|
||||
ctx.inImportBlock = false;
|
||||
ctx.currentImportModule = "";
|
||||
}
|
||||
return; // Skip all other syntax checks for lines inside an import block
|
||||
}
|
||||
// ------------------------------------------------
|
||||
|
||||
let isStructuralKeyword = /^(tpl|pattern|syncmapping|table|definitions?|define|enumeration|configuration|metadata|overview|constants|triggers|mapping|removal|body|end|on|tags|origin|author|products|publishers|tree_path|import|from)\b/.test(codePart);
|
||||
|
||||
if (codePart.startsWith('"') || codePart.startsWith("'")) {
|
||||
isStructuralKeyword = true;
|
||||
}
|
||||
|
||||
const isValidExecutionArea =
|
||||
ctx.activePhaseName === 'body' ||
|
||||
ctx.activePhaseName === 'triggers' ||
|
||||
ctx.activePhaseName === 'constants' ||
|
||||
ctx.activePhaseName === 'overview' ||
|
||||
ctx.activePhaseName === 'mapping' ||
|
||||
ctx.activePhaseName === 'metadata' ||
|
||||
ctx.inModuleMetadata ||
|
||||
ctx.inBlock === 'table' ||
|
||||
ctx.inBlock === 'definitions' ||
|
||||
ctx.openDefines.length > 0;
|
||||
|
||||
// 'then' and 'do' on standalone lines are legitimate code
|
||||
if (!isStructuralKeyword && !isValidExecutionArea && !/^(then|do)\b/.test(codePart)) {
|
||||
ctx.addDiag(lineIdx, 0, rawLine.length, "Executable code is not allowed here. (Allowed in: 'body', 'triggers', 'constants', 'overview', 'mapping', 'metadata', 'definitions', or 'define').", vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
|
||||
this.checkBrackets(codePart, rawLine, lineIdx, ctx);
|
||||
this.checkAssignments(codePart, rawLine, lineIdx, ctx);
|
||||
this.checkSemicolons(codePart, rawLine, lineIdx, ctx, line);
|
||||
}
|
||||
|
||||
public checkEnd(lines: string[], ctx: LinterContext): void {
|
||||
for (const unclosedLine of ctx.parenStack) { ctx.addDiag(unclosedLine, 0, lines[unclosedLine].length, "Öffnende Klammer '(' wird nicht geschlossen!", vscode.DiagnosticSeverity.Error); }
|
||||
for (const unclosedLine of ctx.bracketStack) { ctx.addDiag(unclosedLine, 0, lines[unclosedLine].length, "Öffnende eckige Klammer '[' wird nicht geschlossen!", vscode.DiagnosticSeverity.Error); }
|
||||
for (const unclosedLine of ctx.parenStack) { ctx.addDiag(unclosedLine, 0, lines[unclosedLine].length, "Opening parenthesis '(' is not closed!", vscode.DiagnosticSeverity.Error); }
|
||||
for (const unclosedLine of ctx.bracketStack) { ctx.addDiag(unclosedLine, 0, lines[unclosedLine].length, "Opening bracket '[' is not closed!", vscode.DiagnosticSeverity.Error); }
|
||||
}
|
||||
|
||||
private checkTabs(rawLine: string, lineIdx: number, ctx: LinterContext) {
|
||||
const tabIndex = rawLine.indexOf('\t');
|
||||
if (tabIndex !== -1) {
|
||||
const diag = ctx.addDiag(lineIdx, tabIndex, tabIndex + 1, "Bitte Tabs durch Spaces ersetzen", vscode.DiagnosticSeverity.Warning);
|
||||
const diag = ctx.addDiag(lineIdx, tabIndex, tabIndex + 1, "Please replace tabs with spaces", vscode.DiagnosticSeverity.Warning);
|
||||
diag.code = 'invalid_tab';
|
||||
}
|
||||
}
|
||||
|
||||
private checkBrackets(line: string, rawLine: string, lineIdx: number, ctx: LinterContext) {
|
||||
let cleanLine = line.replace(/"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'/g, '');
|
||||
const commentIdx = cleanLine.indexOf('//');
|
||||
if (commentIdx !== -1) { cleanLine = cleanLine.substring(0, commentIdx); }
|
||||
|
||||
for (let charIdx = 0; charIdx < cleanLine.length; charIdx++) {
|
||||
const char = cleanLine[charIdx];
|
||||
private checkBrackets(codePart: string, rawLine: string, lineIdx: number, ctx: LinterContext) {
|
||||
for (let charIdx = 0; charIdx < codePart.length; charIdx++) {
|
||||
const char = codePart[charIdx];
|
||||
if (char === '(') { ctx.parenStack.push(lineIdx); }
|
||||
else if (char === ')') {
|
||||
if (ctx.parenStack.length > 0) { ctx.parenStack.pop(); }
|
||||
else { ctx.addDiag(lineIdx, 0, rawLine.length, "Unerwartete schließende Klammer ')'. Es fehlt eine öffnende Klammer.", vscode.DiagnosticSeverity.Error); }
|
||||
else { ctx.addDiag(lineIdx, 0, rawLine.length, "Unexpected closing parenthesis ')'. Missing an opening parenthesis.", vscode.DiagnosticSeverity.Error); }
|
||||
}
|
||||
else if (char === '[') { ctx.bracketStack.push(lineIdx); }
|
||||
else if (char === ']') {
|
||||
if (ctx.bracketStack.length > 0) { ctx.bracketStack.pop(); }
|
||||
else { ctx.addDiag(lineIdx, 0, rawLine.length, "Unerwartete schließende eckige Klammer ']'. Es fehlt eine öffnende Klammer.", vscode.DiagnosticSeverity.Error); }
|
||||
else { ctx.addDiag(lineIdx, 0, rawLine.length, "Unexpected closing bracket ']'. Missing an opening bracket.", vscode.DiagnosticSeverity.Error); }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private checkAssignments(rawLine: string, lineIdx: number, ctx: LinterContext) {
|
||||
const lineWithoutStrings = rawLine.replace(/(["'])(?:(?=(\\?))\2.)*?\1/g, '""');
|
||||
private checkAssignments(codePart: string, rawLine: string, lineIdx: number, ctx: LinterContext) {
|
||||
if (/\b(if|elif|where)\b/.test(codePart)) { ctx.inConditionBlock = true; }
|
||||
|
||||
if (/\b(if|elif|where)\b/.test(lineWithoutStrings)) { ctx.inConditionBlock = true; }
|
||||
|
||||
if (lineWithoutStrings.includes('=') && !lineWithoutStrings.includes(':=') && !lineWithoutStrings.includes('>=') && !lineWithoutStrings.includes('<=')) {
|
||||
if (!ctx.inConditionBlock && ctx.parenStack.length === 0 && ctx.bracketStack.length === 0 && !/\b(matches)\b/.test(lineWithoutStrings)) {
|
||||
if (codePart.includes('=') && !codePart.includes(':=') && !codePart.includes('>=') && !codePart.includes('<=')) {
|
||||
if (!ctx.inConditionBlock && ctx.parenStack.length === 0 && ctx.bracketStack.length === 0 && !/\b(matches)\b/.test(codePart)) {
|
||||
const idx = rawLine.indexOf('=');
|
||||
if (idx !== -1) {
|
||||
ctx.addDiag(lineIdx, idx, idx + 1, "Falsche Zuweisung. In TPL wird ':=' für Zuweisungen genutzt.", vscode.DiagnosticSeverity.Error);
|
||||
ctx.addDiag(lineIdx, idx, idx + 1, "Invalid assignment. In TPL, ':=' is used for assignments.", vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (/\b(then|do)\b/.test(lineWithoutStrings) || lineWithoutStrings.endsWith(';')) { ctx.inConditionBlock = false; }
|
||||
if (/\b(then|do)\b/.test(codePart) || codePart.endsWith(';')) { ctx.inConditionBlock = false; }
|
||||
}
|
||||
|
||||
private checkSemicolons(line: string, rawLine: string, lineIdx: number, ctx: LinterContext) {
|
||||
private checkSemicolons(codePart: string, rawLine: string, lineIdx: number, ctx: LinterContext, originalTrimmedLine: string) {
|
||||
if (ctx.isClosingString) {
|
||||
if (ctx.stringNeedsSemicolon && !line.endsWith(';')) {
|
||||
ctx.addDiag(lineIdx, Math.max(0, rawLine.length - 1), rawLine.length, "Fehlendes Semikolon am Ende der Zuweisung.", vscode.DiagnosticSeverity.Error);
|
||||
if (ctx.stringNeedsSemicolon && !originalTrimmedLine.endsWith(';')) {
|
||||
ctx.addDiag(lineIdx, Math.max(0, rawLine.length - 1), rawLine.length, "Missing semicolon at the end of the assignment.", vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
} else {
|
||||
const noSemicolonNeeded = /^(pattern|syncmapping|traverse|table|enumeration|configuration|definitions?|define|metadata|overview|constants|triggers|mapping|removal|body|end\s+|if\s+|else|elif\s+|for\s+|while\s+|\/\/|\/\*|\*)/;
|
||||
const continuesOnNextLine = /(,|and|or|not|\+|-|\*|\/|=|:=|matches)$/i.test(line);
|
||||
// "then" and "do" can stand alone without a semicolon requirement
|
||||
const noSemicolonNeeded = /^(pattern|syncmapping|traverse|table|enumeration|configuration|definitions?|define|metadata|overview|constants|triggers|mapping|removal|body|end\s+|if\s+|else|elif\s+|for\s+|while\s+|then\b|do\b|\/\/|\/\*|\*)/.test(codePart);
|
||||
|
||||
if (!noSemicolonNeeded.test(line) && !ctx.justOpenedString && ctx.parenStack.length === 0 && ctx.bracketStack.length === 0 && ctx.inBlock !== 'enumeration' && !ctx.inConditionBlock && !continuesOnNextLine) {
|
||||
const lineToCheck = line.split('//')[0].trim();
|
||||
if (!lineToCheck.endsWith(';') && !lineToCheck.endsWith('{') && !lineToCheck.endsWith(',')) {
|
||||
ctx.addDiag(lineIdx, Math.max(0, rawLine.length - 1), rawLine.length, "Fehlendes Semikolon am Ende der Anweisung.", vscode.DiagnosticSeverity.Error);
|
||||
// "in" (for loops) is a valid line break
|
||||
const continuesOnNextLine = /(,|and|or|not|\+|-|\*|\/|=|:=|matches|in)$/i.test(codePart);
|
||||
|
||||
const endsWithBlockOpener = /\b(then|do)$/.test(codePart);
|
||||
|
||||
if (!noSemicolonNeeded && !ctx.justOpenedString && ctx.parenStack.length === 0 && ctx.bracketStack.length === 0 && ctx.inBlock !== 'enumeration' && !ctx.inConditionBlock && !continuesOnNextLine && !endsWithBlockOpener) {
|
||||
if (codePart.length > 0 && !codePart.endsWith(';') && !codePart.endsWith('{') && !codePart.endsWith(',')) {
|
||||
ctx.addDiag(lineIdx, Math.max(0, rawLine.length - 1), rawLine.length, "Missing semicolon at the end of the statement.", vscode.DiagnosticSeverity.Error);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -4,21 +4,38 @@ import { TplCodeActionProvider } from './providers/TplCodeActionProvider';
|
|||
import { TplDocumentFormatter } from './providers/TplDocumentFormatter';
|
||||
import { TplCompletionProvider } from './providers/TplCompletionProvider';
|
||||
import { TplHoverProvider } from './providers/TplHoverProvider';
|
||||
import { workspaceIndex } from './core/WorkspaceIndex';
|
||||
import { TplDefinitionProvider } from './providers/TplDefinitionProvider';
|
||||
|
||||
export function activate(context: vscode.ExtensionContext) {
|
||||
const diagnosticCollection = vscode.languages.createDiagnosticCollection('tpl-scanner');
|
||||
context.subscriptions.push(diagnosticCollection);
|
||||
|
||||
// Linter-Events binden
|
||||
vscode.workspace.onDidOpenTextDocument(doc => validateTplDocument(doc, diagnosticCollection));
|
||||
vscode.workspace.onDidChangeTextDocument(event => validateTplDocument(event.document, diagnosticCollection));
|
||||
// LIVE INDEXING & LINTING
|
||||
vscode.workspace.onDidOpenTextDocument(doc => {
|
||||
if (doc.languageId === 'tpl') {
|
||||
workspaceIndex.updateFile(doc.uri, doc.getText());
|
||||
validateTplDocument(doc, diagnosticCollection);
|
||||
}
|
||||
});
|
||||
|
||||
vscode.workspace.onDidChangeTextDocument(event => {
|
||||
if (event.document.languageId === 'tpl') {
|
||||
workspaceIndex.updateFile(event.document.uri, event.document.getText());
|
||||
validateTplDocument(event.document, diagnosticCollection);
|
||||
}
|
||||
});
|
||||
|
||||
// Aufräumen, wenn Dateien gelöscht werden
|
||||
vscode.workspace.onDidDeleteFiles(event => {
|
||||
for (const uri of event.files) {
|
||||
workspaceIndex.removeFile(uri);
|
||||
}
|
||||
});
|
||||
|
||||
// Live-Reload für Einstellungen
|
||||
vscode.workspace.onDidChangeConfiguration(e => {
|
||||
if (e.affectsConfiguration('tpl')) {
|
||||
for (const doc of vscode.workspace.textDocuments) {
|
||||
validateTplDocument(doc, diagnosticCollection);
|
||||
}
|
||||
scanWorkspace(diagnosticCollection);
|
||||
}
|
||||
});
|
||||
|
||||
|
|
@ -27,9 +44,28 @@ export function activate(context: vscode.ExtensionContext) {
|
|||
context.subscriptions.push(vscode.languages.registerDocumentFormattingEditProvider('tpl', new TplDocumentFormatter()));
|
||||
context.subscriptions.push(vscode.languages.registerCompletionItemProvider('tpl', new TplCompletionProvider(), '.'));
|
||||
context.subscriptions.push(vscode.languages.registerHoverProvider('tpl', new TplHoverProvider()));
|
||||
context.subscriptions.push(vscode.languages.registerDefinitionProvider('tpl', new TplDefinitionProvider()));
|
||||
|
||||
// Bei Aktivierung offene Dokumente einmal scannen
|
||||
for (const doc of vscode.workspace.textDocuments) {
|
||||
validateTplDocument(doc, diagnosticCollection);
|
||||
context.subscriptions.push(vscode.commands.registerCommand('tpl.scanWorkspace', () => {
|
||||
scanWorkspace(diagnosticCollection);
|
||||
vscode.window.showInformationMessage("TPL: Workspace-Scan gestartet.");
|
||||
}));
|
||||
|
||||
// Initialer Scan beim Start
|
||||
scanWorkspace(diagnosticCollection);
|
||||
}
|
||||
|
||||
// Füttert RAM und Linter
|
||||
async function scanWorkspace(collection: vscode.DiagnosticCollection) {
|
||||
const files = await vscode.workspace.findFiles('**/*.tpl', '**/node_modules/**');
|
||||
|
||||
for (const file of files) {
|
||||
const doc = await vscode.workspace.openTextDocument(file);
|
||||
|
||||
// ZUERST in den RAM laden...
|
||||
workspaceIndex.updateFile(doc.uri, doc.getText());
|
||||
|
||||
// ... DANN linten
|
||||
validateTplDocument(doc, collection);
|
||||
}
|
||||
}
|
||||
|
|
@ -8,7 +8,6 @@ export class TplCompletionProvider implements vscode.CompletionItemProvider {
|
|||
private strategies: CompletionStrategy[];
|
||||
|
||||
constructor() {
|
||||
// Hier registrieren wir alle Completion Engines
|
||||
this.strategies = [
|
||||
new BuiltInCompletion(),
|
||||
new SnippetCompletion(),
|
||||
|
|
@ -16,20 +15,18 @@ export class TplCompletionProvider implements vscode.CompletionItemProvider {
|
|||
];
|
||||
}
|
||||
|
||||
public provideCompletionItems(
|
||||
public async provideCompletionItems(
|
||||
document: vscode.TextDocument,
|
||||
position: vscode.Position,
|
||||
token: vscode.CancellationToken,
|
||||
context: vscode.CompletionContext
|
||||
): vscode.ProviderResult<vscode.CompletionItem[] | vscode.CompletionList> {
|
||||
): Promise<vscode.CompletionItem[]> {
|
||||
|
||||
// Den Text in der aktuellen Zeile bis zum Cursor holen
|
||||
const linePrefix = document.lineAt(position).text.substring(0, position.character);
|
||||
const results: vscode.CompletionItem[] = [];
|
||||
|
||||
// Jede Engine um Vorschläge bitten
|
||||
for (const strategy of this.strategies) {
|
||||
const items = strategy.provideCompletions(document, position, linePrefix);
|
||||
const items = await strategy.provideCompletions(document, position, linePrefix);
|
||||
if (items && items.length > 0) {
|
||||
results.push(...items);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,53 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { workspaceIndex } from '../core/WorkspaceIndex';
|
||||
|
||||
export class TplDefinitionProvider implements vscode.DefinitionProvider {
|
||||
public async provideDefinition(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken): Promise<vscode.Definition | null> {
|
||||
const range = document.getWordRangeAtPosition(position, /[a-zA-Z0-9_.]+/);
|
||||
if (!range) {return null;}
|
||||
|
||||
const word = document.getText(range);
|
||||
const parts = word.split('.');
|
||||
const funcName = parts.length > 1 ? parts[1] : word;
|
||||
|
||||
const text = document.getText();
|
||||
|
||||
// 1. LOKALE SUCHE: Ist die Funktion in der gleichen Datei?
|
||||
const lines = text.split('\n');
|
||||
for (let i = 0; i < lines.length; i++) {
|
||||
const match = lines[i].match(new RegExp(`^\\s*define\\s+${funcName}\\b`));
|
||||
if (match) {
|
||||
// Wir haben sie lokal gefunden! Springe exakt dorthin.
|
||||
return new vscode.Location(document.uri, new vscode.Position(i, lines[i].indexOf(funcName)));
|
||||
}
|
||||
}
|
||||
|
||||
// 2. GLOBALE SUCHE: Den RAM-Index nach anderen Modulen fragen
|
||||
const signatures = workspaceIndex.getFunctionSignatures(funcName);
|
||||
|
||||
if (parts.length > 1) {
|
||||
const prefix = parts[0];
|
||||
// Wir schauen, ob es über from X import <prefix> importiert wurde
|
||||
const importRegex = new RegExp(`from\\s+([a-zA-Z0-9_.]+)\\s+import\\s+[\\s\\S]*?\\b${prefix}\\b`);
|
||||
const match = importRegex.exec(text);
|
||||
|
||||
if (match) {
|
||||
const moduleName = match[1];
|
||||
const targetFunc = signatures.find(sig => sig.moduleName === moduleName && sig.name.endsWith(`.${funcName}`));
|
||||
if (targetFunc && targetFunc.fsPath) {
|
||||
const uri = vscode.Uri.file(targetFunc.fsPath);
|
||||
return new vscode.Location(uri, new vscode.Position(targetFunc.lineIdx, 0));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 3. FALLBACK: Wenn es nicht als 'prefix.funktion' stand, aber eindeutig im Workspace ist
|
||||
if (signatures.length > 0 && signatures[0].fsPath) {
|
||||
const uri = vscode.Uri.file(signatures[0].fsPath);
|
||||
return new vscode.Location(uri, new vscode.Position(signatures[0].lineIdx, 0));
|
||||
}
|
||||
|
||||
// Wenn es eine Built-in Methode ist (wie discovery.runCommand), springt er nirgends hin
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
|
@ -1,49 +1,37 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { tplBuiltIns } from '../data/TplBuiltIns';
|
||||
import { TplLookup } from '../core/TplLookup';
|
||||
import { workspaceIndex } from '../core/WorkspaceIndex';
|
||||
|
||||
export class TplHoverProvider implements vscode.HoverProvider {
|
||||
public async provideHover(
|
||||
document: vscode.TextDocument,
|
||||
position: vscode.Position,
|
||||
token: vscode.CancellationToken
|
||||
): Promise<vscode.Hover | null> {
|
||||
|
||||
// Greift das Wort unter dem Mauszeiger ab, inklusive Punkte für Namespaces
|
||||
public provideHover(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken): vscode.ProviderResult<vscode.Hover> {
|
||||
const range = document.getWordRangeAtPosition(position, /[a-zA-Z0-9_.]+/);
|
||||
if (!range) {
|
||||
return null;
|
||||
}
|
||||
if (!range) {return null;}
|
||||
|
||||
const word = document.getText(range);
|
||||
const parts = word.split('.');
|
||||
|
||||
let namespace = '';
|
||||
let methodOrPatternName = '';
|
||||
|
||||
if (parts.length === 2) {
|
||||
namespace = parts[0];
|
||||
methodOrPatternName = parts[1];
|
||||
} else if (parts.length === 1) {
|
||||
methodOrPatternName = parts[0];
|
||||
} else {
|
||||
return null;
|
||||
if (parts.length > 1) {
|
||||
// 1. Suche in Core & TKU Built-Ins (Case-Insensitive)
|
||||
const funcData = TplLookup.getBuiltInFunction(parts[0], parts[1]);
|
||||
if (funcData) {
|
||||
const md = new vscode.MarkdownString();
|
||||
md.appendCodeblock(`${parts[0]}.${parts[1]}(${funcData.snippets?.[0] || ''})`, 'tpl');
|
||||
md.appendMarkdown(`---\n${funcData.description}`);
|
||||
return new vscode.Hover(md);
|
||||
}
|
||||
}
|
||||
|
||||
// BMC Namespace-Methoden (z.B. discovery.listDirectory)
|
||||
if (namespace && tplBuiltIns[namespace] && tplBuiltIns[namespace][methodOrPatternName]) {
|
||||
const def = tplBuiltIns[namespace][methodOrPatternName];
|
||||
const markdown = new vscode.MarkdownString();
|
||||
markdown.appendCodeblock(`${namespace}.${methodOrPatternName}`, 'tpl');
|
||||
markdown.appendMarkdown(`---\n\n${def.description}`);
|
||||
return new vscode.Hover(markdown);
|
||||
}
|
||||
// BMC Globale Funktionen (z.B. size, datatype)
|
||||
else if (!namespace && tplBuiltIns['built_in_globals'] && tplBuiltIns['built_in_globals'][methodOrPatternName]) {
|
||||
const def = tplBuiltIns['built_in_globals'][methodOrPatternName];
|
||||
const markdown = new vscode.MarkdownString();
|
||||
markdown.appendCodeblock(`${methodOrPatternName}`, 'tpl');
|
||||
markdown.appendMarkdown(`---\n\n${def.description}`);
|
||||
return new vscode.Hover(markdown);
|
||||
// 2. Suche in lokalem Workspace (RAM Index)
|
||||
const funcName = parts.length > 1 ? parts[1] : word;
|
||||
const signatures = workspaceIndex.getFunctionSignatures(funcName);
|
||||
if (signatures.length > 0) {
|
||||
const sig = signatures[0];
|
||||
const md = new vscode.MarkdownString();
|
||||
md.appendCodeblock(`define ${sig.name}(${sig.params.join(', ')})`, 'tpl');
|
||||
if (sig.docString) {
|
||||
md.appendMarkdown(`---\n${sig.docString}`);
|
||||
}
|
||||
return new vscode.Hover(md);
|
||||
}
|
||||
|
||||
return null;
|
||||
|
|
|
|||
|
|
@ -1,23 +1,22 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { TplQuickFix } from './TplQuickFix';
|
||||
|
||||
export class LogFix implements TplQuickFix {
|
||||
public readonly diagnosticCode = 'missing_log_start';
|
||||
export class LogFix {
|
||||
public diagnosticCode = 'missing_log_start';
|
||||
|
||||
public provideFix(document: vscode.TextDocument, diagnostic: vscode.Diagnostic): vscode.CodeAction[] {
|
||||
const fix = new vscode.CodeAction("Fehlendes Log-Statement einfügen", vscode.CodeActionKind.QuickFix);
|
||||
fix.edit = new vscode.WorkspaceEdit();
|
||||
const action = new vscode.CodeAction("Insert missing log statement", vscode.CodeActionKind.QuickFix);
|
||||
action.edit = new vscode.WorkspaceEdit();
|
||||
|
||||
// Der Linter hat uns den exakten String in die 'source' gepackt
|
||||
const expectedLog = diagnostic.source || 'log.debug("Start pattern");';
|
||||
const expectedLog = diagnostic.source;
|
||||
|
||||
// Füge es eine Zeile unter dem 'body' Keyword ein, sauber eingerückt
|
||||
const insertText = ` ${expectedLog}\n`;
|
||||
fix.edit.insert(document.uri, new vscode.Position(diagnostic.range.start.line + 1, 0), insertText);
|
||||
|
||||
fix.diagnostics = [diagnostic];
|
||||
fix.isPreferred = true;
|
||||
|
||||
return [fix];
|
||||
if (expectedLog) {
|
||||
const insertPos = new vscode.Position(diagnostic.range.start.line + 1, 0);
|
||||
// 8 Leerzeichen Einrückung für den Body-Inhalt
|
||||
action.edit.insert(document.uri, insertPos, ` ${expectedLog}\n`);
|
||||
action.diagnostics = [diagnostic];
|
||||
action.isPreferred = true;
|
||||
return [action];
|
||||
}
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
|
@ -8,26 +8,23 @@ export class MetadataFix implements TplQuickFix {
|
|||
const fix = new vscode.CodeAction("Fehlende Metadaten generieren", vscode.CodeActionKind.QuickFix);
|
||||
fix.edit = new vscode.WorkspaceEdit();
|
||||
|
||||
// Einstellungen laden
|
||||
const config = vscode.workspace.getConfiguration('tpl');
|
||||
const author = config.get<string>('metadata.author', 'Kuro');
|
||||
const author = config.get<string>('metadata.author', 'default');
|
||||
const origin = config.get<string>('metadata.origin', 'Custom');
|
||||
const publisher = config.get<string>('metadata.publisher', 'IT-Operations');
|
||||
const treePathBase = config.get<string>('metadata.treePathBase', 'Grafing');
|
||||
const treePathBase = config.get<string>('metadata.treePathBase', 'default');
|
||||
|
||||
// Herausfinden, welche Felder fehlen (steht im Diagnostic-Message-String)
|
||||
const missingFieldsStr = diagnostic.message.replace('Fehlende Pflicht-Metadaten (Modul-Ebene): ', '');
|
||||
const missingFields = missingFieldsStr.split(', ');
|
||||
|
||||
let insertText = '';
|
||||
if (missingFields.includes('origin')) insertText += ` origin := '${origin}';\n`;
|
||||
if (missingFields.includes('author')) insertText += ` author := '${author}';\n`;
|
||||
if (missingFields.includes('products')) insertText += ` products := 'TODO_Product';\n`;
|
||||
if (missingFields.includes('publishers')) insertText += ` publishers := '${publisher}';\n`;
|
||||
if (missingFields.includes('tree_path')) insertText += ` tree_path := '${treePathBase}', 'TODO_Category', 'TODO_Subcategory';\n`;
|
||||
if (missingFields.includes('origin')) {insertText += ` origin := '${origin}';\n`;}
|
||||
if (missingFields.includes('author')) {insertText += ` author := '${author}';\n`;}
|
||||
if (missingFields.includes('products')) {insertText += ` products := 'TODO_Product';\n`;}
|
||||
if (missingFields.includes('publishers')) {insertText += ` publishers := '${publisher}';\n`;}
|
||||
if (missingFields.includes('tree_path')) {insertText += ` tree_path := '${treePathBase}', 'TODO_Category', 'TODO_Subcategory';\n`;}
|
||||
|
||||
// Direkt über der Zeile 'end metadata;' einfügen
|
||||
fix.edit.insert(document.uri, new vscode.Position(diagnostic.range.start.line, 0), insertText);
|
||||
fix.edit.insert(document.uri, new vscode.Position(diagnostic.range.start.line + 1, 0), insertText);
|
||||
fix.diagnostics = [diagnostic];
|
||||
|
||||
return [fix];
|
||||
|
|
|
|||
|
|
@ -1,20 +1,19 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { TplQuickFix } from './TplQuickFix';
|
||||
|
||||
export class TabFix implements TplQuickFix {
|
||||
public readonly diagnosticCode = 'invalid_tab';
|
||||
export class TabFix {
|
||||
public diagnosticCode = 'invalid_tab';
|
||||
|
||||
public provideFix(document: vscode.TextDocument, diagnostic: vscode.Diagnostic): vscode.CodeAction[] {
|
||||
const fix = new vscode.CodeAction("Tabs in 4 Spaces umwandeln", vscode.CodeActionKind.QuickFix);
|
||||
fix.edit = new vscode.WorkspaceEdit();
|
||||
const action = new vscode.CodeAction("Convert tabs to 4 spaces", vscode.CodeActionKind.QuickFix);
|
||||
action.edit = new vscode.WorkspaceEdit();
|
||||
|
||||
const line = document.lineAt(diagnostic.range.start.line);
|
||||
const newText = line.text.replace(/\t/g, ' ');
|
||||
|
||||
fix.edit.replace(document.uri, line.range, newText);
|
||||
fix.diagnostics = [diagnostic];
|
||||
fix.isPreferred = true; // Setzt dies als Standard-Vorschlag
|
||||
action.edit.replace(document.uri, line.range, newText);
|
||||
action.diagnostics = [diagnostic];
|
||||
action.isPreferred = true;
|
||||
|
||||
return [fix];
|
||||
return [action];
|
||||
}
|
||||
}
|
||||
|
|
@ -1,35 +1,57 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { CompletionStrategy } from './CompletionStrategy';
|
||||
import { TplLookup } from '../../core/TplLookup';
|
||||
|
||||
export class BuiltInCompletion implements CompletionStrategy {
|
||||
public async provideCompletions(document: vscode.TextDocument, position: vscode.Position, linePrefix: string): Promise<vscode.CompletionItem[] | undefined> {
|
||||
const dotMatch = linePrefix.match(/\b([a-zA-Z0-9_]+(?:\.[a-zA-Z0-9_]+)*)\.([a-zA-Z0-9_]*)$/);
|
||||
|
||||
public provideCompletions(document: vscode.TextDocument, position: vscode.Position, linePrefix: string): vscode.CompletionItem[] | undefined {
|
||||
const items: vscode.CompletionItem[] = [];
|
||||
if (dotMatch) {
|
||||
const prefix = dotMatch[1];
|
||||
const items: vscode.CompletionItem[] = [];
|
||||
let isHandled = false;
|
||||
|
||||
// Prüft, ob wir im Namespace "log." oder "discovery." sind (auch wenn man danach weiter tippt!)
|
||||
const match = linePrefix.match(/\b(log|discovery)\.([a-zA-Z0-9_]*)$/);
|
||||
// NEU: Case-Insensitive Lookup (findet Core UND TKU Methoden!)
|
||||
const methods = TplLookup.getAllMethodsForNamespace(prefix);
|
||||
|
||||
if (match) {
|
||||
const namespace = match[1];
|
||||
if (methods) {
|
||||
isHandled = true;
|
||||
for (const [funcName, funcData] of Object.entries(methods)) {
|
||||
const item = new vscode.CompletionItem(funcName, vscode.CompletionItemKind.Method);
|
||||
item.detail = `TPL Built-in: ${prefix}.${funcName}`;
|
||||
item.documentation = new vscode.MarkdownString(funcData.description);
|
||||
|
||||
if (namespace === 'log') {
|
||||
const levels = ['debug', 'info', 'warn', 'error'];
|
||||
for (const level of levels) {
|
||||
const item = new vscode.CompletionItem(level, vscode.CompletionItemKind.Method);
|
||||
item.insertText = new vscode.SnippetString(`${level}("\${1:message}");`);
|
||||
item.documentation = new vscode.MarkdownString(`Schreibt eine Log-Meldung auf dem Level **${level}**.`);
|
||||
if (funcData.snippets && funcData.snippets.length > 0) {
|
||||
item.insertText = new vscode.SnippetString(`${funcName}(${funcData.snippets[0]});$0`);
|
||||
} else {
|
||||
item.insertText = new vscode.SnippetString(`${funcName}();$0`);
|
||||
}
|
||||
items.push(item);
|
||||
}
|
||||
}
|
||||
else if (namespace === 'discovery') {
|
||||
const runCmd = new vscode.CompletionItem('runCommand', vscode.CompletionItemKind.Method);
|
||||
runCmd.insertText = new vscode.SnippetString('runCommand(${1:host}, "${2:command}");');
|
||||
runCmd.detail = "discovery.runCommand(host, command)";
|
||||
items.push(runCmd);
|
||||
}
|
||||
return items; // Treffer gefunden, wir geben sie zurück!
|
||||
}
|
||||
|
||||
// Dynamische Konstruktoren für 'model', 'model.rel' etc. bleiben hier unverändert...
|
||||
if (prefix.toLowerCase() === 'model') {
|
||||
isHandled = true;
|
||||
const dynamicItem = new vscode.CompletionItem('<NodeKind>', vscode.CompletionItemKind.Constructor);
|
||||
dynamicItem.detail = "Dynamic Taxonomy Node";
|
||||
dynamicItem.documentation = new vscode.MarkdownString("The `model` scope is automatically populated with a function named after each node kind defined in the taxonomy.");
|
||||
dynamicItem.insertText = new vscode.SnippetString("${1:NodeKind}(key := ${2:key_value});$0");
|
||||
items.push(dynamicItem);
|
||||
}
|
||||
else if (prefix.toLowerCase() === 'model.rel' || prefix.toLowerCase() === 'model.uniquerel') {
|
||||
isHandled = true;
|
||||
const dynamicItem = new vscode.CompletionItem('<Relationship>', vscode.CompletionItemKind.Constructor);
|
||||
dynamicItem.detail = prefix.toLowerCase() === 'model.rel' ? "Dynamic Taxonomy Relationship" : "Dynamic Unique Taxonomy Relationship";
|
||||
dynamicItem.documentation = new vscode.MarkdownString(`The \`${prefix}\` scope is automatically populated with a function named after each relationship defined in the taxonomy.`);
|
||||
dynamicItem.insertText = new vscode.SnippetString("${1:RelationshipName}(${2:SourceRole} := ${3:source_node}, ${4:DestinationRole} := ${5:dest_node});$0");
|
||||
items.push(dynamicItem);
|
||||
}
|
||||
|
||||
if (isHandled) {
|
||||
return items;
|
||||
}
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
|
|
@ -1,14 +1,9 @@
|
|||
import * as vscode from 'vscode';
|
||||
|
||||
export interface CompletionStrategy {
|
||||
/**
|
||||
* @param document Das aktuelle Dokument
|
||||
* @param position Die Cursor-Position
|
||||
* @param linePrefix Der Text der aktuellen Zeile *vor* dem Cursor
|
||||
*/
|
||||
provideCompletions(
|
||||
document: vscode.TextDocument,
|
||||
position: vscode.Position,
|
||||
linePrefix: string
|
||||
): vscode.CompletionItem[] | undefined;
|
||||
): vscode.ProviderResult<vscode.CompletionItem[] | undefined>;
|
||||
}
|
||||
|
|
@ -1,13 +1,161 @@
|
|||
import * as vscode from 'vscode';
|
||||
import { CompletionStrategy } from './CompletionStrategy';
|
||||
import { tplBuiltIns } from '../../data/TplBuiltIns';
|
||||
import { workspaceIndex } from '../../core/WorkspaceIndex';
|
||||
|
||||
export class LocalContextCompletion implements CompletionStrategy {
|
||||
public async provideCompletions(document: vscode.TextDocument, position: vscode.Position, linePrefix: string): Promise<vscode.CompletionItem[] | undefined> {
|
||||
const text = document.getText();
|
||||
const items: vscode.CompletionItem[] = [];
|
||||
|
||||
public provideCompletions(document: vscode.TextDocument, position: vscode.Position, linePrefix: string): vscode.CompletionItem[] | undefined {
|
||||
// TODO für Phase 2:
|
||||
// 1. Regex Suche im Dokument nach ":=" (Variablen tracken)
|
||||
// 2. Projektweite Suche nach "define" Methoden für Autocomplete
|
||||
const textBeforeCursor = document.getText(new vscode.Range(new vscode.Position(0, 0), position));
|
||||
const lastFromIndex = textBeforeCursor.lastIndexOf('from ');
|
||||
const lastSemicolonIndex = textBeforeCursor.lastIndexOf(';');
|
||||
|
||||
return undefined;
|
||||
// 1 & 2. MULTI-LINE SMART IMPORT
|
||||
// Wenn das letzte 'from' NACH dem letzten Semikolon kam, sind wir mitten in einem Import-Block!
|
||||
if (lastFromIndex > lastSemicolonIndex || (lastFromIndex !== -1 && lastSemicolonIndex === -1)) {
|
||||
const importContext = textBeforeCursor.substring(lastFromIndex);
|
||||
const match = importContext.match(/^from\s+([a-zA-Z0-9_.]+)\s+import/);
|
||||
|
||||
if (!match) {
|
||||
// Wir tippen noch den Modul-Namen
|
||||
for (const mod of workspaceIndex.getAllModules()) {
|
||||
const item = new vscode.CompletionItem(mod, vscode.CompletionItemKind.Module);
|
||||
item.detail = "Workspace Module";
|
||||
items.push(item);
|
||||
}
|
||||
return items;
|
||||
} else {
|
||||
// Wir tippen die zu importierenden Klassen/Patterns (auch nach Zeilenumbrüchen!)
|
||||
const modName = match[1];
|
||||
for (const defBlock of workspaceIndex.getDefinitionBlocksForModule(modName)) {
|
||||
const item = new vscode.CompletionItem(defBlock, vscode.CompletionItemKind.Class);
|
||||
item.detail = `Available in ${modName}`;
|
||||
items.push(item);
|
||||
}
|
||||
return items; // Nichts anderes vorschlagen!
|
||||
}
|
||||
}
|
||||
|
||||
// 3. NAMESPACE CALLS: "prefix."
|
||||
const dotMatch = linePrefix.match(/\b([a-zA-Z0-9_]+)\.([a-zA-Z0-9_]*)$/);
|
||||
if (dotMatch) {
|
||||
const prefix = dotMatch[1];
|
||||
|
||||
// BMC Built-ins ignorieren (übernimmt BuiltInCompletion)
|
||||
const bmcNamespaces = Object.keys(tplBuiltIns);
|
||||
if (bmcNamespaces.includes(prefix)) {
|
||||
return undefined; // Hier darf undefined sein, weil BuiltInCompletion das fängt
|
||||
}
|
||||
|
||||
let funcs = [];
|
||||
|
||||
// A) RAM-Abfrage für importierte Module
|
||||
const importRegex = new RegExp(`from\\s+([a-zA-Z0-9_.]+)\\s+import\\s+[\\s\\S]*?\\b${prefix}\\b`);
|
||||
const match = importRegex.exec(text);
|
||||
if (match) {
|
||||
const moduleName = match[1];
|
||||
// Filtere Funktionen aus dem importierten Modul, die zu diesem Prefix gehören
|
||||
funcs = workspaceIndex.getFunctionsForModule(moduleName).filter(f => f.name.startsWith(`${prefix}.`) || !f.name.includes('.'));
|
||||
} else {
|
||||
// B) Lokale Definitions in der aktuellen Datei prüfen!
|
||||
const localDefRegex = new RegExp(`^\\s*definitions?\\s+${prefix}\\b`, 'm');
|
||||
if (localDefRegex.test(text)) {
|
||||
const lines = text.split('\n');
|
||||
let inTargetBlock = false;
|
||||
for (const line of lines) {
|
||||
if (line.match(new RegExp(`^\\s*definitions?\\s+${prefix}\\b`))) { inTargetBlock = true; continue; }
|
||||
if (line.match(/^\s*end\s+definitions?/)) { inTargetBlock = false; continue; }
|
||||
if (inTargetBlock) {
|
||||
const defineMatch = line.match(/^\s*define\s+([a-zA-Z0-9_]+)\b(?:\s*\((.*?)\))?/);
|
||||
if (defineMatch) {
|
||||
const params = (defineMatch[2] || "").split(',').map(p => p.trim()).filter(p => p.length > 0);
|
||||
funcs.push({ name: defineMatch[1], moduleName: 'local', params: params });
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (funcs.length > 0) {
|
||||
for (const f of funcs) {
|
||||
const shortName = f.name.split('.').pop() || f.name;
|
||||
const item = new vscode.CompletionItem(shortName, vscode.CompletionItemKind.Function);
|
||||
item.detail = f.moduleName === 'local' ? `Local Method` : `Method from ${f.moduleName}`;
|
||||
|
||||
// Dynamische Parameter-Generierung! Baut z.B. ${1:host}, ${2:ip}
|
||||
let paramSnippet = "";
|
||||
if (f.params && f.params.length > 0) {
|
||||
paramSnippet = f.params.map((p, idx) => `\${${idx + 1}:${p}}`).join(', ');
|
||||
}
|
||||
|
||||
item.insertText = new vscode.SnippetString(`${shortName}(${paramSnippet});$0`);
|
||||
items.push(item);
|
||||
}
|
||||
return items; // Gibt exakt die gefundenen Funktionen zurück
|
||||
}
|
||||
|
||||
// Wenn es ein unbekannter Namespace mit Punkt ist, geben wir ein leeres Array [] zurück!
|
||||
// Das zwingt VS Code dazu, KEINE generischen Textwörter vorzuschlagen.
|
||||
return [];
|
||||
}
|
||||
|
||||
// 4. LOKALE DEFINITIONS PARSEN (Für den globalen Scope, noch ohne Punkt aufgerufen)
|
||||
const lines = text.split('\n');
|
||||
let currentDefBlock = "";
|
||||
|
||||
for (let i = 0; i < lines.length; i++) {
|
||||
const line = lines[i];
|
||||
const defBlockMatch = line.match(/^\s*definitions?\s+([a-zA-Z0-9_]+)/);
|
||||
if (defBlockMatch) { currentDefBlock = defBlockMatch[1]; continue; }
|
||||
if (line.match(/^\s*end\s+definitions?/)) { currentDefBlock = ""; continue; }
|
||||
|
||||
const defineMatch = line.match(/^\s*define\s+([a-zA-Z0-9_]+)\b(?:\s*\((.*?)\))?/);
|
||||
if (defineMatch) {
|
||||
const funcName = defineMatch[1];
|
||||
const fullName = currentDefBlock ? `${currentDefBlock}.${funcName}` : funcName;
|
||||
const item = new vscode.CompletionItem(fullName, vscode.CompletionItemKind.Function);
|
||||
item.detail = currentDefBlock ? `Local Function in '${currentDefBlock}'` : `Local Function`;
|
||||
|
||||
// Dynamische Parameter-Generierung
|
||||
const params = (defineMatch[2] || "").split(',').map(p => p.trim()).filter(p => p.length > 0);
|
||||
let paramSnippet = "";
|
||||
if (params.length > 0) {
|
||||
paramSnippet = params.map((p, idx) => `\${${idx + 1}:${p}}`).join(', ');
|
||||
}
|
||||
|
||||
item.insertText = new vscode.SnippetString(`${fullName}(${paramSnippet});$0`);
|
||||
items.push(item);
|
||||
}
|
||||
}
|
||||
|
||||
// Import-Referenzen für den globalen Scope bereitstellen (angepasst für Multi-Line)
|
||||
const fromImportRegex = /from\s+([a-zA-Z0-9_.]+)\s+import\s+([\s\S]*?);/g;
|
||||
let matchVar;
|
||||
while ((matchVar = fromImportRegex.exec(text)) !== null) {
|
||||
const moduleName = matchVar[1];
|
||||
const imports = matchVar[2].split(',').map(i => i.trim().split(/\s+/)[0]);
|
||||
|
||||
for (const imp of imports) {
|
||||
if (imp.length > 0) {
|
||||
const item = new vscode.CompletionItem(imp, vscode.CompletionItemKind.Module);
|
||||
item.detail = `Imported from ${moduleName}`;
|
||||
items.push(item);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Lokale Variablen (:=) vorschlagen
|
||||
const varRegex = /([a-zA-Z0-9_]+)\s*:=/g;
|
||||
const foundVars = new Set<string>();
|
||||
while ((matchVar = varRegex.exec(text)) !== null) {
|
||||
if (matchVar[1] !== 'host') { foundVars.add(matchVar[1]); }
|
||||
}
|
||||
for (const v of foundVars) {
|
||||
items.push(new vscode.CompletionItem(v, vscode.CompletionItemKind.Variable));
|
||||
}
|
||||
|
||||
return items;
|
||||
}
|
||||
}
|
||||
|
|
@ -2,97 +2,118 @@ import * as vscode from 'vscode';
|
|||
import { CompletionStrategy } from './CompletionStrategy';
|
||||
|
||||
export class SnippetCompletion implements CompletionStrategy {
|
||||
|
||||
public provideCompletions(document: vscode.TextDocument, position: vscode.Position, linePrefix: string): vscode.CompletionItem[] | undefined {
|
||||
// Wenn wir gerade NACH einem Punkt tippen (z.B. "log."), sind Snippets/Base-Module hier falsch!
|
||||
if (linePrefix.match(/\.[a-zA-Z0-9_]*$/)) {
|
||||
return undefined;
|
||||
}
|
||||
public async provideCompletions(document: vscode.TextDocument, position: vscode.Position, linePrefix: string): Promise<vscode.CompletionItem[] | undefined> {
|
||||
if (linePrefix.match(/\.[a-zA-Z0-9_]*$/)) { return undefined; }
|
||||
|
||||
const items: vscode.CompletionItem[] = [];
|
||||
|
||||
const textBeforeCursor = document.getText(new vscode.Range(new vscode.Position(0, 0), position));
|
||||
const inPattern = textBeforeCursor.lastIndexOf('pattern ') > textBeforeCursor.lastIndexOf('end pattern;');
|
||||
const inSyncmapping = textBeforeCursor.lastIndexOf('syncmapping ') > textBeforeCursor.lastIndexOf('end syncmapping;');
|
||||
const inBlock = inPattern || inSyncmapping;
|
||||
|
||||
const config = vscode.workspace.getConfiguration('tpl');
|
||||
|
||||
// ==========================================
|
||||
// 1. BASIS-NAMESPACES (discovery, log, etc.)
|
||||
// ==========================================
|
||||
const namespaces = ['discovery', 'log', 'model', 'search', 'text', 'regex', 'time', 'hash', 'number', 'inference'];
|
||||
for (const ns of namespaces) {
|
||||
const item = new vscode.CompletionItem(ns, vscode.CompletionItemKind.Module);
|
||||
item.detail = `TPL Namespace: ${ns}`;
|
||||
items.push(item);
|
||||
}
|
||||
|
||||
// ==========================================
|
||||
// 2. DAS GOD-SNIPPET (Skeleton)
|
||||
// ==========================================
|
||||
const skel = new vscode.CompletionItem('tpl_skeleton', vscode.CompletionItemKind.Snippet);
|
||||
const version = config.get<number>('version', 23);
|
||||
const author = config.get<string>('metadata.author', 'Kuro');
|
||||
const origin = config.get<string>('metadata.origin', 'Custom');
|
||||
const publisher = config.get<string>('metadata.publisher', 'IT-Operations');
|
||||
const version = config.get<string>('version', '23');
|
||||
|
||||
skel.insertText = new vscode.SnippetString(
|
||||
`tpl 1.${version} module \${1:Name};\n\n` +
|
||||
`metadata\n` +
|
||||
` origin := '\${2:Custom}';\n` +
|
||||
` author := '${author}';\n` +
|
||||
` tree_path := 'Grafing', '\${3:Category}', '\${4:SubCategory}';\n` +
|
||||
`end metadata;\n\n` +
|
||||
`pattern \${5:PatternName} 1.0\n` +
|
||||
` """\n \${6:Beschreibung}\n """\n` +
|
||||
` overview\n tags \${7:tag1};\n end overview;\n\n` +
|
||||
` triggers\n on host := Host created, confirmed;\n end triggers;\n\n` +
|
||||
` body\n log.debug("Start pattern \${5:PatternName}");\n $0\n end body;\n` +
|
||||
`end pattern;`
|
||||
);
|
||||
skel.detail = "Generiert ein komplettes TPL Grundgerüst";
|
||||
items.push(skel);
|
||||
// Dynamischer Tree-Path
|
||||
const minLevels = config.get<number>('metadata.treePath.minLevels', 3);
|
||||
const staticNodes = config.get<string[]>('metadata.treePath.staticNodes', ['Grafing']);
|
||||
|
||||
// ==========================================
|
||||
// 3. TPL HAUPT-BLÖCKE (pattern, define, etc.)
|
||||
// ==========================================
|
||||
const mainBlocks = [
|
||||
{ label: 'pattern', desc: 'pattern ... end pattern;' },
|
||||
{ label: 'syncmapping', desc: 'syncmapping ... end syncmapping;' },
|
||||
{ label: 'define', desc: 'define ... end define;' }
|
||||
];
|
||||
let treePathStr = '';
|
||||
let snippetTabIdx = 1;
|
||||
|
||||
for (const block of mainBlocks) {
|
||||
const item = new vscode.CompletionItem(block.label, vscode.CompletionItemKind.Snippet);
|
||||
item.insertText = new vscode.SnippetString(`${block.label} \${1:Name} \${2:1.0}\n """\n \${3:DocString}\n """\n $0\nend ${block.label};`);
|
||||
if (block.label === 'define') {
|
||||
item.insertText = new vscode.SnippetString(`define \${1:methodName}(\${2:params})\n """\n \${3:DocString}\n """\n $0\nend define;`);
|
||||
for (let i = 0; i < minLevels; i++) {
|
||||
if (i < staticNodes.length) {
|
||||
treePathStr += `'${staticNodes[i]}'`;
|
||||
} else {
|
||||
treePathStr += `'\${${snippetTabIdx}:Level_${i+1}}'`;
|
||||
snippetTabIdx++;
|
||||
}
|
||||
item.detail = block.desc;
|
||||
items.push(item);
|
||||
if (i < minLevels - 1) {treePathStr += ', ';}
|
||||
}
|
||||
|
||||
// ==========================================
|
||||
// 4. SECTIONS (metadata, body, triggers, etc.)
|
||||
// ==========================================
|
||||
const sections = ['metadata', 'overview', 'constants', 'triggers', 'mapping', 'removal', 'body'];
|
||||
for (const sec of sections) {
|
||||
const item = new vscode.CompletionItem(sec, vscode.CompletionItemKind.Snippet);
|
||||
item.insertText = new vscode.SnippetString(`${sec}\n $0\nend ${sec};`);
|
||||
item.detail = `${sec} ... end ${sec};`;
|
||||
items.push(item);
|
||||
// Dynamischer Modul-Metadata-Block
|
||||
let metadataBlock = 'metadata\n';
|
||||
if (config.get<boolean>('metadata.require.origin', true)) {metadataBlock += ` origin := '${origin}';\n`;}
|
||||
if (config.get<boolean>('metadata.require.treePath', true)) {metadataBlock += ` tree_path := ${treePathStr};\n`;}
|
||||
if (config.get<boolean>('metadata.require.products', true)) {metadataBlock += ` products := '\${${snippetTabIdx++}:Product}';\n`;}
|
||||
if (config.get<boolean>('metadata.require.publishers', true)) {metadataBlock += ` publishers := '${publisher}';\n`;}
|
||||
if (config.get<boolean>('metadata.require.author', true)) {metadataBlock += ` author := '${author}';\n`;}
|
||||
metadataBlock += 'end metadata;';
|
||||
|
||||
if (!inBlock) {
|
||||
const skeleton = new vscode.CompletionItem('tpl_skeleton', vscode.CompletionItemKind.Snippet);
|
||||
skeleton.detail = "Generiert ein frisches TPL Modul";
|
||||
skeleton.insertText = new vscode.SnippetString(
|
||||
`tpl 1.\${${snippetTabIdx++}:${version}} module \${${snippetTabIdx++}:MyModule};\n\n` +
|
||||
`${metadataBlock}\n\n` +
|
||||
`pattern \${${snippetTabIdx++}:MyPattern} 1.0\n` +
|
||||
` """\n \${${snippetTabIdx++}:Beschreibung des Patterns}\n """\n` +
|
||||
` metadata\n` +
|
||||
` publishers := '${publisher}';\n` +
|
||||
` tags := '\${${snippetTabIdx++}:Tags}';\n` +
|
||||
` end metadata;\n\n` +
|
||||
` overview\n` +
|
||||
` tags \${${snippetTabIdx++}:Tags};\n` +
|
||||
` end overview;\n\n` +
|
||||
` constants\n` +
|
||||
` \${${snippetTabIdx++}:const_name} := '\${${snippetTabIdx++}:value}';\n` +
|
||||
` end constants;\n\n` +
|
||||
` triggers\n` +
|
||||
` on process := SoftwareInstance created, confirmed where type = '\${${snippetTabIdx++}:Type}';\n` +
|
||||
` end triggers;\n\n` +
|
||||
` body\n` +
|
||||
` log.debug("Start pattern %pattern_name%");\n` +
|
||||
` $0\n` +
|
||||
` end body;\n` +
|
||||
`end pattern;`
|
||||
);
|
||||
items.push(skeleton);
|
||||
|
||||
const modMeta = new vscode.CompletionItem('metadata', vscode.CompletionItemKind.Snippet);
|
||||
modMeta.detail = "Modul-Metadaten Block (Pflichtfelder)";
|
||||
modMeta.insertText = new vscode.SnippetString(`${metadataBlock}\n$0`);
|
||||
items.push(modMeta);
|
||||
}
|
||||
|
||||
if (inBlock) {
|
||||
const patMeta = new vscode.CompletionItem('metadata', vscode.CompletionItemKind.Snippet);
|
||||
patMeta.detail = "Pattern-Metadaten Block";
|
||||
patMeta.insertText = new vscode.SnippetString(
|
||||
`metadata\n` +
|
||||
` publishers := '${publisher}';\n` +
|
||||
` tags := '\${1:Tags}';\n` +
|
||||
`end metadata;\n$0`
|
||||
);
|
||||
items.push(patMeta);
|
||||
}
|
||||
|
||||
// ==========================================
|
||||
// 5. KONTROLLSTRUKTUREN & TABELLEN
|
||||
// ==========================================
|
||||
const ifSnippet = new vscode.CompletionItem('if', vscode.CompletionItemKind.Snippet);
|
||||
ifSnippet.insertText = new vscode.SnippetString('if ${1:condition} then\n $0\nend if;');
|
||||
ifSnippet.detail = "if ... then ... end if;";
|
||||
ifSnippet.insertText = new vscode.SnippetString(`if \${1:condition} then\n $0\nend if;`);
|
||||
items.push(ifSnippet);
|
||||
|
||||
const elifSnippet = new vscode.CompletionItem('elif', vscode.CompletionItemKind.Snippet);
|
||||
elifSnippet.insertText = new vscode.SnippetString(`elif \${1:condition} then\n $0`);
|
||||
items.push(elifSnippet);
|
||||
|
||||
const elseSnippet = new vscode.CompletionItem('else', vscode.CompletionItemKind.Snippet);
|
||||
elseSnippet.insertText = new vscode.SnippetString(`else\n $0`);
|
||||
items.push(elseSnippet);
|
||||
|
||||
const forSnippet = new vscode.CompletionItem('for', vscode.CompletionItemKind.Snippet);
|
||||
forSnippet.insertText = new vscode.SnippetString('for ${1:item} in${2:list} do\n $0\nend for;');
|
||||
forSnippet.detail = "for ... in ... do ... end for;";
|
||||
forSnippet.insertText = new vscode.SnippetString(`for \${1:item} in \${2:list} do\n $0\nend for;`);
|
||||
items.push(forSnippet);
|
||||
|
||||
const tableSnippet = new vscode.CompletionItem('table', vscode.CompletionItemKind.Snippet);
|
||||
tableSnippet.insertText = new vscode.SnippetString('table ${1:TableName} 1.0\n ${2:"key"} -> "${3:value}";\n default -> "unknown";\nend table;');
|
||||
tableSnippet.detail = "table ... end table;";
|
||||
items.push(tableSnippet);
|
||||
const whileSnippet = new vscode.CompletionItem('while', vscode.CompletionItemKind.Snippet);
|
||||
whileSnippet.insertText = new vscode.SnippetString(`while \${1:condition} do\n $0\nend while;`);
|
||||
items.push(whileSnippet);
|
||||
|
||||
const defineSnippet = new vscode.CompletionItem('define', vscode.CompletionItemKind.Snippet);
|
||||
defineSnippet.insertText = new vscode.SnippetString(`define \${1:name}(\${2:params})\n """\n \${3:DocString}\n """\n $0\nend define;`);
|
||||
items.push(defineSnippet);
|
||||
|
||||
return items;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ export class FormatState {
|
|||
public parenAlignments: number[] = [];
|
||||
public bracketAlignments: number[] = [];
|
||||
|
||||
public inImportBlock: boolean = false;
|
||||
|
||||
// Gibt die aktuellen Basis-Leerzeichen zurück (z.B. Level 2 = 8 Leerzeichen)
|
||||
public get currentIndentString(): string {
|
||||
return ' '.repeat(this.indentLevel * this.tabSize);
|
||||
|
|
|
|||
|
|
@ -1,30 +1,79 @@
|
|||
import { FormatState } from './FormatState';
|
||||
|
||||
export class IndentationRules {
|
||||
// Keywords, die eine neue Einrückungsebene öffnen (ohne static!)
|
||||
private readonly blockOpens = /^(pattern|syncmapping|table|definitions?|enumeration|configuration|define|metadata|overview|constants|triggers|mapping|removal|body|if\s+|for\s+|while\s+)\b/;
|
||||
|
||||
// Keywords, die eine Ebene schließen (ohne static!)
|
||||
private readonly blockCloses = /^(end\s+|else\b|elif\b)/;
|
||||
|
||||
public apply(line: string, state: FormatState): string {
|
||||
// 1. Wenn die Zeile einen Block schließt, VORHER die Einrückung verringern
|
||||
if (this.blockCloses.test(line) && state.indentLevel > 0) {
|
||||
state.indentLevel--;
|
||||
if (line.trim().length === 0) {return "";}
|
||||
|
||||
let cleanLine = "";
|
||||
let inString = false;
|
||||
let stringChar = '';
|
||||
let inTripleQuote = false;
|
||||
|
||||
for (let i = 0; i < line.length; i++) {
|
||||
const char = line[i];
|
||||
if (!inString && !inTripleQuote && char === '/' && line[i+1] === '/') {break;}
|
||||
|
||||
if (!inString && !inTripleQuote && (char === '"' || char === "'") && line[i+1] === char && line[i+2] === char) {
|
||||
inTripleQuote = true; stringChar = char; cleanLine += char+char+char; i += 2; continue;
|
||||
}
|
||||
if (inTripleQuote) {
|
||||
if (char === stringChar && line[i+1] === stringChar && line[i+2] === stringChar) {
|
||||
inTripleQuote = false; cleanLine += char+char+char; i += 2;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
if (inString) {
|
||||
if (char === '\\') {i++;} else if (char === stringChar) {inString = false;}
|
||||
continue;
|
||||
}
|
||||
if (!inString && !inTripleQuote && (char === '"' || char === "'")) {
|
||||
inString = true; stringChar = char; cleanLine += char; continue;
|
||||
}
|
||||
cleanLine += char;
|
||||
}
|
||||
cleanLine = cleanLine.trim();
|
||||
|
||||
const trimmedLine = line.trimStart();
|
||||
|
||||
// 3. DEDENT
|
||||
if (/^end\b/.test(cleanLine)) {
|
||||
state.indentLevel = Math.max(0, state.indentLevel - 1);
|
||||
} else if (/^(elif|else)\b/.test(cleanLine)) {
|
||||
state.indentLevel = Math.max(0, state.indentLevel - 1);
|
||||
}
|
||||
|
||||
// Aktuelle Einrückung für diese Zeile abholen
|
||||
const currentIndent = state.currentIndentString;
|
||||
// 4. SET SPACES
|
||||
let result = trimmedLine;
|
||||
|
||||
// 2. NACH der Zeile: Wenn sie einen Block öffnet, Level für die nächste Zeile erhöhen
|
||||
if (/^(else\b|elif\b)/.test(line)) {
|
||||
// else / elif springen nach dem Schließen direkt wieder auf
|
||||
if (state.parenAlignments && state.parenAlignments.length > 0) {
|
||||
// Visual Alignment greift später
|
||||
} else if (state.inImportBlock) {
|
||||
if (!cleanLine.startsWith('from ')) {
|
||||
result = " ".repeat((state.indentLevel + 2) * state.tabSize) + trimmedLine;
|
||||
} else {
|
||||
result = state.currentIndentString + trimmedLine;
|
||||
}
|
||||
} else {
|
||||
result = state.currentIndentString + trimmedLine;
|
||||
}
|
||||
|
||||
// 5. INDENT (Gefixt: Mutually Exclusive / else if)
|
||||
if (/^(pattern|syncmapping|table|definitions?|define|enumeration|configuration|overview|metadata|constants|triggers|body|mapping|removal)\b/.test(cleanLine)) {
|
||||
state.indentLevel++;
|
||||
}
|
||||
else if (this.blockOpens.test(line)) {
|
||||
} else if (/\b(then|do)\b$/.test(cleanLine)) {
|
||||
state.indentLevel++;
|
||||
} else if (/^else\b/.test(cleanLine)) {
|
||||
state.indentLevel++;
|
||||
}
|
||||
|
||||
return currentIndent + line;
|
||||
// 6. Import Block Tracking
|
||||
if (cleanLine.startsWith('from ')) {
|
||||
state.inImportBlock = true;
|
||||
}
|
||||
if (state.inImportBlock && cleanLine.endsWith(';')) {
|
||||
state.inImportBlock = false;
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
tpl 1.21 module TestFormat;
|
||||
|
||||
define format_me()
|
||||
// 6 Leerzeichen hier!
|
||||
log.debug("2 Leerzeichen hier");
|
||||
if true then
|
||||
log.debug("3 Leerzeichen!");
|
||||
end if;
|
||||
end define;
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
tpl 1.21 module TestEdgeCases;
|
||||
|
||||
define my_edge_func()
|
||||
"""
|
||||
Ein böser DocString mit ( [ = und if und end
|
||||
"""
|
||||
// Ein Kommentar mit DiscoveryFunctions.escapePath(1,2,3,4,5,6)
|
||||
|
||||
clean_path := DiscoveryFunctions.escapePath(host, "böse(Klammern)", true);
|
||||
|
||||
if test = "ein_string_mit_komma," then
|
||||
log.debug("alles gut");
|
||||
end if;
|
||||
end define;
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
tpl 1.21 module TestNegative;
|
||||
|
||||
define my_bad_func()
|
||||
// Unbekannte Funktion (Info)
|
||||
rdbms_functions.does_not_exist(host);
|
||||
|
||||
// Falsche Parameter-Anzahl (Warning)
|
||||
DiscoveryFunctions.escapePath(host, "path", true, "zu_viel");
|
||||
|
||||
// Zuweisung fehlt für Return-Value (Warning)
|
||||
DiscoveryFunctions.escapePath(host, "path", true);
|
||||
end define;
|
||||
Binary file not shown.
|
|
@ -0,0 +1,38 @@
|
|||
import * as assert from 'assert';
|
||||
import * as vscode from 'vscode';
|
||||
import { TabFix } from '../../providers/actions/TabFix';
|
||||
import { LogFix } from '../../providers/actions/LogFix';
|
||||
|
||||
suite('Code Actions Test Suite', () => {
|
||||
test('TabFix: Generates Replace-Edit for tabs', () => {
|
||||
const fix = new TabFix();
|
||||
const diag = new vscode.Diagnostic(new vscode.Range(0, 0, 0, 1), "Tab found", vscode.DiagnosticSeverity.Warning);
|
||||
|
||||
// Mock for TextDocument
|
||||
const mockDoc = {
|
||||
uri: vscode.Uri.file('test.tpl'),
|
||||
lineAt: () => ({ text: '\t\tcode', range: new vscode.Range(0, 0, 0, 6) })
|
||||
} as any;
|
||||
|
||||
const actions = fix.provideFix(mockDoc, diag);
|
||||
assert.strictEqual(actions.length, 1);
|
||||
|
||||
// Update this string if your actual TabFix title differs!
|
||||
assert.strictEqual(actions[0].title, "Convert tabs to 4 spaces");
|
||||
assert.ok(actions[0].edit !== undefined);
|
||||
});
|
||||
|
||||
test('LogFix: Generates Insert-Edit with log statement', () => {
|
||||
const fix = new LogFix();
|
||||
const diag = new vscode.Diagnostic(new vscode.Range(10, 0, 10, 4), "Missing log");
|
||||
diag.source = 'log.debug("Start pattern Test");'; // Linter-Source Simulation
|
||||
|
||||
const mockDoc = { uri: vscode.Uri.file('test.tpl') } as any;
|
||||
|
||||
const actions = fix.provideFix(mockDoc, diag);
|
||||
assert.strictEqual(actions.length, 1);
|
||||
|
||||
// Update this string if your actual LogFix title differs!
|
||||
assert.strictEqual(actions[0].title, "Insert missing log statement");
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
import * as assert from 'assert';
|
||||
import * as vscode from 'vscode';
|
||||
import { SnippetCompletion } from '../../providers/completions/SnippetCompletion';
|
||||
import { LocalContextCompletion } from '../../providers/completions/LocalContextCompletion';
|
||||
import { workspaceIndex } from '../../core/WorkspaceIndex';
|
||||
|
||||
function createMockDoc(text: string): any {
|
||||
const lines = text.split('\n');
|
||||
return {
|
||||
getText: () => text,
|
||||
lineAt: (i: number) => ({ text: lines[i] })
|
||||
};
|
||||
}
|
||||
|
||||
suite('Completion Provider Test Suite', () => {
|
||||
|
||||
// Feeds the RAM index with a dummy file before tests
|
||||
suiteSetup(() => {
|
||||
const dummyUri = vscode.Uri.file('/fake/path/Company.tools.tpl');
|
||||
const dummyText = `
|
||||
tpl 1.23 module Company.tools;
|
||||
definitions network_helpers
|
||||
define ping(host, ip)
|
||||
end define;
|
||||
end definitions;
|
||||
`.trim();
|
||||
workspaceIndex.updateFile(dummyUri, dummyText);
|
||||
});
|
||||
|
||||
test('LocalContextCompletion: "from " suggests only RAM modules', async () => {
|
||||
const strategy = new LocalContextCompletion();
|
||||
const mockDoc = createMockDoc(`from `);
|
||||
const position = new vscode.Position(0, 5);
|
||||
|
||||
const result = await strategy.provideCompletions(mockDoc, position, 'from ');
|
||||
|
||||
assert.ok(result !== undefined);
|
||||
const hasModule = result!.some(item => item.label === 'Company.tools');
|
||||
assert.strictEqual(hasModule, true, "Must suggest the module from RAM.");
|
||||
});
|
||||
|
||||
test('LocalContextCompletion: "from X import " suggests definition blocks', async () => {
|
||||
const strategy = new LocalContextCompletion();
|
||||
const mockDoc = createMockDoc(`from Company.tools import `);
|
||||
const position = new vscode.Position(0, 26);
|
||||
|
||||
const result = await strategy.provideCompletions(mockDoc, position, 'from Company.tools import ');
|
||||
|
||||
assert.ok(result !== undefined);
|
||||
const hasBlock = result!.some(item => item.label === 'network_helpers');
|
||||
assert.strictEqual(hasBlock, true, "Must suggest the definition block from the module.");
|
||||
});
|
||||
|
||||
test('LocalContextCompletion: Blocks fallback for unknown namespace', async () => {
|
||||
const strategy = new LocalContextCompletion();
|
||||
const mockDoc = createMockDoc(`randomstuff.`);
|
||||
const position = new vscode.Position(0, 12);
|
||||
|
||||
const result = await strategy.provideCompletions(mockDoc, position, 'randomstuff.');
|
||||
|
||||
assert.ok(result !== undefined);
|
||||
assert.strictEqual(result!.length, 0, "Must return an empty array to block VS Code text spam.");
|
||||
});
|
||||
test('LocalContextCompletion: Imported namespace generates parameter snippet', async () => {
|
||||
const strategy = new LocalContextCompletion();
|
||||
|
||||
const docText = `from Company.tools import network_helpers;\nnetwork_helpers.`;
|
||||
const mockDoc = createMockDoc(docText);
|
||||
const position = new vscode.Position(1, 16);
|
||||
|
||||
const result = await strategy.provideCompletions(mockDoc, position, 'network_helpers.');
|
||||
|
||||
assert.ok(result !== undefined);
|
||||
const funcItem = result!.find(item => item.label === 'ping');
|
||||
assert.ok(funcItem !== undefined, "Must find the ping function");
|
||||
|
||||
const snippet = funcItem?.insertText as vscode.SnippetString;
|
||||
assert.strictEqual(snippet.value, 'ping(${1:host}, ${2:ip});$0', "Must map parameters exactly");
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,112 @@
|
|||
import * as assert from 'assert';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import * as vscode from 'vscode';
|
||||
import { ParameterRule } from '../../core/rules/ParameterRule';
|
||||
import { IndentationRules } from '../../providers/formatters/IndentationRules';
|
||||
import { FormatState } from '../../providers/formatters/FormatState';
|
||||
import { LinterContext } from '../../core/LinterContext';
|
||||
import { TplLookup } from '../../core/TplLookup';
|
||||
import { workspaceIndex } from '../../core/WorkspaceIndex';
|
||||
|
||||
class MockLinterContext extends LinterContext {
|
||||
public diagnostics: vscode.Diagnostic[] = [];
|
||||
|
||||
constructor() {
|
||||
super();
|
||||
}
|
||||
|
||||
public addDiag(lineIdx: number, start: number, end: number, msg: string, severity: vscode.DiagnosticSeverity): vscode.Diagnostic {
|
||||
const range = new vscode.Range(lineIdx, start, lineIdx, end);
|
||||
const diag = new vscode.Diagnostic(range, msg, severity);
|
||||
this.diagnostics.push(diag);
|
||||
return diag;
|
||||
}
|
||||
}
|
||||
|
||||
suite('BMC TPL Core Engine Tests', () => {
|
||||
|
||||
const fixturesPath = path.resolve(__dirname, '../../../src/test/fixtures');
|
||||
|
||||
suite('TplLookup & Autocomplete', () => {
|
||||
test('Should resolve Core and TKU built-ins case-insensitively', () => {
|
||||
const runCmd = TplLookup.getBuiltInFunction('discovery', 'runcommand');
|
||||
assert.ok(runCmd, 'discovery.runCommand should be found ignoring case');
|
||||
|
||||
const tkuCmd = TplLookup.getBuiltInFunction('COMMON_FUNCTIONS', 'identify_host');
|
||||
assert.ok(tkuCmd, 'Common_Functions.identify_host should be found ignoring case');
|
||||
});
|
||||
});
|
||||
|
||||
suite('ParameterRule (Lexer & Linter)', () => {
|
||||
test('Should catch negative cases (unknown func, param count, unused return)', () => {
|
||||
const rule = new ParameterRule();
|
||||
const ctx = new MockLinterContext();
|
||||
|
||||
const originalGetSignatures = workspaceIndex.getFunctionSignatures.bind(workspaceIndex);
|
||||
workspaceIndex.getFunctionSignatures = (name: string) => {
|
||||
if (name === 'my_local_func') {
|
||||
return [{
|
||||
name: 'my_local_func',
|
||||
params: ['a', 'b'],
|
||||
hasReturnValue: true,
|
||||
docString: '',
|
||||
moduleName: 'TestNegative',
|
||||
lineIdx: 1,
|
||||
fsPath: 'test.tpl'
|
||||
}];
|
||||
}
|
||||
return originalGetSignatures(name);
|
||||
};
|
||||
|
||||
// GEFIXT: "dummy :=" hinzugefügt, um den doppelten Return-Value-Fehler zu vermeiden
|
||||
const content = `tpl 1.21 module TestNegative;
|
||||
define test_func()
|
||||
unknown_module.does_not_exist(host);
|
||||
dummy := my_local_func(1, 2, 3);
|
||||
my_local_func(1, 2);
|
||||
end define;`;
|
||||
|
||||
const lines = content.split('\n');
|
||||
lines.forEach((line, idx) => rule.checkLine(line, line, idx, ctx, lines));
|
||||
|
||||
workspaceIndex.getFunctionSignatures = originalGetSignatures;
|
||||
|
||||
assert.strictEqual(ctx.diagnostics.length, 3, 'Should find exactly 3 errors in negative fixture');
|
||||
|
||||
assert.ok(ctx.diagnostics.some(d => d.message.includes("Unknown function 'unknown_module.does_not_exist'")));
|
||||
assert.ok(ctx.diagnostics.some(d => d.message.includes("expects 2 parameter(s), but 3 were provided")));
|
||||
assert.ok(ctx.diagnostics.some(d => d.message.includes("is not used. Did you forget an assignment (:=)?")));
|
||||
});
|
||||
|
||||
test('Should ignore strings, docstrings and comments (Lexer Edge Cases)', () => {
|
||||
const rule = new ParameterRule();
|
||||
const ctx = new MockLinterContext();
|
||||
|
||||
const content = fs.readFileSync(path.join(fixturesPath, 'lexer_edge_cases.tpl'), 'utf-8');
|
||||
const lines = content.split('\n');
|
||||
|
||||
lines.forEach((line, idx) => rule.checkLine(line, line, idx, ctx, lines));
|
||||
|
||||
assert.strictEqual(ctx.diagnostics.length, 0, 'Should find NO errors in lexer edge cases');
|
||||
});
|
||||
});
|
||||
|
||||
suite('IndentationRules (Auto-Formatter)', () => {
|
||||
test('Should forcefully fix bad indentation', () => {
|
||||
const rule = new IndentationRules();
|
||||
const state = new FormatState();
|
||||
|
||||
const content = fs.readFileSync(path.join(fixturesPath, 'format_bad.tpl'), 'utf-8');
|
||||
const lines = content.split('\n');
|
||||
|
||||
const formattedLines = lines.map(line => rule.apply(line, state));
|
||||
|
||||
assert.strictEqual(formattedLines[3], ' // 6 Leerzeichen hier!');
|
||||
assert.strictEqual(formattedLines[4], ' log.debug("2 Leerzeichen hier");');
|
||||
assert.strictEqual(formattedLines[5], ' if true then');
|
||||
assert.strictEqual(formattedLines[6], ' log.debug("3 Leerzeichen!");');
|
||||
assert.strictEqual(formattedLines[7], ' end if;');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -4,49 +4,49 @@ import { IndentationRules } from '../../providers/formatters/IndentationRules';
|
|||
import { AlignmentRules } from '../../providers/formatters/AlignmentRules';
|
||||
|
||||
suite('Formatter Test Suite', () => {
|
||||
test('IndentationRules: if/then/end Block korrekt einrücken', () => {
|
||||
test('IndentationRules: Indents if/then/end block correctly', () => {
|
||||
const indentRules = new IndentationRules();
|
||||
const state = new FormatState();
|
||||
state.tabSize = 4;
|
||||
|
||||
// Zeile 1: if condition then (erwartet: 0 Leerzeichen, aber Level springt auf 1 für die nächste Zeile)
|
||||
// Line 1: if condition then (expected: 0 spaces, but level jumps to 1 for the next line)
|
||||
let result = indentRules.apply('if x = 1 then', state);
|
||||
assert.strictEqual(result, 'if x = 1 then');
|
||||
assert.strictEqual(state.indentLevel, 1);
|
||||
|
||||
// Zeile 2: normaler Code im Block (erwartet: 4 Leerzeichen)
|
||||
// Line 2: normal code in block (expected: 4 spaces)
|
||||
result = indentRules.apply('log.debug("test");', state);
|
||||
assert.strictEqual(result, ' log.debug("test");');
|
||||
assert.strictEqual(state.indentLevel, 1);
|
||||
|
||||
// Zeile 3: end if; (erwartet: 0 Leerzeichen, Level springt sofort vor der Ausgabe auf 0)
|
||||
// Line 3: end if; (expected: 0 spaces, level jumps to 0 right before output)
|
||||
result = indentRules.apply('end if;', state);
|
||||
assert.strictEqual(result, 'end if;');
|
||||
assert.strictEqual(state.indentLevel, 0);
|
||||
});
|
||||
|
||||
test('IndentationRules: elif und else verhalten sich korrekt', () => {
|
||||
test('IndentationRules: elif and else behave correctly', () => {
|
||||
const indentRules = new IndentationRules();
|
||||
const state = new FormatState();
|
||||
state.tabSize = 4;
|
||||
state.indentLevel = 1; // Wir starten quasi IN einem offenen if-Block
|
||||
state.indentLevel = 1; // We start practically IN an open if-block
|
||||
|
||||
// elif muss zurückspringen (auf 0) und danach wieder auf 1 für den folgenden Block
|
||||
// elif must jump back (to 0) and then back to 1 for the following block
|
||||
let result = indentRules.apply('elif x = 2 then', state);
|
||||
assert.strictEqual(result, 'elif x = 2 then');
|
||||
assert.strictEqual(state.indentLevel, 1);
|
||||
});
|
||||
|
||||
test('AlignmentRules: Visual Alignment an runden Klammern', () => {
|
||||
test('AlignmentRules: Visual alignment at parentheses', () => {
|
||||
const alignRules = new AlignmentRules();
|
||||
const state = new FormatState();
|
||||
|
||||
// 1. Zeile mit öffnender Klammer
|
||||
// 1. Line with opening parenthesis
|
||||
alignRules.apply('discovery.runCommand(', 'discovery.runCommand(', state);
|
||||
assert.strictEqual(state.parenAlignments.length, 1);
|
||||
assert.strictEqual(state.parenAlignments[0], 21); // 21 Zeichen bis nach der offenen Klammer
|
||||
assert.strictEqual(state.parenAlignments[0], 21); // 21 characters until after the open parenthesis
|
||||
|
||||
// 2. Zeile (Parameter soll exakt bis Spalte 21 eingerückt werden)
|
||||
// 2. Line (parameter should be indented exactly to column 21)
|
||||
const result = alignRules.apply('host,', 'host,', state);
|
||||
assert.strictEqual(result, ' host,');
|
||||
});
|
||||
|
|
|
|||
|
|
@ -1,45 +1,84 @@
|
|||
import * as assert from 'assert';
|
||||
import * as vscode from 'vscode';
|
||||
import { LinterContext } from '../../core/LinterContext';
|
||||
import { SyntaxRule } from '../../core/rules/SyntaxRule';
|
||||
import { BlockRule } from '../../core/rules/BlockRule';
|
||||
import { validateTplDocument } from '../../core/TplLinter';
|
||||
|
||||
suite('Linter SyntaxRule Test Suite', () => {
|
||||
test('Zuweisung: Warnt bei "=" statt ":="', () => {
|
||||
suite('Linter Test Suite', () => {
|
||||
test('SyntaxRule: Ignores URLs and special characters in strings', () => {
|
||||
const rule = new SyntaxRule();
|
||||
const ctx = new LinterContext();
|
||||
ctx.activePhaseName = 'body'; // Allowed zone
|
||||
|
||||
// Wir simulieren eine Code-Zeile
|
||||
const rawLine = " my_var = 123;";
|
||||
rule.checkLine(rawLine.trim(), rawLine, 0, ctx);
|
||||
const rawLine = ' log.debug("https://example.com/api?q=1//test");';
|
||||
rule.checkLine(rawLine.trim(), rawLine, 0, ctx, [rawLine]);
|
||||
|
||||
// Erwartung: Ein Fehler wegen falscher Zuweisung
|
||||
assert.strictEqual(ctx.diagnostics.length, 1);
|
||||
assert.ok(ctx.diagnostics[0].message.includes("In TPL wird ':=' für Zuweisungen genutzt"));
|
||||
});
|
||||
|
||||
test('Zuweisung: Akzeptiert "=" als Vergleich in if-Bedingung', () => {
|
||||
const rule = new SyntaxRule();
|
||||
const ctx = new LinterContext();
|
||||
|
||||
// Wir simulieren eine if-Zeile (setzt ctx.inConditionBlock intern auf true)
|
||||
const rawLine = " if my_var = 123 then";
|
||||
rule.checkLine(rawLine.trim(), rawLine, 0, ctx);
|
||||
|
||||
// Erwartung: Kein Fehler, da das = als Vergleich legitim ist
|
||||
// Must not throw an error (neither missing semicolon nor broken comment)
|
||||
assert.strictEqual(ctx.diagnostics.length, 0);
|
||||
});
|
||||
|
||||
test('Klammern: Findet ungeschlossene runde Klammern', () => {
|
||||
test('Linter: Captures TODOs as Information', () => {
|
||||
const mockDoc = {
|
||||
languageId: 'tpl',
|
||||
getText: () => "tpl 1.0 module Test;\n// TODO: refactor this",
|
||||
uri: vscode.Uri.file('test.tpl')
|
||||
} as any;
|
||||
|
||||
const collection = vscode.languages.createDiagnosticCollection('test-collection');
|
||||
validateTplDocument(mockDoc, collection);
|
||||
|
||||
const diags = collection.get(mockDoc.uri);
|
||||
assert.strictEqual(diags?.length, 1, "Must find exactly one TODO");
|
||||
assert.ok(diags![0].message.includes('TODO: refactor this'));
|
||||
assert.strictEqual(diags![0].severity, vscode.DiagnosticSeverity.Information);
|
||||
});
|
||||
|
||||
test('SyntaxRule: Multi-line if-condition without semicolon error', () => {
|
||||
const rule = new SyntaxRule();
|
||||
const ctx = new LinterContext();
|
||||
ctx.activePhaseName = 'body';
|
||||
|
||||
// Wir öffnen eine Klammer, schließen sie aber nicht
|
||||
const rawLine = " my_func(parameter;";
|
||||
rule.checkLine(rawLine.trim(), rawLine, 0, ctx);
|
||||
// Line 1: or-break
|
||||
rule.checkLine('if x = 1 or', 'if x = 1 or', 0, ctx, []);
|
||||
assert.strictEqual(ctx.diagnostics.length, 0);
|
||||
assert.strictEqual(ctx.inConditionBlock, true);
|
||||
|
||||
// checkEnd wird am Ende der Datei aufgerufen
|
||||
rule.checkEnd(['', rawLine], ctx);
|
||||
// Line 2: then-closure
|
||||
rule.checkLine('y = 2 then', 'y = 2 then', 1, ctx, []);
|
||||
assert.strictEqual(ctx.diagnostics.length, 0, "'then' must not require a semicolon at the end!");
|
||||
assert.strictEqual(ctx.inConditionBlock, false);
|
||||
});
|
||||
|
||||
assert.strictEqual(ctx.diagnostics.length, 1);
|
||||
assert.ok(ctx.diagnostics[0].message.includes("Öffnende Klammer '(' wird nicht geschlossen!"));
|
||||
test('SyntaxRule: Allowed allocations in Zones (e.g. metadata)', () => {
|
||||
const rule = new SyntaxRule();
|
||||
const ctx = new LinterContext();
|
||||
ctx.inModuleMetadata = true; // We are in module metadata
|
||||
|
||||
const rawLine = " origin := 'Custom';";
|
||||
rule.checkLine(rawLine.trim(), rawLine, 0, ctx, [rawLine]);
|
||||
|
||||
assert.strictEqual(ctx.diagnostics.length, 0, "Allocations have to be allowed in metadata");
|
||||
});
|
||||
|
||||
test('BlockRule: if/for/while stack tracking', () => {
|
||||
const mockDoc = {
|
||||
languageId: 'tpl',
|
||||
getText: () => "tpl 1.0 module Test;\nif condition then\nend for;",
|
||||
uri: vscode.Uri.file('test.tpl')
|
||||
} as any;
|
||||
|
||||
const collection = vscode.languages.createDiagnosticCollection('test-collection-blockrule');
|
||||
validateTplDocument(mockDoc, collection);
|
||||
|
||||
const diags = collection.get(mockDoc.uri);
|
||||
|
||||
// We check language-agnostically: Is there an Error exactly on line 2 (the 'end for;')?
|
||||
const hasErrorOnEndFor = diags?.some(d =>
|
||||
d.range.start.line === 2 &&
|
||||
d.severity === vscode.DiagnosticSeverity.Error
|
||||
);
|
||||
|
||||
assert.strictEqual(hasErrorOnEndFor, true, "Need to throw an error on 'end for;' line");
|
||||
});
|
||||
});
|
||||
Loading…
Reference in New Issue