IDSamurai

English below

🇩🇪 Deutsch

IDSamurai ist eine VS Code Extension, die deine Azure DevOps (ADO) Wiki-Seiten automatisch mit deinem Business Central AL-Quellcode synchronisiert. Keine veralteten Dokumentationen mehr – dein Code ist die Single Source of Truth!

[!NOTE] Entwickelt für AL-Entwickler, die eine reibungslose Dokumentations-Pipeline direkt aus dem Code-Editor heraus in das ADO Wiki benötigen.

✨ Hauptfunktionen

• 🚀 Code to Wiki Sync: Parst deine AL-Dateien (Tabellen, Pages, Codeunits etc.) und generiert automatisch saubere Markdown-Seiten.
• 🧠 Intelligente Diff-Engine: Nutzt ADO ETags, um nur die Seiten zu aktualisieren, die sich wirklich geändert haben. Das spart Zeit und vermeidet unnötige API-Calls.
• 🌳 Integrierter Wiki-Explorer: Eine Tree View direkt in der VS Code Activity Bar zeigt dir alle synchronisierten Wiki-Seiten an. Klicke auf eine Seite, um sie direkt im Browser zu öffnen.
• ⚡ Status Bar Indikator: Verfolge den Status deiner Synchronisierung (Ready, Syncing, Out of Sync, Error) live in der Statusleiste.
• 🔒 Lokale Verarbeitung: Es werden keine Daten an Dritt-Server geschickt. Alles läuft lokal in deinem VS Code ab und kommuniziert direkt mit der REST-API von Azure DevOps.

🛠️ Einrichtung & Konfiguration

1. .devops-wiki.json erstellen: Lege diese Datei im Root-Verzeichnis deines Workspaces an:

   {
     "orgUrl": "https://dev.azure.com/DEINE-ORG",
     "project": "DEIN-PROJEKT",
     "wikiId": "DEIN-WIKI-NAME"
   }
   

2. PAT konfigurieren: Führe den Command IDSamurai: PAT konfigurieren über die Command Palette (Ctrl+Shift+P) aus. Dein Personal Access Token (Scope: Wiki Read & Write) wird sicher im VS Code SecretStorage abgelegt.
3. Synchronisieren: Klicke auf den Status Bar Indikator oder nutze den Command IDSamurai: Sync.

🚀 Commands

• IDSamurai: Sync - Startet die reguläre Synchronisierung (nur geänderte Objekte).
• IDSamurai: Rebuild - Löscht und erzwingt einen kompletten Neuaufbau aller Wiki-Seiten (mit Bestätigungsdialog).
• IDSamurai: Dry-Run - Zeigt im Output Channel an, welche Seiten geändert würden, ohne Schreibvorgänge auszuführen.
• IDSamurai: PAT konfigurieren - Hinterlegt das Personal Access Token sicher.

🇬🇧 English

IDSamurai is a VS Code Extension that automatically synchronizes your Azure DevOps (ADO) Wiki pages with your Business Central AL source code. Say goodbye to outdated documentation – your code is the single source of truth!

[!NOTE] Designed for AL developers who need a seamless documentation pipeline straight from their code editor to the ADO Wiki.

✨ Key Features

• 🚀 Code to Wiki Sync: Parses your AL files (Tables, Pages, Codeunits, etc.) and automatically generates clean Markdown pages.
• 🧠 Intelligent Diff-Engine: Uses ADO ETags to update only the pages that have actually changed. Saves time and prevents unnecessary API calls.
• 🌳 Integrated Wiki Explorer: A Tree View in the VS Code Activity Bar displays all synchronized Wiki pages. Click a page to open it directly in your browser.
• ⚡ Status Bar Indicator: Track the status of your synchronization (Ready, Syncing, Out of Sync, Error) live in the status bar.
• 🔒 Local Processing: No data is sent to third-party servers. Everything runs locally in your VS Code and communicates directly with the Azure DevOps REST API.

🛠️ Setup & Configuration

1. Create .devops-wiki.json: Place this file in the root of your workspace:

   {
     "orgUrl": "https://dev.azure.com/YOUR-ORG",
     "project": "YOUR-PROJECT",
     "wikiId": "YOUR-WIKI-NAME"
   }
   

2. Configure PAT: Run the command IDSamurai: PAT konfigurieren from the Command Palette (Ctrl+Shift+P). Your Personal Access Token (Scope: Wiki Read & Write) is stored securely in the VS Code SecretStorage.
3. Synchronize: Click the Status Bar indicator or use the command IDSamurai: Sync.

🚀 Commands

• IDSamurai: Sync - Starts the regular synchronization (only changed objects).
• IDSamurai: Rebuild - Forces a complete rebuild of all Wiki pages (prompts for confirmation).
• IDSamurai: Dry-Run - Outputs a preview of changes to the Output Channel without actually writing anything.
• IDSamurai: PAT konfigurieren - Securely configure your Personal Access Token.

Built to boost developer productivity. Happy coding, Samurai!