Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(plugins) move code example related warning to the code blocks #2638

Merged
merged 2 commits into from Nov 12, 2018
Merged

docs(plugins) move code example related warning to the code blocks #2638

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4baeab0
docs(plugins) move code example related warning to the code blocks
EugeneHlushko Nov 12, 2018
57b4986
Merge branch 'master' into plugins/define-plugin-warning
EugeneHlushko Nov 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/content/plugins/define-plugin.md
View file
Open in desktop
Expand Up @@ -8,7 +8,8 @@ contributors:
- smonusbonus
---

The `DefinePlugin` allows you to create global constants which can be configured at __compile__ time. This can be useful for allowing different behavior between development builds and release builds. If you perform logging in your development build but not in the release build you might use a global constant to determine whether logging takes place. That's where `DefinePlugin` shines, set it and forget it rules for development and release builds.

The `DefinePlugin` allows you to create global constants which can be configured at __compile__ time. This can be useful for allowing different behavior between development builds and production builds. If you perform logging in your development build but not in the production build you might use a global constant to determine whether logging takes place. That's where `DefinePlugin` shines, set it and forget it rules for development and production builds.

``` javascript
new webpack.DefinePlugin({
Expand Down Expand Up @@ -44,6 +45,9 @@ console.log('Running App version ' + VERSION);
if(!BROWSER_SUPPORTS_HTML5) require('html5shiv');
```


W> When defining values for `process` prefer `'process.env.NODE_ENV': JSON.stringify('production')` over `process: { env: { NODE_ENV: JSON.stringify('production') } }`. Using the latter will overwrite the `process` object which can break compatibility with some modules that expect other values on the process object to be defined.

T> Note that because the plugin does a direct text replacement, the value given to it must include __actual quotes__ inside of the string itself. Typically, this is done either with alternate quotes, such as `'"production"'`, or by using `JSON.stringify('production')`.

__index.js__
Expand Down Expand Up @@ -87,8 +91,6 @@ new webpack.DefinePlugin({
});
```

W> When defining values for `process` prefer `'process.env.NODE_ENV': JSON.stringify('production')` over `process: { env: { NODE_ENV: JSON.stringify('production') } }`. Using the latter will overwrite the `process` object which can break compatibility with some modules that expect other values on the process object to be defined.


## Service URLs

Expand Down