Files

bsiggel 552540e214 feat: Add KI-Einstiegsscript for comprehensive project overview

- Introduced `ki_project_overview.py` for automated analysis of EspoCRM project structure, entities, relationships, custom PHP classes, workflows, frontend adjustments, and internationalization.
- Created `ki-overview.sh` wrapper script for executing the Python script with various output options.
- Updated `README.md` to include a quick start section for the new KI entry script.
- Added detailed documentation in `KI_OVERVIEW_README.md` explaining the script's purpose, usage, and output format.
- Summarized the new features and files in `KI_OVERVIEW_SUMMARY.md`.
- Enhanced `.vscode/settings.json` to approve new scripts for execution.

2026-01-25 12:34:46 +01:00

7.6 KiB

Raw Blame History

KI-Einstiegsscript Projekt - Zusammenfassung

Erstellte Dateien

1. Haupt-Python-Script

Datei: custom/scripts/ki_project_overview.py

Vollständige Projekt-Analyse
3376+ Zeilen Output
Analysiert automatisch:
- ✅ 21 Custom Entities mit Feldern und Beziehungen
- ✅ Relationship-Graph
- ✅ 1 Custom PHP Klasse
- ✅ 1 Workflow
- ✅ 10 JavaScript Files
- ✅ 2 CSS Files
- ✅ 3 Custom Layouts
- ✅ 35 Sprachen (i18n)

2. Bash Wrapper-Script

Datei: custom/scripts/ki-overview.sh

Komfortable Nutzung mit Optionen:

./custom/scripts/ki-overview.sh              # Vollständige Ausgabe
./custom/scripts/ki-overview.sh --stats      # Nur Statistiken
./custom/scripts/ki-overview.sh --entities   # Nur Entitäten
./custom/scripts/ki-overview.sh --relations  # Nur Beziehungsgraph
./custom/scripts/ki-overview.sh --file       # In Datei speichern
./custom/scripts/ki-overview.sh --help       # Hilfe

3. Dokumentation

Datei: custom/scripts/KI_OVERVIEW_README.md

Umfassende Dokumentation mit:

Zweck und Verwendung
Ausgabeformat-Beschreibung
Anwendungsfälle
Integration mit validate_and_rebuild.py
Technische Details
Erweiterungsmöglichkeiten
Troubleshooting

4. README.md Update

Datei: README.md (Schnellstart-Sektion hinzugefügt)

Neuer Abschnitt am Anfang:

## 🚀 Schnellstart für KI

**NEU:** Automatisches KI-Einstiegsscript für vollständigen Projekt-Überblick!

Verwendung für KI

Szenario 1: Neue Programmieraufgabe

# KI erhält vollständigen Kontext
./custom/scripts/ki-overview.sh > /tmp/overview.txt

# Output an KI übergeben
cat /tmp/overview.txt

Die KI erhält:

README.md (vollständig, 2112 Zeilen)
Alle 21 Entities mit Feldern, Typen, Constraints
Alle Beziehungen (hasMany, belongsTo, etc.)
Custom PHP Klassen
Workflows (Status, Aktionen)
Frontend-Code (JS, CSS)
i18n Sprachen

Szenario 2: Schneller Überblick

# Nur Statistiken
./custom/scripts/ki-overview.sh --stats

Zeigt:

📊 Projekt-Statistiken:
   • Entities                21
   • PHP Classes              1
   • Workflows                1
   • JavaScript Files        10
   • CSS Files                2
   • Custom Layouts           3
   • Languages               35

Szenario 3: Beziehungen verstehen

# Nur Beziehungsgraph
./custom/scripts/ki-overview.sh --relations

Zeigt alle Entity-Beziehungen:

CMietobjekt:
   ⇄ mietverhltnisse [hasMany] → CVmhMietverhltnis
   ⇄ kontakte [hasMany] → Contact
   → vermieter [belongsTo] → CVmhVermieter
   ...

Vorteile

Für KI

Vollständiger Kontext: Keine manuellen Dateiabfragen nötig
Aktuell: Immer auf dem neuesten Stand
Strukturiert: Klare Sektionen, leicht zu parsen
Umfassend: README + automatische Analyse

Für Entwickler

Zeitersparnis: Keine manuelle Dokumentation
Übersichtlich: Alle Infos an einem Ort
Wartbar: Automatisch generiert, immer korrekt
Flexibel: Verschiedene Output-Optionen

Integration in Workflow

┌─────────────────────────────────────┐
│ 1. KI-Einstiegsscript ausführen    │
│    ./custom/scripts/ki-overview.sh  │
└───────────────┬─────────────────────┘
                │
                ▼
┌─────────────────────────────────────┐
│ 2. KI erhält Projekt-Kontext        │
│    - README.md                      │
│    - Entities & Felder              │
│    - Beziehungen                    │
│    - Custom Code                    │
└───────────────┬─────────────────────┘
                │
                ▼
┌─────────────────────────────────────┐
│ 3. KI macht Änderungen              │
│    - Erstellt/bearbeitet JSON       │
│    - Fügt Felder hinzu              │
│    - Definiert Beziehungen          │
└───────────────┬─────────────────────┘
                │
                ▼
┌─────────────────────────────────────┐
│ 4. Validierung & Rebuild            │
│    ./custom/scripts/                │
│      validate_and_rebuild.py        │
└─────────────────────────────────────┘

Technische Details

Performance

Analysiert 21 Entities in < 1 Sekunde
3376 Zeilen Output
Effiziente JSON-Parsing mit Error-Handling

Robustheit

Fehlerhafte JSON-Dateien werden übersprungen
Fehlende Verzeichnisse = Info, kein Abbruch
Umfangreiche Exception-Behandlung

Erweiterbarkeit

Neue Analysen können einfach hinzugefügt werden:

def analyze_new_feature():
    """Analysiert neues Feature."""
    print_section("NEUES FEATURE", "=")
    # Implementierung
    ...

# In main() aufrufen
def main():
    ...
    analyze_new_feature()

Ausgabe-Beispiel (Auszug)

================================================================================
                                ENTITÄTEN ANALYSE                               
================================================================================

────────────────────────────────────────────────────────────────────────────────
► Entität: CMietobjekt
────────────────────────────────────────────────────────────────────────────────

📋 Scope:
   • entity: CMietobjekt
   • acl: True
   • stream: False
   • type: BasePlus
   • customizable: True

🔧 Felder (15):
   • name: varchar [REQUIRED] [CUSTOM]
   • adresse: link → CAdressen
   • miete: currency (€)
   • kaution: currency (€)
   • flaeche: float
   • zimmer: int
   • etage: varchar
   • lage: enum (options: 5)
   ...

🔗 Beziehungen (8):
   • mietverhltnisse [hasMany] → CVmhMietverhltnis.mietobjekt (relationName: cMietobjektCVmhMietverhltnis)
   • kontakte [hasMany] → Contact.mietobjekte (relationName: cMietobjektContact)
   • vermieter [belongsTo] → CVmhVermieter.mietobjekte
   ...

Nächste Schritte

Für KI-Integration

✅ Script erstellt und getestet
✅ Dokumentation vollständig
✅ README.md aktualisiert
⏭️ In KI-Workflow integrieren
⏭️ Feedback sammeln und optimieren

Mögliche Erweiterungen

JSON-Output für maschinelle Verarbeitung
Markdown-Output für Dokumentation
HTML-Output für Browser
Filter-Optionen (z.B. nur bestimmte Entities)
Diff-Modus (Änderungen seit letztem Lauf)
Integration mit Git (zeige geänderte Entities)

Siehe auch

custom/scripts/validate_and_rebuild.py - Validierung & Rebuild
custom/scripts/VALIDATOR_README.md - Validator-Dokumentation
custom/CUSTOM_DIRECTORY.md - Custom Directory Struktur
README.md - Haupt-Projektdokumentation

Erstellt: 25. Januar 2026
Status: ✅ Produktionsbereit
Version: 1.0

7.6 KiB Raw Blame History