Scripts CLI fr FR

Résumé : Cette page documente les scripts de productivité fournis avec StartER via les commandes npm run.

Automatisation et utilitaires

StartER est livré avec plusieurs scripts centralisant les tâches répétitives (création de modules, nettoyage, synchronisation de la base de données, vérification de la qualité du code). Ces commandes facilitent le développement et assurent la cohérence du projet.

Toutes les commandes listées ci-dessous peuvent être exécutées directement dans votre terminal avec npm run.

Commande	Description
`npm run make:clone`	Duplique un module existant avec renommage automatique
`npm run make:purge`	Supprime les modules d'exemple (item, auth, user)
`npm run database:schema:load`	Charge le schéma SQL dans la base de données SQLite
`npm run database:seeder:load`	Charge les données de test dans la base de données SQLite
`npm run database:sync`	Charge le schéma SQL et les données de test dans la base de données SQLite
`npm run install:check`	Vérifie la validité de l'installation et de la base de données
`npm run biome:check`	Vérifie le style et la qualité du code avec Biome
`npm run biome:fix`	Corrige automatiquement les problèmes de formatage (Biome)
`npm run types:check`	Vérifie le typage TypeScript (`tsc --noEmit`)

`make:clone`

Duplique un fichier ou un dossier en remplaçant automatiquement toutes les occurrences d'un nom par un autre :

npm run make:clone -- <source> <destination> <AncienNom> <NouveauNom>

Par exemple, pour créer un module post à partir du module item :

npm run make:clone -- src/express/modules/item src/express/modules/post Item Post

Tip

Pensez à enregistrer les nouvelles routes du module cloné dans src/express/routes.ts.

Warning

Le compromis du clone (code WET) Bien que make:clone soit pratique pour un prototypage rapide, il favorise une approche WET (Write Everything Twice). Si vous vous retrouvez à ajouter de manière répétée la même logique (comme des règles de validation identiques, du formatage ou des vérifications d'authentification) à travers plusieurs modules clonés, il est peut-être temps d'extraire cette logique partagée dans les dossiers src/express/helpers/ ou src/react/helpers/.

`make:purge`

Supprime les modules d'exemple pour démarrer un projet vierge :

npm run make:purge

Pour conserver l'authentification :

npm run make:purge -- --keep-auth

Warning

Cette opération est réversible grâce au suivi des versions avec Git.

`database:schema:load`

Charge le schéma SQL (src/database/schema.sql) dans la base de données SQLite.

npm run database:schema:load

Pour ignorer l'invite de confirmation (utile en CI/CD) :

npm run database:schema:load -- -n

`database:seeder:load`

Charge les données de test (src/database/seeder.sql) dans la base de données SQLite.

npm run database:seeder:load

Pour ignorer l'invite de confirmation (utile en CI/CD) :

npm run database:seeder:load -- -n

`database:sync`

Réinitialise votre base de données SQLite locale (src/database/data/database.sqlite) à partir du schéma SQL et des données de test.

npm run database:sync

C'est l'équivalent de :

npm run database:schema:load && npm run database:seeder:load

Pour ignorer l'invite de confirmation (utile en CI/CD) :

npm run database:sync -- -n

`install:check`

Vérifie que votre fichier .env est correct et que l'application parvient à accéder au fichier de base de données SQLite :

npm run install:check

Qualité du code

npm run biome:check    # Vérifie le format
npm run biome:fix      # Corrige le format
npm run types:check    # Vérifie le typage

Bonnes pratiques et cas d'usage

Réinitialisation propre : utilisez npm run database:sync régulièrement pendant le développement pour repartir d'un état de base de données connu et propre.
Vérification avant commit : le hook pre-commit lance npm run types:check, npm run biome:check et npx vitest run --exclude tests/install. Vous pouvez les lancer manuellement avant de commiter vos changements pour vous assurer que le code respecte les standards du projet.
Zéro-Config : grâce à SQLite, aucun de ces scripts ne nécessite de lancer Docker au préalable, ce qui rend le cycle de développement beaucoup plus rapide.