Improve documentation on devtool #1533

sokra · 2017-08-22T08:37:36Z

fixes webpack/webpack#2725
fixes webpack/webpack#4936
fixes webpack/webpack#2766
fixes webpack/webpack#2145
fixes webpack/webpack#1689
fixes #273

ChrisChinchilla · 2017-08-23T06:43:19Z

content/configuration/devtool.md

-T> `+` means faster, `-` slower and `o` about the same time
-
-Some of these values are suited for development and some for production. For development you typically want fast Source Maps at the cost of bundle size, but for production you want separate Source Maps that are accurate.
+T> Instead of using the `devtool` option you can also use the `SourceMapDevToolPlugin`/`EvalSourceMapDevToolPlugin` directly. It has more options. You must never use both `devtool` option and plugin!


T> Instead of using the devtool option you can also use SourceMapDevToolPlugin/EvalSourceMapDevToolPlugin directly as it has more options. Never use both the devtool option and plugin together.

ChrisChinchilla · 2017-08-23T06:43:39Z

content/configuration/devtool.md

-T> `+` means faster, `-` slower and `o` about the same time
-
-Some of these values are suited for development and some for production. For development you typically want fast Source Maps at the cost of bundle size, but for production you want separate Source Maps that are accurate.
+T> Instead of using the `devtool` option you can also use the `SourceMapDevToolPlugin`/`EvalSourceMapDevToolPlugin` directly. It has more options. You must never use both `devtool` option and plugin!


@sokra Can we say why someone shouldn't use them together?

ChrisChinchilla · 2017-08-23T06:45:31Z

content/configuration/devtool.md

+hidden-source-map              | --    | --      | yes        | original source
+nosources-source-map           | --    | --      | yes        | without source content
+
+T> `+++` super fast, `++` pretty fast, `+` fast, `o` medium, `-` slow, `--` pretty slow


@sokra You had a previous commit that used very fast, I think that's actually better, as 'pretty' would typically be one before 'fast'.

The CI didn't allowed me to use very.

Interesting, I guess it labels it as a 'weasel word', which is kind of true, but an indication there are times you might want it 😆 .

Thanks!

ChrisChinchilla · 2017-08-23T06:47:27Z

content/configuration/devtool.md


 W> There are some issues with Source Maps in Chrome. [We need your help!](https://github.com/webpack/webpack/issues/3165).

 T> See [`output.sourceMapFilename`](/configuration/output#output-sourcemapfilename) to customize the filenames of generated Source Maps.

+### Qualities


@sokra Can we add a line break between the explanation and the examples?

ChrisChinchilla · 2017-08-23T06:49:38Z

content/configuration/devtool.md


-`hidden-source-map` - Same as `source-map`, but doesn't add a reference comment to the bundle. Useful if you only want SourceMaps to map error stack traces from error reports, but don't want to expose your SourceMap for the browser development tools.
+`source-map` - A full SourceMap is emitted as a separate file. It adds a reference comment to the bundle so development tools know where to find it. Warning: You should configure your server to disallow access to the Source Map file for normal users!


@sokra Could we add a line break between the explanation and the warning? Ideally this would be formatted differently, but we'll worry about that later.

ChrisChinchilla · 2017-08-23T06:49:50Z

content/configuration/devtool.md


-`cheap-source-map` - A SourceMap without column-mappings ignoring loaded Source Maps.
+`hidden-source-map` - Same as `source-map`, but doesn't add a reference comment to the bundle. Useful if you only want SourceMaps to map error stack traces from error reports, but don't want to expose your SourceMap for the browser development tools. Warning: You should not deploy the Source Map file to the webserver. Instead only use it for error report tooling.


@sokra Could we add a line break between the explanation and the warning? Ideally this would be formatted differently, but we'll worry about that later.

ChrisChinchilla · 2017-08-23T06:49:57Z

content/configuration/devtool.md


-`cheap-module-source-map` - A SourceMap without column-mappings that simplifies loaded Source Maps to a single mapping per line.
+`nosources-source-map` - A SourceMap is created without the `sourcesContent` in it. It can be used to map stack traces on the client without exposing all of the source code. You can deploy the Source Map file to the webserver. Warning: It still exposes filenames and structure for decompiling, but it doesn't expose the original code.


@sokra Could we add a line break between the explanation and the warning? Ideally this would be formatted differently, but we'll worry about that later.

ChrisChinchilla

Hey @sokra I'm working with the Webpack docs to improve and polish language as much as possible, here are a few suggestions…

Thanks for the contribution.

sokra · 2017-08-23T07:18:53Z

@ChrisChinchilla Thanks for your feedback.

skipjack · 2017-08-23T21:22:21Z

content/configuration/devtool.md

 `source-map` - A full SourceMap is emitted as a separate file. It adds a reference comment to the bundle so development tools know where to find it.

+W> You should configure your server to disallow access to the Source Map file for normal users!


@ChrisChinchilla we actually can format them differently (as @sokra did here). We have custom markdown syntax enabled so that you can use W> for a warning, T> for a tip, and ?> for a TODO. I think this is mentioned in the writer's guide but if it's not feel free to submit a PR.

skipjack

@sokra awesome work and @ChrisChinchilla thanks for reviewing! I think this one also resolves #273.

skipjack · 2017-08-23T21:24:13Z

I'm going to work on resolving the conflicts here and in the other approved PRs as soon as I get some time so we can get these things merged. They're due to the major restructuring from #1490.

fixes webpack/webpack#2725 fixes webpack/webpack#4936 fixes webpack/webpack#2766 fixes webpack/webpack#2145 fixes webpack/webpack#1689

skipjack · 2017-08-24T06:14:50Z

@sokra merged, you should be able to close those issues on the main repo now. (it doesn't seem like the "fixes" keyword works across repos unfortunately, although maybe there's good reason for that)

skipjack added Configuration Enhancement labels Aug 22, 2017

ChrisChinchilla reviewed Aug 23, 2017

View reviewed changes

skipjack reviewed Aug 23, 2017

View reviewed changes

skipjack approved these changes Aug 23, 2017

View reviewed changes

sokra added 4 commits August 24, 2017 01:00

Improve documentation on devtool

cdab61f

fixes webpack/webpack#2725 fixes webpack/webpack#4936 fixes webpack/webpack#2766 fixes webpack/webpack#2145 fixes webpack/webpack#1689

replace very with pretty

ee6bbe1

wording and formating

6c3c76f

change order of pretty and not pretty

3a412fc

skipjack force-pushed the content/devtool branch from ecb90ce to 3a412fc Compare August 24, 2017 05:01

skipjack merged commit 4d5eb08 into master Aug 24, 2017

skipjack deleted the content/devtool branch August 24, 2017 06:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve documentation on devtool #1533

Improve documentation on devtool #1533

sokra commented Aug 22, 2017 •

edited by skipjack

Loading

ChrisChinchilla Aug 23, 2017

ChrisChinchilla Aug 23, 2017

ChrisChinchilla Aug 23, 2017

sokra Aug 23, 2017

ChrisChinchilla Aug 23, 2017

ChrisChinchilla Aug 23, 2017

ChrisChinchilla Aug 23, 2017

ChrisChinchilla Aug 23, 2017

ChrisChinchilla Aug 23, 2017

ChrisChinchilla left a comment

sokra commented Aug 23, 2017

skipjack Aug 23, 2017

skipjack left a comment

skipjack commented Aug 23, 2017

skipjack commented Aug 24, 2017 •

edited

Loading


		`hidden-source-map` - Same as `source-map`, but doesn't add a reference comment to the bundle. Useful if you only want SourceMaps to map error stack traces from error reports, but don't want to expose your SourceMap for the browser development tools.
		`source-map` - A full SourceMap is emitted as a separate file. It adds a reference comment to the bundle so development tools know where to find it. Warning: You should configure your server to disallow access to the Source Map file for normal users!


		`cheap-source-map` - A SourceMap without column-mappings ignoring loaded Source Maps.
		`hidden-source-map` - Same as `source-map`, but doesn't add a reference comment to the bundle. Useful if you only want SourceMaps to map error stack traces from error reports, but don't want to expose your SourceMap for the browser development tools. Warning: You should not deploy the Source Map file to the webserver. Instead only use it for error report tooling.


		`cheap-module-source-map` - A SourceMap without column-mappings that simplifies loaded Source Maps to a single mapping per line.
		`nosources-source-map` - A SourceMap is created without the `sourcesContent` in it. It can be used to map stack traces on the client without exposing all of the source code. You can deploy the Source Map file to the webserver. Warning: It still exposes filenames and structure for decompiling, but it doesn't expose the original code.

		`source-map` - A full SourceMap is emitted as a separate file. It adds a reference comment to the bundle so development tools know where to find it.

		W> You should configure your server to disallow access to the Source Map file for normal users!

Improve documentation on devtool #1533

Improve documentation on devtool #1533

Conversation

sokra commented Aug 22, 2017 • edited by skipjack Loading

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

ChrisChinchilla left a comment

Choose a reason for hiding this comment

sokra commented Aug 23, 2017

Choose a reason for hiding this comment

skipjack left a comment

Choose a reason for hiding this comment

skipjack commented Aug 23, 2017

skipjack commented Aug 24, 2017 • edited Loading

sokra commented Aug 22, 2017 •

edited by skipjack

Loading

skipjack commented Aug 24, 2017 •

edited

Loading