Skip to content

Travailler temporairement dans un module

Mathieu Schroeter edited this page Nov 17, 2022 · 3 revisions

Il arrive qu'il soit nécessaire de travailler temporairement sur un module ne faisant pas partie du bundle goblins. Ce cas peut se présenter quand des modifications doivent être apportées au framework et qu'il est donc justifié de ne pas ajouter ce module définitivement dans le bundle.

Pour ajouter un module, il faut utiliser la commande work depuis le bundle goblins. Celle-ci va ajouter le module dans le dossier lib/ puis mettre à jour l'installation dans node_modules. Il est ainsi immédiatement possible de travailler après l'exécution de la commande.

Commencer à bosser 🧑‍🏭 (commande work)

Voici quelques exemples :

npx goblins@latest work https://github.com/xyz/xyz.git
npx goblins@latest work [email protected]:xyz/xyz.git

Dans le cas de github, il est possible d'utiliser des raccourcis comme ceux-ci :

npx goblins@latest work github:xyz/xyz
npx goblins@latest work xcraft:goblin-xyz

Le cas github: fonctionne avec n'importe quel dépôt sur GitHub, le second cas xcraft: est utile pour travailler sur des modules du framework.

Finir le travail 🐦 (commande krow)

Une fois que vous avez terminé les modifications du module puis testé, pushé et publié celui-ci, il est important de quitter ce mode de travail.

Exemples :

npx goblins@latest krow xyz
npx goblins@latest krow goblin-xyz

Cette commande va enlever le module du dossier lib/, restaurer le fichier package-lock.json original et remettre à jour node_modules. Le fichier package-lock.json devrait alors contenir la nouvelle version du module sur lequel vous avez travaillé.