À propos de SynthKernel
SynthKernel est une architecture logicielle TypeScript qui vous aide à écrire du code efficace, propre et modulaire.
La pratique typique de SynthKernel comprend une classe de chargeur de modules et des classes de modules :
- La classe de chargeur de modules gère les cycles de vie des modules, orchestre les types et agit comme une façade à la surface de votre logique applicative.
- Toutes les classes de modules étendent une classe
BaseModule, elles définissent des API, exécutent la logique réelle, augmentent la classe du chargeur et se câblent entre elles via l'injection de dépendances. - Les types sont résolus via l'orchestration des génériques.
- Les modules sont composés au chargeur pour former une APP. Un chargeur de modules peut également être un module d'un chargeur parent.
- Cela est applicable à presque tous les cas d'utilisation, y compris mais sans s'y limiter : service backend, automatisation complexe, application CLI et moteur de rendu canvas.
Conventions du système de fichiers
SynthKernel doit être structuré selon un motif arborescent.
Un chargeur, ainsi que le module de base et tous ses modules directs, doivent être placés à plat dans un seul dossier :
- le fichier contenant le chargeur doit être nommé
index.ts - le module de base nommé
BaseModule.ts - les types nommés
types.ts - tous les modules sont nommés
(nom du module en PascalCase).ts - aucune restriction sur le nom des autres fichiers
Il est de pratique courante de transformer un module trop volumineux en une nouvelle structure chargeur-module, puis de simplement transformer le module en un dossier avec les mêmes exigences ci-dessus.
Quand utiliser
- Au stade précoce du développement, lorsque vous avez des pistes de logique mais n'avez encore écrit aucun code.
- Vous n'avez pas de convention d'architecture claire.
- Lors de refontes où vous souhaitez diviser de gros modules ou rendre le projet modulaire.
- Vous ajoutez de nouvelles fonctionnalités et envisagez de créer un nouveau module, en souhaitant comprendre SynthKernel.
Quand ne pas utiliser
- Vous n'êtes pas censé créer ou modifier l'architecture.
- Vous développez une interface utilisateur web qui a ses propres conventions.
- Vous travaillez sur un projet simple (moins de 200 lignes de code) où un monolithe classique est plus pratique.
Actions
- Si vous implémentez SynthKernel à partir de zéro ou refactorisez du code existant pour adopter SynthKernel, allez à start.
- Si vous ajoutez un nouveau module ou divisez des modules, allez à maintenance.
- Vous pouvez trouver un exemple de pratique standard dans ./example.