Est-ce que je peux écrire un package npm en CoffeeScript ?

Question

J'ai utilisé CoffeeScript pendant un certain temps. Maintenant, j'ai besoin d'écrire un package npm, puis-je l'écrire en CoffeeScript, ou dois-je compiler CoffeeScript en JavaScript ?

Answer 1

Je vais suggérer que vous écriviez votre package en coffeescript, mais que vous le publiiez uniquement en javascript. Voici comment je procède :

• Le code coffeescript va dans src
• Le code est compilé dans lib
• src est commité dans mon repo git, lib est dans mon .gitignore
• lib est publié sur npm, src est dans mon .npmignore
• Le package coffee-script est dans mes devDependencies

Vous pouvez consulter un de mes packages simples, refix, pour inspiration :

• https://github.com/linus/refix
• npm install refix

Answer 2

Vous pouvez écrire des modules NPM en coffeescript, mais pour qu'ils soient utilisables par les utilisateurs JS, ils doivent être compilés en JS avant d'être publiés sur NPM.

package.json facilite ceci avec leur crochet de script prepublish qui exécute le script spécifié avant la publication. Voici un exemple d'un crochet NPM prepublish dans zombie.js

https://github.com/assaf/zombie/blob/master/package.json#L16

Answer 3

Si beaucoup de vos modules ont coffee-script dans leurs devDependencies, il est utile d'installer coffee-script globalement au lieu de l'installer pour chaque module (ce qui prend beaucoup plus de temps).

coffee-build est un gestionnaire de versions global pour coffee-script.

Ajoutez simplement ces 2 scripts à votre package.json:

{
  "name": "my-coffee-module",
  "scripts": {
    "build": "coffee-build -v 1.11.x -b -o js src",
    "postinstall": "npm run build"
  }
}

Remarquez comment -v 1.11.x n'est pas une version exacte, ce qui permet des mises à jour implicites.

Le seul inconvénient est que les utilisateurs doivent exécuter npm install -g coffee-build avant de pouvoir installer votre module.

Answer 4

J'ai écrit des packages npm en CoffeeScript à partir de zéro. Je vous encourage à utiliser CoffeScript pour node ainsi que pour le navigateur. Cependant, avant de pouvoir utiliser ou publier votre module, vous devez compiler le code source CoffeeScript en JavaScript. Cela ne devrait cependant pas vous empêcher d'utiliser CoffeeScript.

Astuce : Pendant le développement, utilisez coffee -cw votrefichier.coffee (en ligne de commande) pour surveiller le fichier et le compiler à chaque sauvegarde.

Answer 5

Alors que je ne suis pas sûr que ce soit la meilleure approche, techniquement c'est possible d'écrire votre package principalement en CoffeeScript.

En gros, vous pouvez écrire un fichier JS qui enveloppe simplement la commande coffee, comme ceci :

bin/howl.coffee

console.log 'Awwwooooo!'

bin/howl.js

#!/usr/bin/env node

var path    = require('path');
var exec    = require('child_process').exec;
var coffee  = path.resolve(__dirname, '../node_modules/coffee-script/bin/coffee');
var howl    = path.resolve(__dirname, './howl.coffee');
var command = coffee + ' ' + howl;

exec(command, function(error, stdout) {
  if (error) { throw error };
  console.log(stdout);
});

En exécutant node howl.js (ou simplement howl quand il est installé globalement) vous obtiendrez désormais Awwooooo!. Vous pouvez faire des choses comme require d'autres fichiers CoffeeScript et accéder aux arguments en les passant du "wrapper" JavaScript au CoffeeScript.

De toute manière, il peut y avoir des raisons de ne pas le faire, mais ça a fonctionné pour moi jusqu'à présent alors j'ai pensé soumettre cela pour une perspective supplémentaire.

Pour un exemple de projet simple utilisant cette technique, consultez https://www.github.com/joshuabc/packdown.