Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (34 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 2.58 KB

Contribuer à TopModel

TopModel

[TopModel] Prérequis

  • Installer .NET SDK

Architecture du projet

TopModel est décomposé en différents modules :

Modules Core

  • TopModel.Core : Contient les classes de base de TopModel, le parsing des modèles et la gestion du modèle de données
  • TopModel.Generator.Core : Contient les classes de base pour les générateurs (générateurs de classes, endpoints, mappers, etc.)

Modgen

  • TopModel.Generator : Générateur de code principal (modgen) qui orchestre l'exécution des différents générateurs spécialisés

Modules de génération

  • TopModel.Generator.Csharp : Générateur pour le langage C# (classes, API client/serveur, DbContext, mappers, ressources)
  • TopModel.Generator.Javascript : Générateur pour JavaScript/TypeScript (API clients Angular/Nuxt, ressources, définitions TypeScript)
  • TopModel.Generator.Jpa : Générateur pour Java/JPA (classes, endpoints, mappers, ressources)
  • TopModel.Generator.Sql : Générateur pour SQL (scripts procéduraux, SSDT)
  • TopModel.Generator.Translation : Générateur pour les fichiers de traduction

Outils et extensions

  • TopModel.ModelGenerator : Générateur de fichiers .tmd à partir de sources externes (OpenAPI, PostgreSQL, Oracle, etc.) - outil tmdgen
  • TopModel.Utils : Utilitaires partagés entre les différents modules
  • TopModel.LanguageServer : Language Server Protocol (LSP) utilisé par l'extension VSCode pour fournir l'auto-complétion, la validation et l'auto-import
  • TopModel.VSCode : Extension VSCode qui intègre TopModel dans l'éditeur

Debbugger l'extension VSCode et le Language Server

[VSCode] Prérequis

  • Installer VSCode
  • Installer NodeJS
  • Installer .NET SDK

Etapes

  • Lancer la commande dotnet publish -c debug dans le dossier TopModel.LanguageServer. Cela permet de builder le language server et de le mettre à disposition de l'extension.
  • Ouvrir le projet TopModel.VSCode avec VsCode
  • Lancer la commande npm ci pour installer les dépendances
  • Lancer la commande npm run start pour lancer le build de l'extension en mode watch
  • Le fichier .vscode/launch.json contient la configuration pour lancer le debug de l'extension. Il suffit de démarrer une session de debug avec la touche F5

Pour débugger le Language Server, ouvrir le projet TopModel.LanguageServer avec VSCode, puis lancer une session de debug en mode .NET Core Attach. Il faut ensuite sélectionner la bonne instance du language server dans la liste des processus.