Như bạn có thể thấy, NPM không thực sự chỉ ra cụ thể những gì nên đi vào đó, thay vào đó họ có một danh sách các tệp bị bỏ qua theo mặc định . Nhiều người thậm chí không sử dụng nó vì mọi thứ trong của bạn .gitignorebị bỏ qua npmtheo mặc định nếu.npmignore không tồn tại. Ngoài ra, nhiều tệp đã bị bỏ qua theo mặc định bất kể cài đặt nào và một số tệp luôn bị loại trừ khỏi việc bị bỏ qua, như được nêu trong liên kết ở trên.
Không có nhiều thông tin chính thức về những gì luôn nên có vì về cơ bản nó là một tập hợp con của .gitignore, nhưng từ những gì tôi thu thập được từ việc sử dụng nút trong 5 năm, đây là những gì tôi đã đưa ra.
Lưu ý: Theo sản xuất, tôi có nghĩa là bất kỳ lúc nào mà mô-đun của bạn được ai đó sử dụng và không phát triển trên chính mô-đun đó.
Các nguồn được biên dịch chéo trước khi phát hành
- Ưu điểm : Nếu bạn đang sử dụng ngôn ngữ biên dịch chéo thành JavaScript, bạn có thể biên dịch trước trước khi phát hành và không bao gồm
.coffeecác tệp trong gói của mình nhưng tiếp tục theo dõi chúng trong kho lưu trữ git của bạn.
Tạo tập tin thừa
- Ưu điểm : Những người sử dụng những thứ như
node-gypcó thể có các tệp đối tượng được tạo trong quá trình xây dựng mà không bao giờ nên đi vào gói.
- Nhược điểm :
.gitignoreDù sao thì điều này cũng nên đi vào . Bạn phải đặt những thứ này bên trong đây nếu bạn đang sử dụng một .npmignoretệp vì nó ghi đè .gitignoretheo quan điểm của npm.
Kiểm tra
- Ưu điểm : Ít hành lý hơn trong mã sản xuất của bạn.
- Nhược điểm : Bạn không thể chạy thử nghiệm trên môi trường trực tiếp trong trường hợp rất hiếm có lỗi cụ thể của hệ thống, chẳng hạn như phiên bản lỗi thời của nút đang chạy khiến thử nghiệm không thành công.
Cài đặt tích hợp liên tục / tệp meta
- Ưu điểm : Một lần nữa, ít hành lý hơn. Những thứ như
.travis.ymlkhông bắt buộc để sử dụng, thử nghiệm hoặc xem mã.
Ví dụ về mã và tài liệu không phải readme
- Ưu điểm : Hành lý ít hơn. Một số người tồn tại trong trường phái suy nghĩ mà nếu bạn không thể thể hiện ít nhất chức năng khả thi tối thiểu trong Readme của mình, thì mô-đun của bạn quá lớn.
- Nhược điểm : Mọi người không thể xem tài liệu đầy đủ và các ví dụ mã trên hệ thống tệp của riêng họ. Họ sẽ phải truy cập vào kho lưu trữ (cũng yêu cầu kết nối internet).
Đối tượng trang Github
- Ưu điểm : Bạn chắc chắn không cần phải xả các bản phát hành của mình với
CNAMEcác tệp hoặc trình giữ chỗ index.htmlnếu bạn sử dụng mô-đun của mình cũng phục vụ hai nhiệm vụ như một gh-pageskho lưu trữ.
bower.json và những người bạn
- Ưu điểm : Nếu bạn quyết định xây dựng trong các phụ thuộc của mình trước khi phát hành, bạn không cần người dùng cuối cài đặt bower sau đó cài đặt nhiều thứ hơn với nó. Cá nhân tôi sẽ giữ những thứ đó trong gói. Khi tôi thực hiện
npm install, tôi chỉ nên dựa vào npm và không có nguồn bên ngoài nào khác.
Về cơ bản, bạn nên sử dụng nó nếu có thứ gì đó bạn muốn giữ ngoài gói npm của mình nhưng không nằm ngoài kho lưu trữ npm của bạn. Đó không phải là một danh sách dài các mục, nhưng npm thà xây dựng trong chức năng hơn là để mọi người mắc kẹt với các đối tượng không liên quan trong gói của họ.
npm install yourlibrary, ví dụ.travis.ymlvà.jshintrc