NeoCraft CLI (nc)

Un outil en ligne de commande pour créer rapidement des projets préconfigurés (starters) pour les stacks suivantes : Vue.js, Nuxt.js, Laravel et Flutter.

Ce guide complet explique comment installer, utiliser et dépanner l’outil. Tout est en français, avec des exemples concrets à chaque étape.

Sommaire

• Fonctionnalités
• Prérequis par stack
• Installation
  • Utilisation locale (développement)
  • Mise à jour
• Utilisation
  • Mode interactif
  • Mode non‑interactif (avec options)
  • Options détaillées
  • Flux détaillé de la commande create
  • Exemples par stack
• Étapes post‑installation et "prochaines étapes"
• Gestion des conflits de dossier
• Dépannage / FAQ
• Licence

Fonctionnalités

• Affiche un logo NeoCraft et des messages colorés pour une meilleure UX.
• Propose les stacks: vue, nuxt, laravel, flutter.
• Vérifie automatiquement les dépendances requises pour la stack choisie.
• Clone le dépôt starter correspondant (via HTTPS) dans un nouveau dossier.
• Gère les conflits sur le dossier de destination (écraser, renommer, annuler, ou --force).
• Étapes post‑clone optionnelles: installation des dépendances et ré‑initialisation Git.
• Affiche des "prochaines étapes" claires pour démarrer.
• Utilisation interactive (prompts) ou non‑interactive (options CLI).

Prérequis par stack

Avant d’utiliser nc, assurez‑vous que les outils nécessaires sont installés et accessibles dans votre PATH.

• Vue.js / Nuxt.js
  • Node.js
  • npm
• Laravel
  • PHP
  • Composer
• Flutter
  • Flutter SDK (flutter)

Astuce Windows: après installation d’un outil, redémarrez votre terminal pour que le PATH soit pris en compte.

Installation

Le paquet n’est pas publié sur npm. Utilisez le mode local (développement) :

Utilisation locale (développement)

1. Cloner ce dépôt

git clone https://gitlab.com/neocraft/neocraft-cli.git
cd neocraft-cli

2. Installer les dépendances Node

npm install

3. Lier la commande globalement (pour exécuter nc partout)

npm link

Vérifiez ensuite :

nc --help

Mise à jour

Si vous avez déjà npm link et souhaitez mettre à jour :

cd /chemin/vers/neocraft-cli
git pull
npm install
npm link

Utilisation

La commande principale est create.

Mode interactif

Lancez simplement :

nc create

Vous serez invité à choisir la stack et à saisir le nom du projet. Des questions complémentaires peuvent suivre (installation des dépendances, ré‑init Git) selon vos réponses.

Mode non‑interactif (avec options)

Passez toutes les options nécessaires pour éviter les prompts :

nc create --stack vue --name my-app -y

Options détaillées

• -s, --stack <stack>: stack à utiliser. Valeurs possibles: vue, nuxt, laravel, flutter.
• -n, --name <name>: nom du projet (le dossier cible). Défaut: neocraft-<stack>-app.
• -y, --yes: accepte les choix par défaut et exécute automatiquement les étapes post‑installation (ne pose pas les questions interactives).
• -f, --force: si le dossier existe déjà, le supprime puis continue sans demander.
• --no-install: n’exécute pas l’installation des dépendances après le clonage.
• --git-init: supprime le .git du starter puis exécute git init dans le nouveau projet.

Aide générale :

nc --help
nc create --help

Flux détaillé de la commande create

1. Affichage du logo NeoCraft.
2. Récupération des paramètres: depuis les options CLI sinon via questions interactives.
3. Vérification de l’environnement pour la stack choisie.
   • Si des dépendances manquent, un message d’erreur clair s’affiche avec une astuce PATH (surtout sous Windows).
4. Gestion du dossier de destination (le nom de projet)
   • Si le dossier existe: choisir entre Écraser, Renommer ou Annuler. Avec --force, l’écrasement est automatique.
5. Clonage du dépôt starter correspondant (HTTPS) dans le dossier cible.
6. Étapes post‑clone (optionnelles)
   • Installer les dépendances:
     • Vue/Nuxt: npm install
     • Laravel: composer install
     • Flutter: flutter pub get
   • Ré‑initialiser Git (--git-init): suppression de .git puis git init.
7. Affichage des "prochaines étapes" pour démarrer immédiatement.

Exemples par stack

• Vue.js (interactif)

nc create

• Vue.js (non‑interactif)

nc create --stack vue --name mon-app -y

• Nuxt.js

nc create -s nuxt -n site-nuxt -y

• Laravel (forcer l’écrasement si le dossier existe, ne pas installer, mais ré‑init Git)

nc create -s laravel -n api -f --no-install --git-init

• Flutter

nc create -s flutter -n mobile-app -y

Étapes post‑installation et "prochaines étapes"

À la fin, la CLI affiche un rappel des commandes pour démarrer. Exemples typiques :

• Vue / Nuxt

cd <nom-de-projet>
# Si vous avez passé --no-install, exécutez d’abord : npm install
npm run dev

• Laravel

cd <nom-de-projet>
# Si vous avez passé --no-install, exécutez d’abord : composer install
php artisan serve

• Flutter

cd <nom-de-projet>
# Si vous avez passé --no-install, exécutez d’abord : flutter pub get
flutter run

Gestion des conflits de dossier

Si le dossier cible existe déjà, vous avez 3 options :

• Écraser: supprime le dossier existant et recommence.
• Renommer: choisir un autre nom (par exemple <nom>-1).
• Annuler: sort sans rien faire.

Avec l’option --force, l’outil écrase automatiquement le dossier s’il existe.

Dépannage / FAQ

• "Dépendances manquantes"
  • Installez l’outil indiqué (Node.js, npm, PHP, Composer, Flutter SDK). Vérifiez qu’il est accessible dans votre PATH. Sous Windows, redémarrez le terminal après installation.
• "Permission denied"/"auth failed" pendant le clonage
  • Les starters sont clonés via HTTPS. Assurez‑vous d’avoir l’accès à GitLab et, si votre GitLab nécessite une authentification, que vos identifiants ou tokens sont configurés.
• Le dossier existe déjà et le clonage échoue
  • Relancez avec --force pour écraser ou choisissez "Renommer" quand le prompt apparaît.
• Comment ré‑initialiser Git proprement ?
  • Utilisez --git-init (supprime .git et exécute git init).
• Comment démarrer rapidement après la création ?
  • Suivez les "prochaines étapes" affichées (cd dans le dossier, installer si besoin, puis commande de run).

Licence

ISC — voir package.json.