Skip to content

benweizhu/extract-text-webpack-plugin

 
 

Repository files navigation

extract text plugin for webpack

Usage example with css

var ExtractTextPlugin = require("extract-text-webpack-plugin");
module.exports = {
	module: {
		loaders: [
			{ test: /\.css$/, loader: ExtractTextPlugin.extract("style-loader", "css-loader") }
		]
	},
	plugins: [
		new ExtractTextPlugin("styles.css")
	]
}

It moves every require("style.css") in entry chunks into a separate css output file. So your styles are no longer inlined into the javascript, but separate in a css bundle file (styles.css). If your total stylesheet volume is big, it will be faster because the stylesheet bundle is loaded in parallel to the javascript bundle.

Advantages:

  • Fewer style tags (older IE has a limit)
  • CSS SourceMap (with devtool: "source-map" and css-loader?sourceMap)
  • CSS requested in parallel
  • CSS cached separate
  • Faster runtime (less code and DOM operations)

Caveats:

  • Additional HTTP request
  • Longer compilation time
  • More complex configuration
  • No runtime public path modification
  • No Hot Module Replacement

API

new ExtractTextPlugin([id: string], filename: string, [options])
  • id Unique ident for this plugin instance. (For advanded usage only, by default automatic generated)
  • filename the filename of the result file. May contain [name], [id] and [contenthash].
    • [name] the name of the chunk
    • [id] the number of the chunk
    • [contenthash] a hash of the content of the extracted file
  • options
    • allChunks extract from all additional chunks too (by default it extracts only from the initial chunk(s))
    • disable disables the plugin

The ExtractTextPlugin generates an output file per entry, so you must use [name], [id] or [contenthash] when using multiple entries.

ExtractTextPlugin.extract([notExtractLoader], loader, [options])

Creates an extracting loader from an existing loader.

  • notExtractLoader (optional) the loader(s) that should be used when the css is not extracted (i.e. in an additional chunk when allChunks: false)
  • loader the loader(s) that should be used for converting the resource to a css exporting module.
  • options
    • publicPath override the publicPath setting for this loader.

There is also an extract function on the instance. You should use this if you have more than one ExtractTextPlugin.

License

MIT (http://www.opensource.org/licenses/mit-license.php)

About

Extract text from bundle into a file.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 95.4%
  • CSS 3.1%
  • HTML 1.5%