rtfeldman/seamless-immutable

Please clarify the docs regarding when dev/prod modes are on (Node)

Open

#50 ouverte le 14 juil. 2015

Voir sur GitHub
 (10 commentaires) (0 réactions) (0 assignés)JavaScript (5 367 stars) (221 forks)batch import
enhancementhelp wanted

Description

Hello,

perhaps it wasn't my brightest day :-) but I found it difficult to find out when the dev or prod modes are active under Node.js. It would be great clarify that in the docs.

I believe this is true (and exhaustive) but am not sure:

/*1.*/ var Immutable = require('seamless-immutable'); // => dev mode
/*2.*/ var Immutable = require('seamless-immutable/seamless-immutable.production.min'); // => prod mode
/*3.*/ var Immutable = require('seamless-immutable/seamless-immutable.production.min'); process.env.NODE_ENV = "development"; // => dev mode

Thank you!

Guide contributeur

Stack technique
javascript
Domaine
documentation
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 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic Node.js knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
The issue requests clarification on how dev and prod modes are activated in Node.js when using seamless immutable. Check the current documentation, particularly the README and any usage guides in the repository. Look for references to `NODE ENV` and the different module entry points (e.g., `seamless immutable` vs `seamless immutable/seamless immutable.production.min`). The user provided three examples that need to be verified and documented. Ensure the final documentation explains the behavior clearly and exhaustively.