rtfeldman/seamless-immutable

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

Open

#50 opened on Jul 14, 2015

View on GitHub
 (10 comments) (0 reactions) (0 assignees)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!

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Node.js knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.