Seminar Engineering & Customizing: Build from Source, VSIX, Editor-Integrationen

Inhaltsverzeichnis

• Abstract
• Zielgruppe und Voraussetzungen
• Lernziele
• Inhalte und Agenda
• LSP-Binary bauen und verifizieren
• VSIX aus Quellen bauen
• Emacs/Vim/Neovim anbinden
• Ergebnisse und Transfer

Abstract

Dieses Engineering-Modul richtet sich an Teams, die SuperBOL/TramaBOL-nahes Tooling betreiben, paketieren oder erweitern müssen. Behandelt werden: Aufbau einer OCaml/opam-basierten Build-Umgebung, Installation des LSP-Binaries, Erzeugung einer VSIX aus Quellen (inkl. Submodules und Build-Dependencies) sowie die Integration des LSP in alternative Editoren (GNU/Emacs, Vim/Neovim). Schwerpunkt ist ein reproduzierbarer Build- und Releaseprozess für interne Distributionen, inklusive Validierung, Versionierung und Betriebsstandards.

Zielgruppe und Voraussetzungen

• Zielgruppe: Tooling-/Plattform-Engineering, DevEx, Build- und Release-Teams, Advanced Maintainers
• Voraussetzungen: Gute CLI-Erfahrung, Build/Packaging-Grundlagen, Möglichkeit OCaml/opam zu betreiben

Lernziele

• OCaml/opam-Umgebung für SuperBOL reproduzierbar aufsetzen
• LSP-Binary bauen und funktional verifizieren
• VSIX-Paket aus Quellen erzeugen und intern verteilen
• LSP in Emacs sowie Vim/Neovim anbinden und semantic highlighting nutzbar machen

Inhalte und Agenda

• Build-Setup: opam installieren/initialisieren, Switch-Konzept, Version-Pinning
• Repo-Build: Dependencies, Build-Tooling, Installationsschritte, Verifikation via Versionsabfrage
• VSIX-Build: Submodule, Node.js, Build Targets, Artefaktprüfung
• Editor-Integrationen:
  • Emacs: Mode, Indentation, LSP-Clients (lsp-mode/eglot)
  • Vim/Neovim: LSP-Konfiguration, semanticTokens, Syntax-Interaktion
• Betriebsaspekte: interne Distribution, Update-Strategie, Support-Playbook

LSP-Binary bauen und verifizieren

• opam installieren und initialisieren (Unternehmensstandard beachten)
• OCaml-Switch erstellen (Version nach Tooling-Standard definieren)
• Quellcode aus dem offiziellen Repository beziehen (intern gespiegelt möglich)
• Build-Dependencies installieren (z. B. Build-Tool und Projektabhängigkeiten)
• Installation durchführen (Projektinstall/Build)
• Verifikation: superbol-free --version (oder äquivalent) und LSP-Starttest

VSIX aus Quellen bauen

• Repository klonen und Submodules aktualisieren
• Externe Dependencies prüfen (Node.js, Build-Tooling)
• Build-Targets ausführen: Dependencies + VSIX-Release
• Artefakt prüfen: superbol-vscode-platform.vsix vorhanden
• VS Code: Installation aus VSIX und Funktionsverifikation (LSP-Features, Tasks, Debug-Kompatibilität)

Emacs/Vim/Neovim anbinden

• LSP-Binary-Pfad als Umgebungsvariable/Setting definieren
• Emacs: Mode-Dateien bereitstellen, Load-Path konfigurieren, Dateiendungen zuordnen
• Emacs LSP: Entscheidung lsp-mode vs. eglot (Trade-offs dokumentieren), Startparameter setzen
• Vim: LSP über bevorzugtes Plugin konfigurieren, semanticTokens aktivieren, Syntax ggf. deaktivieren
• Neovim: lspconfig-Setup, Root-Dir-Regel, Startcommand, Attach-Funktion
• Validierung: Go-to-Definition, Referenzen, Hover/Peek (wo verfügbar), Formatierung

Ergebnisse und Transfer

• Reproduzierbarer Build- und Packaging-Prozess (Runbook)
• Interne Distributionsstrategie (VSIX, Binary, Versionsstandard)
• Editor-Integrationsvorlagen (Emacs/Vim/Neovim)