Skip to main content

CLI

Les Necord Schematics sont un ensemble de schematics qui vous aident à initialiser, développer et maintenir vos applications Necord. Ils incarnent des modèles d'architecture conformes aux bonnes pratiques afin d'encourager des applications bien structurées.

Installation

Pour installer les schematics, exécutez la commande suivante :

npm install -g @nestjs/cli
npm install -D @necord/schematics

Utilisation

Génération de commandes

Pour générer une commande slash, vous pouvez utiliser le schematic command :

nest g -c @necord/schematics command

à partir de là, l'assistant vous demandera le nom de la commande et le type de commande.

Les options disponibles pour cette commande sont les suivantes :

OptionDescription
--nameLe nom de la commande.
--pathLe chemin où créer le service.
--flatIndique si un répertoire est créé ou non. (par défaut : false)
--sourceRootRépertoire racine des sources du service NestJS.
--specIndique si un fichier spec est généré ou non. (par défaut : true)
--strategyLe type de commande. (text-command ou slash-command)

Génération de composants de message

Pour générer un composant, vous pouvez utiliser le schematic component :

nest g -c @necord/schematics component

à partir de là, l'assistant vous demandera le nom du composant et le type de composant.

Les options disponibles pour cette commande sont les suivantes :

OptionDescription
--nameLe nom du composant.
--pathLe chemin où créer le service.
--flatIndique si un répertoire est créé ou non. (par défaut : false)
--sourceRootRépertoire racine des sources du service NestJS.
--specIndique si un fichier spec est généré ou non. (par défaut : true)
--strategyThe type of component. (button, select)

Generating context menus

To generate a context menu you can use the context menu schematic:

nest g -c @necord/schematics context-menu

from there the wizard will ask what the name of the context menu is and type of context menu.

Les options disponibles pour cette commande sont les suivantes :

OptionDescription
--nameThe name of the context menu.
--pathLe chemin où créer le service.
--flatIndique si un répertoire est créé ou non. (par défaut : false)
--sourceRootRépertoire racine des sources du service NestJS.
--specIndique si un fichier spec est généré ou non. (par défaut : true)
--strategyThe type of context menu. (user, message)

Generating modal components

To generate a modal component you can use the modal schematic:

nest g -c @necord/schematics modal

from there the wizard will ask what the name of the modal is and type of modal.

Les options disponibles pour cette commande sont les suivantes :

OptionDescription
--nameThe name of the modal.
--pathLe chemin où créer le service.
--flatIndique si un répertoire est créé ou non. (par défaut : false)
--sourceRootRépertoire racine des sources du service NestJS.
--strategyIndique si un fichier spec est généré ou non. (par défaut : true)