Kann ich ein npm-Paket in CoffeeScript schreiben?

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

Ich werde vorschlagen, dass Sie Ihr Paket in Coffeescript schreiben, es aber nur in Javascript veröffentlichen. So mach ich es:

• Coffeescript-Code geht rein src
• Code wird zu kompiliert lib
• srcist meinem git repo verpflichtet, libist in meinem.gitignore
• lib wird bis npm veröffentlicht, src ist in meinem.npmignore
• Das coffee-scriptPaket ist in meinemdevDependencies

Sie können sich ein einfaches Paket von mir ansehen , refix , um sich inspirieren zu lassen:

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

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

package.jsonmacht dies einfach mit ihrem prepublishSkript-Hook, der das angegebene Skript ausführt, bevor Sie veröffentlichen. Hier ist ein Beispiel für eineprepublish NPM-Hook in zombie.js

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

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

Coffee-Build ist ein globaler Versionsmanager fürcoffee-script .

Fügen Sie einfach diese 2 Skripte zu Ihrem hinzu package.json:

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

Beachten Sie, dass -v 1.11.xes sich nicht um eine exakte Version handelt, die implizite Upgrades ermöglicht.

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

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 Ihr Modul jedoch 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.

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 den coffeeBefehl einfach wie folgt umschließt :

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

Das Ausführen node howl.js(oder einfach, howlwenn es global installiert ist) wird jetzt ausgegeben Awwooooo!. Sie können Dinge wie tunrequire andere CoffeeScript-Dateien und auf Argumente zugreifen, indem Sie sie vom JavaScript- "Wrapper" an das CoffeeScript übergeben.

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

Ein einfaches Beispielprojekt mit dieser Technik finden Sie unter https://www.github.com/joshuabc/packdown .