Cách tiêu chuẩn để phát triển mô đun nút bằng Coffeescript?

Question

Có cách nào đề xuất phát triển một mô-đun nút nếu tôi muốn viết nó trong Coffeescript, nhưng không muốn buộc người dùng của mô-đun yêu cầu mô-đun coffee-script?

Answer 1

Đặt mã CoffeeScript của bạn trong thư mục src và mã JavaScript được biên dịch trong thư mục lib.

Sau đó, trong tệp package.json, hãy khai báo main làm tệp js trong thư mục lib. Sau đó, người dùng gói của bạn sẽ yêu cầu tệp js thay vì tệp cà phê.

Bạn có thể lấy @ TrevorBurnham's repository làm ví dụ.

Answer 2

Tôi đã kết thúc bằng chỉ một thư mục src trên kho lưu trữ git của mình; tệp .gitignore có một dòng cho lib; và tệp rỗng .npmignore. Cần có tệp .npmignore trống vì nếu không có trên mô-đun của bạn, thay vào đó, .gitignore của bạn được sử dụng.

Tôi chỉ cần thêm một Cakefile với một nhiệm vụ để xây dựng thư mục src tôi sử dụng coffee --compile --output lib/ src/ và pretest và prepublish nhiệm vụ để package.json để xây dựng trước khi thử nghiệm và xuất bản.

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

Giải pháp này giữ kho git của tôi sạch (không có mã biên dịch), nhưng thêm mã javascript của tôi để lib khi xuất bản vào NPM.

Answer 3

Tôi chỉ bắt đầu với CoffeeScript, nhưng tôi muốn đề nghị như sau:

1. Mã cửa hàng CoffeeScript của bạn trong src/*.coffee,
2. Viết main.js trong thư mục gốc của dự án mà NPM sẽ nắm bắt, và có nó chỉ đơn giản là làm một cái gì đó như require('coffee-script'); require('./src/my_lib.coffee').

Ở đó. Bạn không bao giờ, bao giờ biên dịch mã của bạn; tất cả được xử lý một cách minh bạch. Bạn không kiểm tra mã được biên dịch thành git, cũng như bạn không xuất bản JavaScript được biên dịch thừa cùng với CoffeeScript chưa được biên dịch sang NPM.

Edit: Trong nhiều phiên bản gần đây cà phê scirpt, bạn nên require('coffee-script/register');