Skip to content

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

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

Merged
merged 6 commits into from
Apr 11, 2017
Merged

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

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
14710dd
Update readme with details on usage and purpose.
ecarlisle Mar 27, 2017
703907f
Ensure that all references to 'source map' are two words, not 'map' o…
ecarlisle Apr 8, 2017
90c10f7
Remove unneeded whitespace.
ecarlisle Apr 8, 2017
a6a3606
Remove teamtreehouse.com link defining source maps.
ecarlisle Apr 8, 2017
1a96b0d
Fix typo in config file name.
ecarlisle Apr 9, 2017
973172f
Fix support typo. :-)
ecarlisle Apr 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

+
+This loader is especially useful when using 3rd-party libraries having their own source maps. If not extracted and processed into the souce map of the webpack bundle, browsers may misinterpret source map data. `source-map-loader` allows webpack to maintain source map data continuity across libraries so ease of debugging is preserved.
+
+`source-map-loader` will extract from any JavaScript file, including those in the `node_modules` directory. Be mindful in setting [include](https://webpack.js.org/configuration/module/#rule-include) and [exclude](https://webpack.js.org/configuration/module/#rule-exclude) rule conditions to maximize bundling performance.

<h2 align="center">Maintainers</h2>

Expand Down