Modo standard di sviluppo di un modulo nodo usando Coffeescript?

Question

C'è un modo consigliato di sviluppare un modulo nodo se voglio scriverlo in Coffeescript, ma non voglio forzare gli utenti del modulo a richiedere il modulo coffee-script?

Answer 1

Inserire i codici CoffeeScript nella cartella src e i codici JavaScript compilati nella cartella lib.

Quindi nel file package.json, dichiarare main come il file js nella cartella lib. Quindi gli utenti del pacchetto richiederanno il file js invece del file caffè.

Si può prendere @ TrevorBurnham repository come un esempio.

Answer 2

Ho terminato con solo una cartella src nel mio repository git; un file .gitignore con una riga per lib; e un file vuoto .npmignore. Il file vuoto .npmignore è necessario perché se non si trova sul modulo, viene utilizzato il tuo .gitignore.

Ho appena aggiunto un Cakefile con un compito di costruire la mia directory src utilizzando coffee --compile --output lib/ src/ e un compito pretest e prepublish a package.json per costruire prima del test e la pubblicazione.

"scripts": { "pretest": "cake build", "prepublish": "cake build", }

Questa soluzione mantiene il mio repository git pulita (senza codice compilato), ma aggiunge il mio codice javascript per lib durante la pubblicazione di NPM.

Answer 3

sto appena iniziato con CoffeeScript, ma io suggerirei le seguenti:

1. Conservare il codice CoffeeScript in src/*.coffee,
2. Scrivi una main.js nella root del progetto che prenderà NPM, e fare semplicemente qualcosa come require('coffee-script'); require('./src/my_lib.coffee').

Lì. Non compili mai e poi mai il tuo codice; è tutto gestito in modo trasparente. Non si controlla il codice compilato in git, né si pubblica JavaScript compilato superfluo a fianco di CoffeeScript non compilato su NPM.

Edit: In più recenti versioni del caffè-scirpt, si dovrebbe require('coffee-script/register');