docs: expand description in readme #40

j-feng13 · 2017-03-07T05:26:56Z

Suggestions from @fakiolinho on explaining webpack.DefinePlugin being used under the hood
Updated usage examples including your template
Suggestions for a separate client .env file in order to prevent secrets from leaking into the client side bundle

coveralls · 2017-03-07T05:29:09Z

Coverage remained the same at 100.0% when pulling 9d098df on j-feng13:update-docs into f989f68 on mrsteele:master.

mrsteele

This is looking really awesome! just need a few changes and should be good to pull!

mrsteele · 2017-03-07T15:23:31Z

README.md

@@ -19,12 +19,31 @@ Include the package locally in your repository.

 `npm install dotenv-webpack --save`

+### Description
+
+`dotenv-webpack` wraps `dotenv` and `Webpack.DefinePlugin`. As such, it overwrites existing anyexisting `DefinePlugin` configurations. Also, like `DefinePlugin`, it does a text replace in the resulting bundle for any instances of `process.env`. 


Typo: anyexisting

mrsteele · 2017-03-07T15:32:15Z

README.md

+
+`dotenv-webpack` wraps `dotenv` and `Webpack.DefinePlugin`. As such, it overwrites existing anyexisting `DefinePlugin` configurations. Also, like `DefinePlugin`, it does a text replace in the resulting bundle for any instances of `process.env`. 
+
+As such, if used with `React` in production, make sure to include `NODE_ENV=production` inside your `.env` file.


While this is a common use-case, I don't think you would need to mention React explicitly.

Instead I would mention something as follows:

Any script files that get bundled with webpack and reference process.env would need to use this plugin to access the variables defined in the .env file.

@mrsteele I'm removing this text and adding an example

Use in your code

// file1.js console.log(process.env.DB_HOST); // '127.0.0.1'

Resulting bundle

// bundle.js console.log({ DB_HOST='127.0.0.1', DB_PASS='foobar', S3_API='mysecretkey' }.DB_HOST);

mrsteele · 2017-03-07T15:34:56Z

README.md

+`dotenv-webpack` wraps `dotenv` and `Webpack.DefinePlugin`. As such, it overwrites existing anyexisting `DefinePlugin` configurations. Also, like `DefinePlugin`, it does a text replace in the resulting bundle for any instances of `process.env`. 
+
+As such, if used with `React` in production, make sure to include `NODE_ENV=production` inside your `.env` file.
+If used with Node, this is not compatible with any calls to `process.env`.


Along with the comment above, I would say you can nix this comment as we are a webpack plugin and not exclusively a "node" plugin (though it runs in the node environment).

@mrsteele OK. I think adding an example of the resulting bundle should be clear enough.

mrsteele · 2017-03-07T15:35:20Z

README.md

+As such, if used with `React` in production, make sure to include `NODE_ENV=production` inside your `.env` file.
+If used with Node, this is not compatible with any calls to `process.env`.
+
+Also, be aware that all information in your `.env` file will be included in the resulting bundle. Please do not share any secret information in your client bundle. Instead, make a separate `.client.env` file.


mrsteele · 2017-03-07T15:40:25Z

README.md

@@ -33,14 +52,26 @@ module.exports = {
 ...
 plugins: [
 new Dotenv({
- path: './.my.env', // if not simply .env
+ path: './.env // Path to .env file. Use a separate file for client configuration


Make sure to close the path string.

j-feng13 · 2017-03-07T20:34:22Z

@mrsteele Thanks for the review. I'll get the changes in tonight.

j-feng13 · 2017-03-08T06:52:04Z

@mrsteele changes in. Let me know what you think.

coveralls · 2017-03-08T06:54:49Z

Coverage remained the same at 100.0% when pulling e4cae8e on j-feng13:update-docs into f989f68 on mrsteele:master.

mrsteele · 2017-03-08T14:00:36Z

README.md

+
+`dotenv-webpack` wraps `dotenv` and `Webpack.DefinePlugin`. As such, it overwrites existing any existing `DefinePlugin` configurations. Also, like `DefinePlugin`, it does a text replace in the resulting bundle for any instances of `process.env`.
+
+Also, be aware that all information in your `.env` file will be included in the resulting bundle. Please do not share any secret information in your client bundle. Instead, make a separate `.client.env` file.


This can be removed due to #42 so you can remove this paragraph. If you would rather we can simply state:

Your `.env` files can include sensative information. Because of this,`dotenv-webpack` will only include defined environment variables in the final bundle.

mrsteele · 2017-03-08T14:03:55Z

README.md

 ### Usage

-The plugin can be installed with little-to-no configuration needed. Once installed, you can access the variables as expected within your code using `process.env`.
+The plugin can be installed with little-to-no configuration needed. Once installed, you can access the variables within your code using `process.env` as you would with `dotenv`.

 The example bellow shows the defaults, as well as a description of each parameter.


We should update the "defaults" statement as it isn't quite right.

mrsteele · 2017-03-08T14:04:26Z

README.md

+###### Resulting bundle
+```
+// bundle.js
+console.log({


This will update to the new approach (see #42)

mrsteele · 2017-03-08T14:05:10Z

I'll merge this and make the final changes myself. Thank you so much for doing this @j-feng13!

coveralls · 2017-03-08T14:08:04Z

Coverage remained the same at 100.0% when pulling 4bf7274 on j-feng13:update-docs into eeb6a98 on mrsteele:master.

coveralls · 2017-03-08T14:08:04Z

Coverage remained the same at 100.0% when pulling 4bf7274 on j-feng13:update-docs into eeb6a98 on mrsteele:master.

coveralls · 2017-03-08T14:08:04Z

Coverage remained the same at 100.0% when pulling 4bf7274 on j-feng13:update-docs into eeb6a98 on mrsteele:master.

coveralls · 2017-03-08T14:08:04Z

Coverage remained the same at 100.0% when pulling 4bf7274 on j-feng13:update-docs into eeb6a98 on mrsteele:master.

docs: expand description in readme

9d098df

mrsteele requested changes Mar 7, 2017

View reviewed changes

Jonathan added 3 commits March 7, 2017 18:50

docs: remove libary / environment specifics

38a8159

docs: lint. missing single quote

8db828d

docs: add another example block

e4cae8e

mrsteele requested changes Mar 8, 2017

View reviewed changes

Merge branch 'master' into update-docs

4bf7274

mrsteele approved these changes Mar 8, 2017

View reviewed changes

mrsteele merged commit 63a1343 into mrsteele:master Mar 8, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: expand description in readme #40

docs: expand description in readme #40

j-feng13 commented Mar 7, 2017

coveralls commented Mar 7, 2017 •

edited

Loading

mrsteele left a comment

mrsteele Mar 7, 2017

mrsteele Mar 7, 2017

j-feng13 Mar 8, 2017

mrsteele Mar 7, 2017

j-feng13 Mar 8, 2017

mrsteele Mar 7, 2017

mrsteele Mar 7, 2017

j-feng13 commented Mar 7, 2017

j-feng13 commented Mar 8, 2017

coveralls commented Mar 8, 2017 •

edited

Loading

mrsteele Mar 8, 2017

mrsteele Mar 8, 2017

mrsteele Mar 8, 2017

mrsteele commented Mar 8, 2017

coveralls commented Mar 8, 2017

coveralls commented Mar 8, 2017

coveralls commented Mar 8, 2017

coveralls commented Mar 8, 2017 •

edited

Loading


		`dotenv-webpack` wraps `dotenv` and `Webpack.DefinePlugin`. As such, it overwrites existing anyexisting `DefinePlugin` configurations. Also, like `DefinePlugin`, it does a text replace in the resulting bundle for any instances of `process.env`.

		As such, if used with `React` in production, make sure to include `NODE_ENV=production` inside your `.env` file.


		`dotenv-webpack` wraps `dotenv` and `Webpack.DefinePlugin`. As such, it overwrites existing any existing `DefinePlugin` configurations. Also, like `DefinePlugin`, it does a text replace in the resulting bundle for any instances of `process.env`.

		Also, be aware that all information in your `.env` file will be included in the resulting bundle. Please do not share any secret information in your client bundle. Instead, make a separate `.client.env` file.

docs: expand description in readme #40

docs: expand description in readme #40

Conversation

j-feng13 commented Mar 7, 2017

coveralls commented Mar 7, 2017 • edited Loading

mrsteele left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Use in your code

Resulting bundle

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

j-feng13 commented Mar 7, 2017

j-feng13 commented Mar 8, 2017

coveralls commented Mar 8, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrsteele commented Mar 8, 2017

coveralls commented Mar 8, 2017

coveralls commented Mar 8, 2017

coveralls commented Mar 8, 2017

coveralls commented Mar 8, 2017 • edited Loading

coveralls commented Mar 7, 2017 •

edited

Loading

coveralls commented Mar 8, 2017 •

edited

Loading

coveralls commented Mar 8, 2017 •

edited

Loading