Naughty Programmer's Madness

    @insin/extract-text-webpack-plugin

    2.0.0-rc.2.e8e97806 • Public • Published

    npm node deps tests coverage chat

    Extract Text Plugin

    Install

    npm install --save-dev extract-text-webpack-plugin

    Usage

    ⚠️ For webpack v1, see the README in the webpack-1 branch.

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

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

    Advantages Caveats
    Fewer style tags (older IE has a limit) Additional HTTP request
    CSS SourceMap (with devtool: "source-map" and extract-text-webpack-plugin?sourceMap) Longer compilation time
    CSS requested in parallel No runtime public path modification
    CSS cached separate No Hot Module Replacement
    Faster runtime (less code and DOM operations) ...

    Options

    new ExtractTextPlugin(options: filename | object)
    Name Type Description
    id {String} Unique ident for this plugin instance. (For advanced usage only, by default automatically generated)
    filename {String} Name of the result file. May contain [name], [id] and [contenthash]
    options.allChunks {Boolean} Extract from all additional chunks too (by default it extracts only from the initial chunk(s))
    options.disable {Boolean} Disables the plugin
    • [name] name of the chunk
    • [id] number of the chunk
    • [contenthash] hash of the content of the extracted file

    ⚠️ ExtractTextPlugin generates a file per entry, so you must use [name], [id] or [contenthash] when using multiple entries.

    #extract

    ExtractTextPlugin.extract(options: loader | object)

    Creates an extracting loader from an existing loader. Supports loaders of type { loader: [name]-loader -> {String}, options: {} -> {Object} }.

    Name Type Description
    options.loader {String}/{Object} Loader(s) that should be used for converting the resource to a CSS exporting module (required)
    options.fallbackLoader {String}/{Object} loader(e.g 'style-loader') that should be used when the CSS is not extracted (i.e. in an additional chunk when allChunks: false)
    options.publicPath {String} Override the publicPath setting for this loader

    Multiple Instances

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

    const ExtractTextPlugin = require('extract-text-webpack-plugin');
     
    // Create multiple instances
    const extractCSS = new ExtractTextPlugin('stylesheets/[name].css');
    const extractLESS = new ExtractTextPlugin('stylesheets/[name].less');
     
    module.exports = {
      module: {
        use: [
          {
            test: /\.css$/,
            use: extractCSS.extract([ 'css-loader', 'postcss-loader' ])
          },
          {
            test: /\.html$/i,
            use: extractLESS.extract([ 'css-loader', 'less-loader' ])
          },
        ]
      },
      plugins: [
        extractCSS,
        extractLESS
      ]
    };

    Maintainer


    Tobias Koppers

    Keywords

    none

    Install

    npm i @insin/extract-text-webpack-plugin

    DownloadsWeekly Downloads

    10

    Version

    2.0.0-rc.2.e8e97806

    License

    MIT

    Last publish

    Collaborators

    • avatar