docs(plugins): add hashed-module-ids-plugin.md and named-modules-plugin.md #1392

shaodahong · 2017-07-07T14:24:43Z

add hashed-module-ids-plugin.md page #1384
and fix commons-chunk-plugin.md description

Resolves #1384

…tent

fix Config did not export an object #1414

shaodahong

#1414

skipjack

Thanks @shaodahong for documenting these plugins! Please see my minor requests.

skipjack · 2017-07-12T03:52:52Z

content/plugins/hashed-module-ids-plugin.md

+  - shaodahong
+---
+
+Will be based on the relative path of the module to generate a string of length 4 as the module id. Suggest for use in production.


Probably better phrased as:

This plugin will cause hashes to be based on the relative path of the module, generating a four character string as the module id. Suggested for use in production.

skipjack · 2017-07-12T03:55:13Z

content/plugins/named-modules-plugin.md

+  - shaodahong
+---
+
+The relative path of the module is displayed when [HMR](../guides/hot-module-replacement). Suggest for use in development.


Probably better phrased as:

This plugin will cause the relative path of the module is to be displayed when [HMR](/guides/hot-module-replacement) is enabled. Suggested for use in development.

skipjack · 2017-07-12T03:57:35Z

webpack.config.js

@@ -159,4 +160,4 @@ module.exports = function(env) {
        buildConfig
      );
  }
-};
+} : {};


Why are any changes required in this file? If anything I would recommend pushing these to a separate PR that describes why they're needed. I have a feeling this may have to do with the issue you created #1414, so we could discuss there as well.

shaodahong · 2017-07-12T04:24:44Z

@skipjack I have changed

simon04 · 2017-07-13T08:40:56Z

content/guides/caching.md

-To generate identifiers that are preserved over builds, webpack supplies the `NamedModulesPlugin` (recommended for development) and `HashedModuleIdsPlugin` (recommended for production).
-
-?> When exist, link to `NamedModulesPlugin` and `HashedModuleIdsPlugin` docs pages
+To generate identifiers that are preserved over builds, webpack supplies the [`NamedModulesPlugin`](../plugins/named-modules-plugin) (recommended for development) and [`HashedModuleIdsPlugin`](../plugins/hashed-module-ids-plugin) (recommended for production).


Please use absolute URLs such as /plugins/named-modules-plugin

simon04 · 2017-07-13T08:42:46Z

content/plugins/commons-chunk-plugin.md

@@ -111,7 +111,7 @@ new webpack.optimize.CommonsChunkPlugin({
 <script src="app.js" charset="utf-8"></script>
 ```

-Hint: In combination with long term caching you may need to use the [`ChunkManifestWebpackPlugin`](https://github.com/diurnalist/chunk-manifest-webpack-plugin) to avoid that the vendor chunk changes. You should also use records to ensure stable module ids.
+Hint: In combination with long term caching you may need to use the [`ChunkManifestWebpackPlugin`](https://github.com/diurnalist/chunk-manifest-webpack-plugin) to avoid that the vendor chunk changes. You should also use records to ensure stable module ids. ( e.g. using [`NamedModulesPlugin`](./named-modules-plugin) or [`HashedModuleIdsPlugin`](./hashed-module-ids-plugin) ).


You should also use records to ensure stable module ids. ( e.g. using [`NamedModulesPlugin`](./named-modules-plugin) or [`HashedModuleIdsPlugin`](./hashed-module-ids-plugin) ). → You should also use records to ensure stable module ids, e.g., using [`NamedModulesPlugin`](./named-modules-plugin) or [`HashedModuleIdsPlugin`](./hashed-module-ids-plugin).

Please use absolute URLs also here.

simon04 · 2017-07-13T08:43:29Z

content/plugins/named-modules-plugin.md

+  - shaodahong
+---
+
+This plugin will cause the relative path of the module is to be displayed when [HMR](/guides/hot-module-replacement) is enabled. Suggested for use in development.


Typo in "module is"?

No, what do you think?

"is" vs "ids"? "will cause the relative path of the module is to be displayed" does not seem to be correct.

I mean "will cause the relative path of the module to be displayed"

Ah so I think you want to drop the "is".

... relative path of the module is to be displayed ...

to

... relative path of the module to be displayed ...

Yes, this is not a typo

Typo like in /typ/ing tree characters to/o/ much 😉

simon04 · 2017-07-13T08:48:24Z

content/plugins/hashed-module-ids-plugin.md

+This plugin will cause hashes to be based on the relative path of the module, generating a four character string as the module id. Suggested for use in production.
+
+``` js
+new webpack.HashedModuleIdsPlugin()


Please also document the available options: https://github.com/webpack/webpack/blob/master/lib/HashedModuleIdsPlugin.js#L9-L15

Some options are already documented here: https://webpack.js.org/configuration/output/#output-hashdigest

…ugin

skipjack · 2017-07-14T03:45:00Z

@shaodahong thanks for making those updates and adding these pages! I did add one last commit to fix some grammar and formatting, so you may want to take a look at that -- but this should be good to ship .

The build errors were just in relation to the edit links which is expected for new or renamed pages -- I'm going to let the build go through once more just in case and then I'll merge.

shaodahong · 2017-07-14T03:51:13Z

@skipjack Thanks for helping me correct some grammar, some details are important, you are right

shaodahong added 2 commits July 7, 2017 17:42

fix commons-chunk-plugin.md term

cfec07f

add Hashed-module-ids-plugin.md

bf60eec

skipjack added the Plugins label Jul 8, 2017

skipjack and others added 2 commits July 9, 2017 09:28

Merge branch 'master' into master

7982f67

add named-modules-plugin.md and fix hashed-module-ids-plugin.md content

6aa22b7

shaodahong mentioned this pull request Jul 11, 2017

Plugins - Add HashedModuleIdsPlugin and NamedModulesPlugin #1384

Closed

Fix the link with HashedModuleIdsPlugin and NamedModulesPlugin in con…

c1094e3

…tent

shaodahong changed the title ~~add hashed-module-ids-plugin.md page~~ Plugins: Add hashed-module-ids-plugin.md and named-modules-plugin.md Jul 11, 2017

shaodahong added 3 commits July 12, 2017 09:57

fix Config did not export an object

060b2ea

fix Config did not export an object

47f1bed

fix Config did not export an object #1414

Update webpack.config.js

42ce5ff

shaodahong commented Jul 12, 2017

View reviewed changes

skipjack requested changes Jul 12, 2017

View reviewed changes

fix NamedModulesPlugin and HashedModuleIdsPlugin phrased

fd9044b

simon04 requested changes Jul 13, 2017

View reviewed changes

shaodahong and others added 6 commits July 13, 2017 17:56

fix absolute URLs and add HashedModuleIdsPlugin options

6aab145

Merge branch 'master' into master

e1cfdbe

fix NamedModulesPlugin better phrased

efbc461

Merge branch 'master' of github.com:shaodahong/webpack.js.org

9e5b730

docs(plugins): minor tweaks to commons-chunk-plugin

1c8395a

docs(plugins): minor formatting/grammar fixes in hashed-module-ids-pl…

f8d0d14

…ugin

skipjack approved these changes Jul 14, 2017

View reviewed changes

skipjack changed the title ~~Plugins: Add hashed-module-ids-plugin.md and named-modules-plugin.md~~ docs(plugins): add hashed-module-ids-plugin.md and named-modules-plugin.md Jul 14, 2017

simon04 approved these changes Jul 14, 2017

View reviewed changes

skipjack merged commit 72552e9 into webpack:master Jul 14, 2017

Uh oh!

docs(plugins): add hashed-module-ids-plugin.md and named-modules-plugin.md #1392

docs(plugins): add hashed-module-ids-plugin.md and named-modules-plugin.md #1392

Uh oh!

Conversation

shaodahong commented Jul 7, 2017 • edited by skipjack Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shaodahong left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

skipjack left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shaodahong commented Jul 12, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simon04 Jul 13, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

skipjack commented Jul 14, 2017

Uh oh!

shaodahong commented Jul 14, 2017

Uh oh!

Uh oh!

shaodahong commented Jul 7, 2017 •

edited by skipjack

Loading

shaodahong left a comment •

edited

Loading

simon04 Jul 13, 2017 •

edited

Loading