jashkenas/coffeescript

Docs: Document best practice for creating a small NPM module

Open

#4693 aperta il 9 set 2017

Vedi su GitHub
 (5 commenti) (4 reazioni) (0 assegnatari)CoffeeScript (1980 fork)batch import
help wanted

Metriche repository

Star
 (16.577 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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!

Guida contributor

Direzione di ricerca
Analizza le moderne strutture dei moduli npm in CoffeeScript, raccogli modelli consigliati per la disposizione delle directory, gli strumenti di build (Cakefile) e le pratiche di esportazione dei moduli, quindi proponi aggiunte alla documentazione.
Tech stack
Nessuno
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
CoffeeScriptnpm
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75