[addon][npm] 'binding.gyp', 'package.json'… et bonnes pratiques
Bonsoir !
Nouveau venu sur ce forum, j'espère que ce message y a sa place.
Je me suis lancé dans le développement de modules pour Node.js. Histoire de me faire la main, j'ai développé un parseur XML, qui, malgré quelques limitations, est fonctionnel, bien qu'incomplet, notamment en ce qui concerne la gestion d'erreurs.
Comme Node.js et npm semblent intimement liés, j'ai, tant bien que mal, crée un 'package' que j'ai publié sur 'npmjs.org' (http://www.npmjs.org/package/xppq/), et qui, après moult tentatives, semble enfin s'installer correctement.
Pour parvenir à mes fins, autant pour l'écriture du module que pour sa publication, j'ai dû procéder par tâtonnement, en m'inspirant des exemples trouvés ci et là sur le web.
Un de mes plus gros souci a été le contenu du fichier 'binding.gyp', car je n'ai pas trouvé de document qui soit suffisamment exhaustif quand au contenu de ce fichier. Sans compter que, pour la spécification de certaines options, par exemple l'activation des exceptions dans Microsoft Visual Studio, il semblerait qu'il y ai plusieurs façons de faire, et j'aurais bien aimé savoir laquelle est la bonne !
Concernant la publication sur 'npmjs', ça a été un peu plus simple, mais j'ai quand même quelques interrogations concernant le fichier 'package.json'.
Déjà, lors de la simple installation d'un 'package', 'npm' se plaint si le fichier 'package.json' n'est pas présent dans le répertoire courant ou s'il est incomplet. Autant je comprend son importance pour la publication d'un 'package', autant le rôle de ce fichier lors de la simple installation d'un 'package' m'échappe totalement !
Toujours concernant le fichier 'package.json', j'ai crée une entrée 'test' dans la section 'scripts'. Je pensais naïvement que la commande indiquée dans cette entrée serait lancée lors d'un 'npm install-test xppq', ou par un 'npm test xppq' après installation du 'package' en question. Que nenni ! Il faut se placer dans 'node-modules/xppq' et là, on peut lancer 'npm test' pour exécuter la commande attendue. Or, il me semblait que l'utilisateur n'avait pas à se préoccuper du répertoire 'node_modules', et donc, n'est, à priori, pas censé effectuer ce genre de manœuvre. Soit il y a quelque chose qui m'échappe, soit cette entrée 'test' dans le section 'scripts' d'un 'package.json' me semble bien inutile...
De manière globale, je cherche de le documentation sur les bonnes pratiques concernant l'écriture et la publication de 'package' Node.js, c'est-à-dire sur comment faciliter au maximum la mise en œuvre d'un 'package' par un développeur Node.js, documentation que je n'ai trouvé, ni sur les sites officiels, ni sur les différents sites web sur lesquels j'ai échoué suite à mes différentes recherches...
D'avance, merci !
Répondre avec citation
Partager