DllPlugin & DllReferencePlugin docs (without pending examples) #1177

aretecode · 2017-04-30T23:23:53Z

this is #1121

but with examples that are not-yet-merged removed as per #1121 (comment)

🙏 add simon04 to collaborators 🛁 clean commented example 🔗🌽 link to example pull request 🔗 add more named links to other parts of the dll plugin & dll reference plugin source code 🌊👣 add TemplatePaths type for `name` 🔬 more source code test links 📘 add examples section 📘⎁⎂ descriptions for the examples, explain what functionality they demonstrate

@simon04

🏛️ update structure as suggested by @simon04 [here](webpack#1121 (comment)) ⚒⌨️ fix typo found by @smashercosmo webpack#1121 (review) 📘 added dll-example using `libraryTarget` + `sourceType` `"commonjs2"` to create a vendor bundle, and a dependency bundle, on nodejs. 📝 remove completed todos

aretecode · 2017-05-01T23:39:07Z

travis

cannot try locally currently
#1179

@simon04 any advice for debugging this?

aretecode · 2017-05-02T23:24:40Z

@skipjack @simon04 should I just take the link out of the index so the build passes or?

skipjack · 2017-05-03T01:04:16Z

@aretecode patched that issue in #1170. We still have to figure out the root cause but this should be fine for review and merging as that issue obviously wasn't caused by this PR.

skipjack · 2017-05-03T01:05:17Z

@aretecode should we close #1121 now or were you leaving that open as a follow-up PR?

aretecode · 2017-05-03T04:24:41Z

@skipjack I'd like to have it as a follow-up pr because there are still 2 examples I made for webpack that I'd like merged, which that pr references.

aretecode · 2017-05-03T04:25:21Z

@skipjack awesome, your fix made the test pass so this pr should be good to go!

simon04

🚀 Wow, I like the way this plugin documentation is written. Thanks a lot for your efforts.

I found a few rather minor issues. Please revise.

simon04 · 2017-05-03T20:25:56Z

content/plugins/dll-plugin.md

+
+Because this happens after resolving every file in the dll bundle, the same paths must be available for the consumer of the dll bundle. i.e. if the dll contains `lodash` and the file `abc`, `require("lodash")` and `require("./abc")` will be used from the dll, rather than building them into the main bundle.
+
+T> [See an example use of mapped mode][examples-dll-source-type-and-dependencies]


This link is broken.

simon04 · 2017-05-03T20:27:17Z

content/plugins/dll-plugin.md

+* `context`: (**absolute path**) context of requests in the manifest (or content property)
+* `content` (optional): the mappings from request to module id (defaults to `manifest.content`)
+* `manifest` (object): an object containing `content` and `name`
+* `name` (optional): the name where the dll is exposed (defaults to `manifest.name`) (see also `externals`)


Link *externals to /configuration/externals/.

simon04 · 2017-05-03T20:27:43Z

content/plugins/dll-plugin.md

+
+* `context`: (**absolute path**) context of requests in the manifest (or content property)
+* `content` (optional): the mappings from request to module id (defaults to `manifest.content`)
+* `manifest` (object): an object containing `content` and `name`


I see the alphabetical ordering. Still, since content refers to manifest, put manifest before content?

simon04 · 2017-05-03T20:28:32Z

content/plugins/dll-plugin.md

+Creates a `manifest.json` which is written to the given `path`. It contains mappings from require and import requests, to module ids. It is used by the [DllReferencePlugin](#DllReferencePlugin).
+
+
+W> Keep the `name` consistent with `output.library`.


Put this warning below the next paragraph since the latter explains what this is good for.

simon04 · 2017-05-03T20:28:53Z

content/plugins/dll-plugin.md

+
+W> Keep the `name` consistent with `output.library`.
+
+Combine this plugin with `output.library` option to expose (aka, put into the global scope) the dll function.


Link output.library to /concepts/output/#output-library.

simon04 · 2017-05-03T20:29:26Z

content/plugins/dll-plugin.md

+[tests-DllPlugin-1]: https://github.com/webpack/webpack/tree/master/test/configCases/dll-plugin
+[tests-DllPlugin-2]: https://github.com/webpack/webpack/tree/master/test/configCases/dll-plugin/2-use-dll-without-scope/webpack.config.js
+
+[docs-libraryTarget]: https://webpack.js.org/configuration/output/#output-librarytarget


Please drop the https://webpack.js.org part from the link.

simon04 · 2017-05-03T20:30:15Z

content/plugins/dll-plugin.md

+
+
+
+## More


Replace "More" with "References" (to conform with other documentation pages).

simon04 · 2017-05-03T20:31:22Z

content/plugins/dll-plugin.md

+
+
+```javascript
+// webpack.vendor.config.js


Please put the filename above the code block in bold letters: **webpack.vendor.config.js** (to comply with other pages).

simon04 · 2017-05-03T20:31:29Z

content/plugins/dll-plugin.md

+```
+
+```javascript
+// webpack.app.config.js


Please put the filename above the code block in bold letters: **webpack.app.config.js** (to comply with other pages).

🙏 skipjack 🔢 prop order ⚒🔗 fix broken link 📒 file names as headers ⎁⎂ more to references

aretecode · 2017-05-03T22:25:58Z

@simon04 updated, thanks for the review!

skipjack · 2017-05-05T03:13:41Z

content/plugins/dll-plugin.md

+[examples-dll-user]: https://github.com/webpack/webpack/tree/master/examples/dll-user
+[examples-explicit-vendor-chunk]: https://github.com/webpack/webpack/tree/master/examples/explicit-vendor-chunk/README.md
+
+[src-DllReferencePlugin]: https://github.com/webpack/tree/master/lib/DllReferencePlugin.js


@aretecode unfortunately our current setup doesn't support reference links:

This is something I hope to resolve at some point #178, but for now can you inline these?

skipjack · 2017-05-05T03:15:00Z

@aretecode after that reference link fix this should be good to go in my view. Improvements can always be made in follow-up PRs, @simon04 what do you think?

aretecode · 2017-05-05T03:52:17Z

@skipjack thanks, ok, will fix

simon04

🚀

aretecode · 2017-05-05T20:10:25Z

🎊

aretecode added 13 commits April 18, 2017 02:32

🤸 🔌 📖 dll plugin docs

344dbca

🔗 linked dll-plugin from plugin index

509d30b

⌨️ change casing

4b907b2

Merge branch 'master' into patch-1

dad4a7f

Merge branch 'master' into patch-1

bcfff36

Merge branch 'master' into patch-1

65c951b

backtick plugin names & order alphabetical

7ff3725

Merge branch 'master' into patch-1

15f91d7

strip pending examples

9018dd8

👕 fix markdown following linting rules

4aeab57

Merge branch 'master' into dll-without-examples

1fc8f3f

skipjack mentioned this pull request May 2, 2017

Support Refactor #1170

Merged

skipjack added the Plugins label May 2, 2017

Merge branch 'master' into dll-without-examples

5ed9b5d

skipjack requested a review from simon04 May 3, 2017 01:02

simon04 requested changes May 3, 2017

View reviewed changes

aretecode added 2 commits May 3, 2017 15:24

⚒🔗 link ⎁⎂ more -> refs, 🔢 prop order, 📒 header

c730a87

🙏 skipjack 🔢 prop order ⚒🔗 fix broken link 📒 file names as headers ⎁⎂ more to references

Merge branch 'master' into dll-without-examples

a4d60e4

aretecode and others added 3 commits May 4, 2017 00:19

Merge branch 'master' into dll-without-examples

94a59ff

👕 space around headers

5ab2ebf

docs(plugins): make minor formatting tweaks

7491d02

skipjack requested changes May 5, 2017

View reviewed changes

aretecode added 3 commits May 4, 2017 23:23

Merge branch 'master' into dll-without-examples

c1365b0

🔗 change links to inline

2b5fd45

⌨️⚒ fix typo library -> libraryTarget

a190df6

simon04 approved these changes May 5, 2017

View reviewed changes

simon04 merged commit c471d33 into webpack:master May 5, 2017

skipjack mentioned this pull request May 5, 2017

Documentation for DllPlugin / DllReferencePlugin #944

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DllPlugin & DllReferencePlugin docs (without pending examples) #1177

DllPlugin & DllReferencePlugin docs (without pending examples) #1177

aretecode commented Apr 30, 2017

aretecode commented May 1, 2017 •

edited

Loading

aretecode commented May 2, 2017

skipjack commented May 3, 2017

skipjack commented May 3, 2017

aretecode commented May 3, 2017

aretecode commented May 3, 2017

simon04 left a comment

simon04 May 3, 2017

simon04 May 3, 2017

simon04 May 3, 2017

simon04 May 3, 2017

simon04 May 3, 2017

simon04 May 3, 2017

simon04 May 3, 2017

simon04 May 3, 2017

simon04 May 3, 2017

aretecode commented May 3, 2017

skipjack May 5, 2017

skipjack commented May 5, 2017

aretecode commented May 5, 2017

simon04 left a comment

aretecode commented May 5, 2017


		Because this happens after resolving every file in the dll bundle, the same paths must be available for the consumer of the dll bundle. i.e. if the dll contains `lodash` and the file `abc`, `require("lodash")` and `require("./abc")` will be used from the dll, rather than building them into the main bundle.

		T> [See an example use of mapped mode][examples-dll-source-type-and-dependencies]

		Creates a `manifest.json` which is written to the given `path`. It contains mappings from require and import requests, to module ids. It is used by the [DllReferencePlugin](#DllReferencePlugin).


		W> Keep the `name` consistent with `output.library`.


		W> Keep the `name` consistent with `output.library`.

		Combine this plugin with `output.library` option to expose (aka, put into the global scope) the dll function.



		```javascript
		// webpack.vendor.config.js

DllPlugin & DllReferencePlugin docs (without pending examples) #1177

DllPlugin & DllReferencePlugin docs (without pending examples) #1177

Conversation

aretecode commented Apr 30, 2017

aretecode commented May 1, 2017 • edited Loading

aretecode commented May 2, 2017

skipjack commented May 3, 2017

skipjack commented May 3, 2017

aretecode commented May 3, 2017

aretecode commented May 3, 2017

simon04 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aretecode commented May 3, 2017

Choose a reason for hiding this comment

skipjack commented May 5, 2017

aretecode commented May 5, 2017

simon04 left a comment

Choose a reason for hiding this comment

aretecode commented May 5, 2017

aretecode commented May 1, 2017 •

edited

Loading