jashkenas/coffeescript

Docs: Document best practice for creating a small NPM module

Open

#4 693 ouverte le 9 sept. 2017

Voir sur GitHub
 (5 commentaires) (4 réactions) (0 assignés)CoffeeScript (1 980 forks)batch import
help wanted

Métriques du dépôt

Stars
 (16 577 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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!

Guide contributeur

Direction de recherche
Examinez les structures modernes de modules npm CoffeeScript, compilez les modèles recommandés pour la disposition des répertoires, les outils de construction (Cakefile) et les pratiques d'exportation de modules, puis proposez des ajouts à la documentation.
Stack technique
Aucun
Domaine
documentationdeveloper experience
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
CoffeeScriptnpm
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75