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.