Kann ich in Coffeescript ein npm-Paket schreiben?

Question

Ich habe coffeescript für eine Weile verwendet. Jetzt muss ich ein npm-Paket schreiben, kann ich es in coffeescript schreiben, oder ich sollte coffeescript in Javascript kompilieren?

Answer 1

Ich werde vorschlagen, dass Sie Ihr Paket in coffeescript schreiben, aber nur in Javascript veröffentlichen. Ich mache es wie folgt aus:

• Coffeescript-Code geht in src
• Code lib
• src kompiliert ist meinem git Repo verpflichtet, lib ist in meinem .gitignore
• lib auf npm veröffentlicht, src ist in meinem .npmignore
• das coffee-script Paket ist in meinem devDependencies

Sie können an einem einfachen Paket von mir einen Blick darauf werfen, refix, für Inspiration:

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

Answer 2

Ich habe npm-Pakete in CoffeeScript von Grund auf neu geschrieben. Ich empfehle Ihnen, CoffeScript sowohl für den Knoten als auch für den Browser zu verwenden. Bevor Sie jedoch Ihr Modul verwenden oder veröffentlichen können, müssen Sie das Quell-CoffeeScript in JavaScript kompilieren. Das sollte Sie jedoch nicht davon abhalten, CoffeeScript zu verwenden.

Tipp: Verwenden Sie während der Entwicklung coffee -cw yourfile.coffee (Befehlszeile), um die Datei auf Änderungen zu überwachen und beim Speichern zu kompilieren.

Answer 3

Sie können in Coffeescript NPM Module schreiben, aber in Ordnung Damit sie von JS-Benutzern verwendet werden können, müssen sie vor der Veröffentlichung auf NPM in JS kompiliert werden.

package.json macht dies einfach mit ihrem prepublish Skript-Hook, der das angegebene Skript vor der Veröffentlichung ausführt. Heres ein Beispiel eines Hakens prepublish NPM in zombie.js

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

Answer 4

Während ich bin nicht sicher, ob es der beste Ansatz ist, technisch es ist möglich Ihr Paket meist in Coffeescript zu schreiben.

Grundsätzlich können Sie eine JS-Datei schreiben, die einfach hüllt den coffee Befehl, etwa so:

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); 
}); 

Lauf node howl.js (oder einfach howl, wenn es global installiert ist) wird nun Awwooooo! ausgeben.Sie können Dinge wie require andere CoffeeScript-Dateien und Zugriffsargumente tun, indem Sie sie vom JavaScript-Wrapper an das CoffeeScript übergeben.

Wie auch immer, es kann Gründe geben, dies nicht zu tun, aber es hat für mich bisher funktioniert, also dachte ich, ich würde dies für eine zusätzliche Perspektive einreichen.

Für ein einfaches Beispielprojekt, das diese Technik verwendet, überprüfen Sie https://www.github.com/joshuabc/packdown.

Answer 5

Wenn viele Ihrer Module haben coffee-script in ihren devDependencies, dann ist es coffee-script nur global sinnvoll zu installieren, anstatt es installieren für jedes Modul (die viel länger dauert).

coffee-build ist ein globaler Versionsmanager für coffee-script.

einfach diese 2-Skripte zu Ihrem package.json hinzufügen:

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

Beachten Sie, wie -v 1.11.x keine exakte Version ist, die implizite Upgrades ermöglicht.

Der einzige Nachteil ist, dass Benutzer müssen npm install -g coffee-build, bevor sie Ihr Modul installieren können.