jashkenas/coffeescript

Docs: Document best practice for creating a small NPM module

Open

#4.693 aberto em 9 de set. de 2017

Ver no GitHub
 (5 comments) (4 reactions) (0 assignees)CoffeeScript (1.980 forks)batch import
help wanted

Métricas do repositório

Stars
 (16.577 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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!

Guia do colaborador

Direção de pesquisa
Investigue estruturas modernas de módulos npm em CoffeeScript, compile padrões recomendados para layout de diretórios, ferramentas de build (Cakefile) e práticas de exportação de módulos, e proponha adições à documentação.
Pilha de tecnologia
None
Domain
documentationdeveloper experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
CoffeeScriptnpm
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75