jashkenas/coffeescript

Docs: Document best practice for creating a small NPM module

Open

#4.693 geöffnet am 9. Sept. 2017

Auf GitHub ansehen
 (5 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)CoffeeScript (1.980 Forks)batch import
help wanted

Repository-Metriken

Stars
 (16.577 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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!

Contributor Guide

Research-Richtung
Untersuche moderne CoffeeScript npm Modulstrukturen, erstelle empfohlene Muster für das Verzeichnislayout, Build Tools (Cakefile) und Modul Export Praktiken und schlage dann Dokumentationserweiterungen vor.
Tech Stack
Keine
Domain
documentationdeveloper experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
CoffeeScriptnpm
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75