docs(README): add details on usage and purpose #37

ecarlisle · 2017-03-27T18:28:55Z

Feedback is welcome on the copy to confirm it is accurate.

ecarlisle · 2017-03-27T18:31:08Z

Ok, I believe we have achieved clean PR. :-)

michael-ciniawsky · 2017-03-27T18:34:11Z

I try to review it as soon as possible :)

bebraw · 2017-04-07T19:23:41Z

README.md

-This extracts SourceMaps from all js files (including node_modules). This is not very performant, so you may want to only apply the loader to relevant files.
+`source-map-loader` extracts existing [sourcemaps](http://blog.teamtreehouse.com/introduction-source-maps) from all JavaScript entries.  This includes both inline sourcemaps as well as map data linked via URL. All map data is passed to WebPack for processing as per a chosen [source mapping style](https://webpack.js.org/configuration/devtool/) specified by the `devtool` option in [webpack.conf.js](https://webpack.js.org/configuration/).
+ +
+ +This loader is especially useful when using 3rd-party libraries having their own source maps. If not extracted and processed into the map of the WebPack bundle, browsers may misinterpret map data. `source-map-loader` allows Webpack to maintain map data continuity across libraries so ease of debugging is preserved.


/s/WebPack/webbpack

webbpack => webpack 😛

Either use the term map or source map across the whole text (Consistency)

michael-ciniawsky · 2017-04-07T19:29:02Z

README.md

-This extracts SourceMaps from all js files (including node_modules). This is not very performant, so you may want to only apply the loader to relevant files.
+`source-map-loader` extracts existing [sourcemaps](http://blog.teamtreehouse.com/introduction-source-maps) from all JavaScript entries.  This includes both inline sourcemaps as well as map data linked via URL. All map data is passed to WebPack for processing as per a chosen [source mapping style](https://webpack.js.org/configuration/devtool/) specified by the `devtool` option in [webpack.conf.js](https://webpack.js.org/configuration/).
+ +
+ +This loader is especially useful when using 3rd-party libraries having their own source maps. If not extracted and processed into the map of the WebPack bundle, browsers may misinterpret map data. `source-map-loader` allows Webpack to maintain map data continuity across libraries so ease of debugging is preserved.


webbpack => webpack 😛

michael-ciniawsky · 2017-04-07T19:29:48Z

README.md

@@ -39,7 +39,11 @@ module.exports = {
 };
 ```

-This extracts SourceMaps from all js files (including node_modules). This is not very performant, so you may want to only apply the loader to relevant files.
+`source-map-loader` extracts existing [sourcemaps](http://blog.teamtreehouse.com/introduction-source-maps) from all JavaScript entries.  This includes both inline sourcemaps as well as map data linked via URL. All map data is passed to WebPack for processing as per a chosen [source mapping style](https://webpack.js.org/configuration/devtool/) specified by the `devtool` option in [webpack.conf.js](https://webpack.js.org/configuration/).


Is the course mentioned a free one (available for all) ?

from all JavaScript entries. <= This includes => from all JavaScript entries. This includes (Spacing)

WebPack => webpack

@michael-ciniawsky : I'm assuming there was a course mentioned in the teamtreehouse.com link. I removed the link as it's probably unneeded.

michael-ciniawsky · 2017-04-07T19:33:04Z

README.md

-This extracts SourceMaps from all js files (including node_modules). This is not very performant, so you may want to only apply the loader to relevant files.
+`source-map-loader` extracts existing [sourcemaps](http://blog.teamtreehouse.com/introduction-source-maps) from all JavaScript entries.  This includes both inline sourcemaps as well as map data linked via URL. All map data is passed to WebPack for processing as per a chosen [source mapping style](https://webpack.js.org/configuration/devtool/) specified by the `devtool` option in [webpack.conf.js](https://webpack.js.org/configuration/).
+ +
+ +This loader is especially useful when using 3rd-party libraries having their own source maps. If not extracted and processed into the map of the WebPack bundle, browsers may misinterpret map data. `source-map-loader` allows Webpack to maintain map data continuity across libraries so ease of debugging is preserved.


Either use the term map or source map across the whole text (Consistency)

michael-ciniawsky · 2017-04-07T19:34:57Z

@ecarlisle See the review good after that 👍 , sry for the delay 😊

…r 'sourcemap.'

ecarlisle · 2017-04-08T21:04:33Z

@michael-ciniawsky , @bebraw - FYI, I believe I've addressed all the comments thus far.
Thanks!

michael-ciniawsky

@ecarlisle Thx

michael-ciniawsky · 2017-04-08T22:32:01Z

README.md

@@ -39,7 +39,11 @@ module.exports = {
 };
 ```

-This extracts SourceMaps from all js files (including node_modules). This is not very performant, so you may want to only apply the loader to relevant files.
+`source-map-loader` extracts existing source maps from all JavaScript entries. This includes both inline source maps as well as those linked via URL. All source map data is passed to webpack for processing as per a chosen [source map style](https://webpack.js.org/configuration/devtool/) specified by the `devtool` option in [webpack.conf.js](https://webpack.js.org/configuration/).


webpack.conf.js => webpack.config.js ('The final Typo') 😛

Haha, all my typos were with the most important terms (e.g. getting the proper casing on webpack and getting the config filename name right). :-D

ecarlisle · 2017-04-09T23:18:23Z

Completed that next round of review, the config name typo.
Do you believe the new description is accurate in what the source-map-loader does? Did I leave anything important out?
I really appreciate the teamwork on this!

michael-ciniawsky · 2017-04-09T23:24:38Z

README.md

@@ -39,7 +39,7 @@ module.exports = {
 };
 ```

-`source-map-loader` extracts existing source maps from all JavaScript entries. This includes both inline source maps as well as those linked via URL. All source map data is passed to webpack for processing as per a chosen [source map style](https://webpack.js.org/configuration/devtool/) specified by the `devtool` option in [webpack.conf.js](https://webpack.js.org/configuration/).
+`source-map-loader` extracts existing source maps from all JavaScript entries. This includes both inline source maps as well as those linked via URL. All source map data is passed to webpack for processing as per a chosen [source map style](https://webpack.js.org/configuration/devtool/) specified by the `devtool` option in [webpack.confis.js](https://webpack.js.org/configuration/).


webpack.confis.js => webpack.config.js

Got that. Uploaded, looked, groaned. Push another commit. :-)

michael-ciniawsky · 2017-04-09T23:33:30Z

@ecarlisle Nope everything 👍, besides the small typo in the link :)

ecarlisle · 2017-04-11T00:35:32Z

@michael-ciniawsky : Cool! Typo link is fixed. :-)

michael-ciniawsky

@ecarlisle Thx for patience and the example 👍

Update readme with details on usage and purpose.

14710dd

ecarlisle mentioned this pull request Mar 27, 2017

Elaborate on plugin usage and benefits. #36

Closed

michael-ciniawsky self-requested a review March 27, 2017 18:33

michael-ciniawsky self-assigned this Mar 27, 2017

michael-ciniawsky added type: Documentation pr_action: Review labels Mar 27, 2017

ecarlisle mentioned this pull request Apr 7, 2017

What is needed in Webpack 2 to create sourcemaps? webpack/webpack.js.org#971

Closed

bebraw reviewed Apr 7, 2017

View reviewed changes

michael-ciniawsky requested changes Apr 7, 2017

View reviewed changes

ecarlisle added 3 commits April 8, 2017 16:30

Ensure that all references to 'source map' are two words, not 'map' o…

703907f

…r 'sourcemap.'

Remove unneeded whitespace.

90c10f7

Remove teamtreehouse.com link defining source maps.

a6a3606

michael-ciniawsky approved these changes Apr 8, 2017

View reviewed changes

michael-ciniawsky reviewed Apr 8, 2017

View reviewed changes

michael-ciniawsky changed the title ~~Update readme with details on usage and purpose.~~ docs(README): add details on usage and purpose Apr 8, 2017

michael-ciniawsky removed the pr_action: Review label Apr 8, 2017

Fix typo in config file name.

1a96b0d

Fix support typo. :-)

973172f

michael-ciniawsky requested changes Apr 9, 2017

View reviewed changes

michael-ciniawsky approved these changes Apr 11, 2017

View reviewed changes

michael-ciniawsky merged commit 5501fe3 into webpack-contrib:master Apr 11, 2017

michael-ciniawsky removed the type: Documentation label Apr 11, 2017

michael-ciniawsky removed their assignment Apr 11, 2017

ecarlisle deleted the elaborate-docs-in-readme branch April 11, 2017 02:00

cap-Bernardito mentioned this pull request May 16, 2020

Documentation Request #32

Closed

Uh oh!

docs(README): add details on usage and purpose #37

docs(README): add details on usage and purpose #37

Uh oh!

Conversation

ecarlisle commented Mar 27, 2017

Uh oh!

ecarlisle commented Mar 27, 2017

Uh oh!

michael-ciniawsky commented Mar 27, 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!

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!

michael-ciniawsky commented Apr 7, 2017

Uh oh!

ecarlisle commented Apr 8, 2017

Uh oh!

michael-ciniawsky 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!

ecarlisle commented Apr 9, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michael-ciniawsky commented Apr 9, 2017

Uh oh!

ecarlisle commented Apr 11, 2017

Uh oh!

michael-ciniawsky left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!