¿Forma estándar de desarrollar un módulo de nodo usando Coffeescript?

Question

¿Existe una forma recomendada de desarrollar un módulo de nodo si quiero escribirlo en Coffeescript, pero no quiero obligar a los usuarios del módulo a requerir el módulo coffee-script?

Answer 1

Coloque sus códigos CoffeeScript en la carpeta src y los códigos compilados de JavaScript en la carpeta lib.

Luego en su archivo package.json, declare main como el archivo js en la carpeta lib. Luego, los usuarios de su paquete necesitarán el archivo js en lugar del archivo de café.

Puede tomar @ TrevorBurnham's repository como ejemplo.

Answer 2

Terminé con solo una carpeta src en mi repositorio de git; un archivo .gitignore con una línea para lib; y un archivo .npmignore vacío. El archivo vacío .npmignore es necesario porque si no está en su módulo, se usa su .gitignore en su lugar.

acabo añadió un Cakefile con una tarea de construir mi directorio src usando coffee --compile --output lib/ src/ y una tarea pretest y prepublish a package.json construir antes de la prueba y la publicación.

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

Esta solución mantiene mi repositorio git limpia (sin código compilado), pero añade el código javascript para lib al publicar en la NGP.

Answer 3

me acaba de empezar con CoffeeScript, pero me gustaría sugerir lo siguiente:

1. tienda su código CoffeeScript en src/*.coffee,
2. Escribe un main.js en la raíz del proyecto que la NGP se pondrá al día, y simplemente haga algo como require('coffee-script'); require('./src/my_lib.coffee').

Allí. Usted nunca, nunca compila su código; todo se maneja de forma transparente. No comprueba código compilado en git, ni publica JavaScript compilado superfluo junto con CoffeeScript sin compilar para NPM.

Editar: En las versiones más recientes de café-scirpt, usted debe require('coffee-script/register');