jashkenas/coffeescript

Docs: Document best practice for creating a small NPM module

Open

#4,693 建立於 2017年9月9日

在 GitHub 查看
 (5 留言) (4 反應) (0 負責人)CoffeeScript (16,577 star) (1,980 fork)batch import
help wanted

描述

When creating a small npm package for something like strscan, what is the modern/CS2/best-practices way to structure the repo? I'm looking for something that has a small Cakefile and src, lib, and tests directories (if those are recommended).

For example, Sam Stephenson's CoffeeScript based strscan package from 2010 looks like this:

Yet, we're 7 years later with many updates to Node, NPM, and now CoffeeScript. Would someone be able to provide a modern best-practices repo for building a simple package that could be included from other CoffeeScript or JS code simply using require 'some-package'?

If so, it might be nice to have a small reference to this in the official documentation.

Thanks!

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
CoffeeScriptnpmNode.js
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
This issue requests a documentation best practice guide for creating a small CoffeeScript npm module. Look at the official CoffeeScript documentation structure (e.g., /docs) and existing examples like strscan js. Consider updating to modern Node and npm practices, and ensure the guide covers directory layout, Cakefile, and module export patterns. Since the issue is stale, engage maintainers to assess current relevance and preferred approach.
Docs: Document best practice for creating a small NPM module · jashkenas/coffeescript#4693 | Good First Issue