NestJS Environment Sync Utility

Un outil CLI pour automatiser la gestion des variables d'environnement dans les projets NestJS.

Fonctionnalités

• 🔍 Détection automatique des variables dans tout le projet
• 📝 Génération/mise à jour de .env.example
• ✏️ Mise à jour du schéma de validation Joi
• 🔄 Synchronisation des variables entre fichiers

Installation

npm install -g nest-env-sync
# ou
npx nest-env-sync [command]

Utilisation

1. Générer/mettre à jour les fichiers

env-sync generate

Cette commande :

• Parcourt tous les fichiers du projet pour trouver les variables
• Met à jour .env.example avec toutes les variables détectées
• Met à jour le schéma de validation dans app.module.ts

2. Ajouter une nouvelle variable

env-sync update MA_VARIABLE=valeur

Cette commande :

• Ajoute la variable à .env (avec la valeur)
• Ajoute la variable à .env.example (sans valeur)
• Met à jour le schéma de validation Joi

Configuration

L'utilitaire fonctionne sans configuration, mais vous pouvez personnaliser :

Schéma de validation : Placez-le dans :

• src/app.module.ts

Dossiers scannés :

Par défaut, tous les dossiers sauf node_modules et dist

Exemple complet

# Première utilisation
env-sync generate

# Ajouter une variable
env-sync update DATABASE_URL=postgres://user:pass@localhost:5432/db

# Vérifier les nouvelles variables
env-sync generate

Bonnes pratiques

• Commencez par exécuter env-sync generate pour initialiser les fichiers
• Ajoutez les variables sensibles à .env (dans .gitignore)
• Conservez .env.example dans le dépôt comme modèle
• Exécutez env-sync generate après chaque ajout de variable

Dépannage

Problème : Schéma Joi non détecté

Solution : Assurez-vous que votre schéma est dans le fichier suivant :

• src/app.module.ts

Problème : Variables non détectées

Solution : Vérifiez que :

• Le fichier contenant la variable est dans un dossier scanné
• La syntaxe est process.env.MA_VARIABLE ou process.env['MA_VARIABLE']

Contribution

Les contributions sont les bienvenues ! Ouvrez une issue ou soumettez une PR.

Licence

MIT