Sounkaan

Sounkaan est un outil en ligne de commande pour générer du code de base dans un environnement Node.js/TypeScript. Il facilite la création de modèles, contrôleurs, services, validateurs, exceptions, routes et opérations CRUD, optimisant ainsi votre flux de travail de développement.

Fonctionnalités

• Génération de Modèle : Crée des modèles Prisma et des classes TypeScript correspondantes.
• Génération de Contrôleur : Génère des contrôleurs Express avec des opérations CRUD.
• Génération de Service : Crée des classes de service pour la logique métier.
• Génération de Validateur : Génère des classes pour valider les données d'entrée.
• Génération d'Exception : Crée des classes d'exception personnalisées.
• Génération de Routes : Génère des fichiers de routes Express.
• Génération de CRUD : Crée automatiquement tous les composants nécessaires aux opérations CRUD.

Installation

Installez Sounkaan globalement en utilisant npm ou yarn :

npm install -g sounkaan

ou

yarn global add sounkaan

Utilisation

Générer un Modèle

kaan make:model <modelName>

Générer un Contrôleur

kaan make:controller <controllerName>

Générer un Service

kaan make:service <serviceName>

Générer un Validateur

kaan make:validator <validatorName>

Générer une Exception

kaan make:exception <exceptionName>

Générer des Routes

kaan make:routes <routesName>

Générer des Composants CRUD

kaan make:crud <crudName>

Exemple

Pour générer un ensemble complet de CRUD pour une entité Post, utilisez :

kaan make:crud Post

Cette commande génère les éléments suivants :

• Un modèle Prisma pour Post.
• Un contrôleur pour gérer les requêtes HTTP liées à Post.
• Une classe de service pour la logique métier liée à Post.
• Une classe de validateur pour valider les données de Post.
• Une classe d'exception personnalisée pour Post.
• Des fichiers de routes Express pour gérer les routes de Post.
• Après avoir généré les composants CRUD, vous devez exécuter :

npx prisma db push && yarn generate

pour mettre à jour le schéma de votre base de données et générer le code du client Prisma.

Gestion des Erreurs

Sounkaan inclut une gestion de base des erreurs pour les entrées invalides et les opérations sur les fichiers. En cas d'erreur lors de la génération du code, celle-ci sera enregistrée dans la console, et le processus se terminera avec un code de statut 500.

Contribuer

Si vous souhaitez contribuer à Sounkaan, veuillez suivre ces directives :

1. Forkez le dépôt.
2. Créez une branche pour votre fonctionnalité (git checkout -b feature/YourFeature).
3. Commitez vos changements (git commit -am 'Add new feature').
4. Poussez la branche (git push origin feature/YourFeature).
5. Créez une nouvelle Pull Request.

Licence

Sounkaan est sous licence MIT. Voir le fichier LICENSE pour les détails.

Support

Pour obtenir de l'aide, ouvrez un problème dans le dépôt GitHub ou contactez le mainteneur.