projet

CLI TypeScript minimale pour gérer des tâches et des utilisateurs. Le projet est conçu comme un petit exemple d'application CRUD utilisant des fichiers JSON dans src/data/.

Aperçu

Fonctionnalités principales :

• Gestion des tâches (liste, création, lecture, mise à jour, suppression).
• Gestion des utilisateurs (liste, création, lecture, mise à jour, suppression).
• Sorties CLI formatées pour faciliter la lecture.

Le code source se trouve dans src/ et le build TypeScript est généré dans dist/.

Prérequis

• Node.js >= 18
• npm

Installation

Cloner le dépôt, installer les dépendances et compiler :

git clone <repo-url>
cd projet
npm install
npm run build

Remarque : le script prepare exécute automatiquement le build avant publication (npm publish).

Usage (CLI)

Après compilation, la CLI s'exécute depuis dist/index.js :

# afficher l'aide
node dist/index.js help

# tâches
node dist/index.js tasks:list
node dist/index.js tasks:create "Ma nouvelle tâche"
node dist/index.js tasks:get 1
node dist/index.js tasks:update 1 "Titre modifié" true
node dist/index.js tasks:delete 1

# utilisateurs
node dist/index.js users:list
node dist/index.js users:create John Doe admin [email protected]
node dist/index.js users:get 1
node dist/index.js users:update 1 Jane Doe user [email protected]
node dist/index.js users:delete 1

Vous pouvez également utiliser :

npm start
# ou
node --enable-source-maps dist/index.js <action> [...args]

Fichiers de données

Les données sont stockées dans src/data/tasks.json et src/data/users.json. Lors du premier lancement, ces fichiers sont créés automatiquement si manquants.

Publication sur npm

Avant de publier :

• Vérifiez le champ name dans package.json. Il doit être unique sur npm. Si vous voulez publier sous un scope, utilisez @votre-username/projet.
• Mettez à jour author, repository, bugs et homepage dans package.json.

Publier :

npm login
npm publish --access public

Si vous publiez sous un scope et que vous souhaitez un package public, conservez --access public.

Contribution

Suggestions pour contributeurs :

• Ajouter des tests unitaires (Jest / vitest).
• Remplacer le parsing manuel des arguments par une bibliothèque dédiée (yargs, commander) pour gérer les flags et l'aide automatiquement.
• Ajouter des validations plus strictes et des messages localisés si besoin.

Avant de proposer une PR, exécutez :

npm install
npm run build

Débogage & erreurs

• Les erreurs de validation ou d'usage affichent un message clair et font échouer la commande (code de sortie 1).
• Si la compilation TypeScript échoue, exécutez npx tsc -v pour vérifier la version et npm run build pour voir les erreurs.

Licence

Ce projet est distribué sous la licence MIT. Voir le fichier LICENSE.

Contact

Mettez à jour le champ author et repository dans package.json pour indiquer le mainteneur principal. Si vous voulez, je peux automatiser la mise à jour avec vos informations (nom, email, repository URL).