-
-
+If you like our work, check out our Redux-based router redux-first-router or its sucessor which, Rudy
# extract-css-chunks-webpack-plugin
@@ -9,7 +6,7 @@
-
+
@@ -17,245 +14,606 @@
+
+
+ 
+
+
+
+ 
+
-> **UPDATE (July 7th):** [babel-plugin-dual-import](https://github.com/faceyspacey/babel-plugin-dual-import) is now required to asynchronously import both css + js. *Much Faster Builds!* You likely want to read [its intro article](https://medium.com/@faceyspacey/webpacks-import-will-soon-fetch-js-css-here-s-how-you-do-it-today-4eb5b4929852).
+🍾🍾🍾It's our absolute pleasure to announce Webpack 4 Support 🚀🚀🚀
-> **UPDATE (July 26th):** [babel-plugin-universal-import](https://github.com/faceyspacey/babel-plugin-universal-import) is what to use if you're using *React Universal Component*. +> **HEADLINES (May 2018): Now Independently supports Webpack 4:** +> Yep that's right. The universal family is now fully Webpack 4. Thank you to all our users for your loyalty and patience! If you love Universal, then you are gonna fall head over heels when we bring out the main course! -Like `extract-text-webpack-plugin`, but creates multiple css files (one per chunk). Then, as part of server side rendering, you can deliver just the css chunks needed by the current request. The result is the most minimal CSS initially served compared to emerging "render path" solutions. +So... why did we rebuild `extract-css-chunks-webpack-plugin`? What does it offer? -For a demo, `git clone`: [universal-demo](https://github.com/faceyspacey/universal-demo) +It's got all the goodness of `mini-css-extract-plugin` but with 2 gleaming, sought after benefits. -*Note: this is a companion package to:* -- [webpack-flush-chunks](https://github.com/faceyspacey/webpack-flush-chunks) -- [react-universal-component](https://github.com/faceyspacey/react-universal-component) -- [babel-plugin-universal-import](https://github.com/faceyspacey/babel-plugin-universal-import) ***or*** [babel-plugin-dual-import](https://github.com/faceyspacey/babel-plugin-dual-import) +Compared to the existing loaders, we are offering a single solution as opposed to needing to depend on multiple loaders to cater for different features: +## Perks -## Recommended Installation -``` -yarn add react-universal-component webpack-flush-chunks -yarn add --dev extract-css-chunks-webpack-plugin babel-plugin-universal-import -``` +- **HMR:** It also has first-class support for **Hot Module Replacement** across ALL those css files/chunks!!! +- cacheable stylesheets +- smallest total bytes sent compared to "render-path" css-in-js solutions that include your CSS definitions in JS +- Faster than the V2! +- Async loading +- No duplicate compilation (performance) +- Easier to use +- Specific to CSS +- SSR Friendly development build, focused on frontend DX +- Works seamlessly with the Universal family +- Works fantastically as a standalone style loader (You can use it for any webpack project! with no extra dependencies!) +- Async styles do not render block webkit browsers, if you use the `insert` option + +Additionally, if you are already a user of the universal family -- we will be waving goodbye to the mandatory `window.__CSS_CHUNKS__`. + +The functionality is still available to you via chunk flushing, and it can come in super handy when needing to easily resolve style assets as urls that might need to be passed to a third party. + +**webpack.config.js** -*.babelrc:* ```js -{ - "plugins": ["universal-import"] -} +const ExtractCssChunks = require('extract-css-chunks-webpack-plugin'); + +module.exports = { + plugins: [new ExtractCssChunks()], + module: { + rules: [ + { + test: /\.css$/i, + use: [ExtractCssChunks.loader, 'css-loader'], + }, + ], + }, +}; ``` -*webpack.config.js:* +## Options + +### `publicPath` + +Type: `String|Function` +Default: the `publicPath` in `webpackOptions.output` + +Specifies a custom public path for the target file(s). + +#### `String` + +**webpack.config.js** + ```js -const ExtractCssChunks = require("extract-css-chunks-webpack-plugin") +const ExtractCssChunks = require('extract-css-chunks-webpack-plugin'); module.exports = { + plugins: [ + new ExtractCssChunks({ + // Options similar to the same options in webpackOptions.output + // both options are optional + filename: '[name].css', + chunkFilename: '[id].css', + }), + ], module: { rules: [ { test: /\.css$/, - use: ExtractCssChunks.extract({ - use: { - loader: 'css-loader', + use: [ + { + loader: ExtractCssChunks.loader, options: { - modules: true, - localIdentName: '[name]__[local]--[hash:base64:5]' - } - } - }) - } - ] + publicPath: '/public/path/to/', + }, + }, + 'css-loader', + ], + }, + ], }, - plugins: [ - new ExtractCssChunks, - ] -} +}; ``` -## Desired Output -Here's the sort of CSS you can expect to serve: +#### `Function` -``` - - - - - - - - - - - - - - - - - +**webpack.config.js** + +```js +const ExtractCssChunks = require('extract-css-chunks-webpack-plugin'); + +module.exports = { + plugins: [ + new ExtractCssChunks({ + // Options similar to the same options in webpackOptions.output + // both options are optional + filename: '[name].css', + chunkFilename: '[id].css', + }), + ], + module: { + rules: [ + { + test: /\.css$/, + use: [ + { + loader: ExtractCssChunks.loader, + options: { + publicPath: (resourcePath, context) => { + return path.relative(path.dirname(resourcePath), context) + '/'; + }, + }, + }, + 'css-loader', + ], + }, + ], + }, +}; ``` -[webpack-flush-chunks](https://github.com/faceyspacey/webpack-flush-chunks) will scoop up the exact stylesheets to embed in your response. It essentially automates producing the above. +### `esModule` -Here's how you do it: +Type: `Boolean` +Default: `false` + +By default, `extract-css-chunks-webpack-plugin` generates JS modules that use the CommonJS modules syntax. +There are some cases in which using ES modules is beneficial, like in the case of [module concatenation](https://webpack.js.org/plugins/module-concatenation-plugin/) and [tree shaking](https://webpack.js.org/guides/tree-shaking/). + +You can enable a ES module syntax using: + +**webpack.config.js** -*src/components/App.js:* ```js -const UniversalComponent = universal(props => import(`./${props.page}`)) +const ExtractCssChunks = require('extract-css-chunks-webpack-plugin'); -${app}
- ${cssHash}
- ${js}
-
-
-`)
+const ExtractCssChunks = require('extract-css-chunks-webpack-plugin');
+
+module.exports = {
+ plugins: [
+ new ExtractCssChunks({
+ // Options similar to the same options in webpackOptions.output
+ // all options are optional
+ filename: '[name].css',
+ chunkFilename: '[id].css',
+ ignoreOrder: false, // Enable to remove warnings about conflicting order
+ }),
+ ],
+ module: {
+ rules: [
+ {
+ test: /\.css$/,
+ use: [
+ {
+ loader: ExtractCssChunks.loader,
+ options: {
+ // you can specify a publicPath here
+ // by default it uses publicPath in webpackOptions.output
+ publicPath: '../',
+ hmr: process.env.NODE_ENV === 'development',
+ },
+ },
+ 'css-loader',
+ ],
+ },
+ ],
+ },
+};
```
-***As for asynchronous calls to `import()` on user navigation,*** [babel-plugin-universal-import](https://github.com/faceyspacey/babel-plugin-universal-import) is required if you're using [react-universal-component](https://github.com/faceyspacey/react-universal-component). And if you aren't, you must use: [babel-plugin-dual-import](https://github.com/faceyspacey/babel-plugin-dual-import).
+### The `publicPath` option as function
-These babel plugins request both your js + your css. *Very Nice!* This is the new feature of the 2.0. Read *Sokra's* (author of webpack) article on how [on how this is the future of CSS for webpack](https://medium.com/webpack/the-new-css-workflow-step-1-79583bd107d7). Use this and be in the future today.
+**webpack.config.js**
-## Perks
-- **HMR:** It also has first-class support for **Hot Module Replacement** across ALL those css files/chunks!!!
-- cacheable stylesheets
-- smallest total bytes sent compared to "render-path" css-in-js solutions that include your CSS definitions in JS
-- Faster than the V1!
+```js
+const ExtractCssChunks = require('extract-css-chunks-webpack-plugin');
+module.exports = {
+ plugins: [
+ new ExtractCssChunks({
+ // Options similar to the same options in webpackOptions.output
+ // both options are optional
+ filename: '[name].css',
+ chunkFilename: '[id].css',
+ }),
+ ],
+ module: {
+ rules: [
+ {
+ test: /\.css$/,
+ use: [
+ {
+ loader: ExtractCssChunks.loader,
+ options: {
+ publicPath: (resourcePath, context) => {
+ // publicPath is the relative path of the resource to the context
+ // e.g. for ./css/admin/main.css the publicPath will be ../../
+ // while for ./css/main.css the publicPath will be ../
+ return path.relative(path.dirname(resourcePath), context) + '/';
+ },
+ },
+ },
+ 'css-loader',
+ ],
+ },
+ ],
+ },
+};
+```
+
+### Advanced configuration example
+This plugin should be used only on `production` builds without `style-loader` in the loaders chain, especially if you want to have HMR in `development`.
+Here is an example to have both HMR in `development` and your styles extracted in a file for `production` builds.
-## API
-You can pass the same options as `extract-text-webpack-plugin` to `new ExtractCssChunks`, such as:
+(Loaders options left out for clarity, adapt accordingly to your needs.)
+
+**webpack.config.js**
+
+```js
+const ExtractCssChunks = require('extract-css-chunks-webpack-plugin');
+const devMode = process.env.NODE_ENV !== 'production';
-```javascript
-new ExtractCssChunk({
- filename: '[name].[contenthash].css'
-})
+module.exports = {
+ plugins: [
+ new ExtractCssChunks({
+ // Options similar to the same options in webpackOptions.output
+ // both options are optional
+ filename: devMode ? '[name].css' : '[name].[hash].css',
+ chunkFilename: devMode ? '[id].css' : '[id].[hash].css',
+ }),
+ ],
+ module: {
+ rules: [
+ {
+ test: /\.(sa|sc|c)ss$/,
+ use: [
+ {
+ loader: ExtractCssChunks.loader,
+ options: {
+ hmr: process.env.NODE_ENV === 'development',
+ },
+ },
+ 'css-loader',
+ 'postcss-loader',
+ 'sass-loader',
+ ],
+ },
+ ],
+ },
+};
```
-Keep in mind, by default `[name].css` is used when `process.env.NODE_ENV === 'development'` and `[name].[contenthash].css` during production, so you can likely forget about having to pass anything.
+### Hot Module Reloading (HMR)
-The 2 exceptions are: `allChunks` will no longer do anything, and `fallback` will no longer do anything when passed to to `extract`. Basically just worry about passing your `css-loader` string and `localIdentName` 🤓
+The `extract-css-chunks-webpack-plugin` supports hot reloading of actual css files in development.
+Some options are provided to enable HMR of both standard stylesheets and locally scoped CSS or CSS modules.
+Below is an example configuration of `extract-css-chunks` for HMR use with CSS modules.
+While we attempt to hmr css-modules. It is not easy to perform when code-splitting with custom chunk names.
+`reloadAll` is an option that should only be enabled if HMR isn't working correctly.
+The core challenge with css-modules is that when code-split, the chunk ids can and do end up different compared to the filename.
-### HMR Pitfall
+**webpack.config.js**
-The most common workflow when working with webpack is to write a "development" / "production" value in to the
-'process.env.NODE_ENV' namespace, typically, using webpack's built-in "DefinePlugin" plugin. e.g:
+```js
+const ExtractCssChunks = require('extract-css-chunks-webpack-plugin');
-```javascript
-new webpack.DefinePlugin( {
- 'process.env': {
- NODE_ENV: `"${config.devMode ? 'development' : 'production'}"`,
+module.exports = {
+ plugins: [
+ new ExtractCssChunks({
+ // Options similar to the same options in webpackOptions.output
+ // both options are optional
+ filename: '[name].css',
+ chunkFilename: '[id].css',
+ }),
+ ],
+ module: {
+ rules: [
+ {
+ test: /\.css$/,
+ use: [
+ {
+ loader: ExtractCssChunks.loader,
+ options: {
+ // only enable hot in development
+ hmr: process.env.NODE_ENV === 'development',
+ // if hmr does not work, this is a forceful method.
+ reloadAll: true,
+ },
+ },
+ 'css-loader',
+ ],
},
-} )
+ ],
+ },
+};
```
-The value set by the aformentioned plugin will only be available in the runtime ( when webpack's javascript output is excuted ).
-In order for this plugin to work with hot module reloading, The npm script / gulp task / grunt task etc, should be invoked with the same environment variable as shown above.
-For example, when running the build using some form of npm script:
+### Minimizing For Production
-```json
-{
- "scripts": {
- "build": "cross-env NODE_ENV=development webpack --config build/webpack.config.js"
- }
-}
+To minify the output, use a plugin like [optimize-css-assets-webpack-plugin](https://github.com/NMFR/optimize-css-assets-webpack-plugin).
+Setting `optimization.minimizer` overrides the defaults provided by webpack, so make sure to also specify a JS minimizer:
+
+**webpack.config.js**
+
+```js
+const TerserJSPlugin = require('terser-webpack-plugin');
+const ExtractCssChunks = require('extract-css-chunks-webpack-plugin');
+const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
+
+module.exports = {
+ optimization: {
+ minimizer: [new TerserJSPlugin({}), new OptimizeCSSAssetsPlugin({})],
+ },
+ plugins: [
+ new ExtractCssChunks({
+ filename: '[name].css',
+ chunkFilename: '[id].css',
+ }),
+ ],
+ module: {
+ rules: [
+ {
+ test: /\.css$/,
+ use: [ExtractCssChunks.loader, 'css-loader'],
+ },
+ ],
+ },
+};
```
-[cross-env](https://www.npmjs.com/package/cross-env) is optional but recommended.
-## What about Glamorous, Styled Components, Styled-Jsx, Aphrodite, etc?
+### Using preloaded or inlined CSS
+
+The runtime code detects already added CSS via `` or `
+
+
+
+
+
+ Initial CSS: Must be green
+
+
+
+ Hot Module Replacement
+RED
+ GREEN
+ BLUE
+
+
+ Hot Module Replacement + CSS modules
+RED
+ GREEN
+ BLUE
+
+
+ + Lazy CSS: Must be red, but turn green when + . +
++ But turn orange, when + . Additional + clicks have no effect. +
++ Refresh and press buttons in reverse order: This should turn green + instead. +
+
+
+ + Lazy CSS: Turn off the network and + . +
+An error should have appeared.
++ Now if you turn the network back on and click it again, it should turn + aqua. +
+
+
+ Preloaded CSS: Must be green.
++ displays + an alert and should turn red. +
+
+
+ Preloaded inlined CSS: Must be green.
++ displays + an alert and should turn red. +
+
+
+
+
+
+ zack
+CrossOriginLoading Option: Must be red.
++ loads chunks with crossorigin + attribute and should turn green. +
+