Czy mogę napisać pakiet npm w coffeescript?

Question

Przez jakiś czas używałem coffeescript. Teraz muszę napisać pakiet npm, czy mogę napisać go w coffeescript, czy też powinienem skompilować coffeescript do javascript?

Answer 1

Proponuję napisać paczkę w coffeescript, ale tylko opublikować ją w javascript. Robię to tak:

• Kod coffeescript idzie w src
• kod jest kompilowany do lib
• src zobowiązuje się do mojego git repo, lib jest w moim .gitignore
• lib jest publikowany do KMP, src jest w moim .npmignore
• pakiet coffee-script jest w moim devDependencies

Można spojrzeć na prosty pakiet kopalni refix, inspiracji:

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

Answer 2

Napisałem pakiety npm w CoffeeScript od zera. Zachęcam do korzystania z CoffeScript dla węzła, a także dla przeglądarki. Zanim jednak będziesz mógł użyć lub opublikować swój moduł, musisz skompilować kod źródłowy CoffeeScript do JavaScript. To jednak nie powinno powstrzymywać cię przed używaniem CoffeeScript.

Wskazówka: Podczas tworzenia należy użyć coffee -cw yourfile.coffee (wiersza poleceń), aby obejrzeć plik zmian i skompilować przy zapisie.

Answer 3

Można pisać moduły KMP w coffeescript, ale w porządku aby mogły być używane przez użytkowników JS, muszą być skompilowane do JS przed opublikowaniem na NPM.

package.json ułatwia to ze skryptem prepublish, który uruchamia określony skrypt przed opublikowaniem. Herezje przykład hak prepublish NPM w zombie.js

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

Answer 4

Chociaż nie jestem pewien, czy jest to najlepsze podejście, technicznie jest możliwe napisanie pakiet głównie w coffeescript.

Zasadniczo, można zapisać plik JS, które po prostu otacza komendy coffee, tak:

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

Uruchamianie node howl.js (lub po prostu howl, gdy jest zainstalowany globalnie) będzie teraz wyświetlać Awwooooo!.Możesz zrobić takie rzeczy jak require inne pliki CoffeeScript i argumenty dostępu, przekazując je z "opakowania" JavaScript do CoffeeScript.

W każdym razie, nie mogą być powody, aby tego nie robić, ale on pracował dla mnie tak daleko, więc pomyślałam, że mogę przedstawić to za dodatkową perspektywę.

Na prostym przykładzie projektu przy użyciu tej techniki, sprawdź https://www.github.com/joshuabc/packdown.

Answer 5

Jeśli dużo modułach mają coffee-script w ich devDependencies, jest przydatna tylko globalnie zainstalować coffee-script zamiast zainstalować go dla każdego modułu (co trwa znacznie dłużej).

coffee-build jest globalnym menedżerem wersji dla coffee-script.

Wystarczy dodać te 2 skrypty do swojej package.json:

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

Wskazówki jak -v 1.11.x nie jest dokładną wersję, która pozwala ukryte aktualizacje.

Jedynym minusem jest to, że użytkownicy muszą npm install -g coffee-build zanim można zainstalować moduł.