css-loader 2.0.1 → 3.0.0

package/README.md

@@ -19,10 +19,6 @@
 
 The `css-loader` interprets `@import` and `url()` like `import/require()` and will resolve them.
 
-## Requirements
-
-This module requires a minimum of Node v6.9.0 and Webpack v4.0.0.
-
 ## Getting Started
 
 To begin, you'll need to install `css-loader`:
@@ -46,7 +42,7 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         use: ['style-loader', 'css-loader'],
       },
     ],
@@ -69,7 +65,7 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         use: ['to-string-loader', 'css-loader'],
       },
     ],
@@ -99,7 +95,7 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         use: [
           'handlebars-loader', // handlebars loader expects raw resource string
           'extract-loader',
@@ -113,23 +109,22 @@ module.exports = {
 
 ## Options
 
-|                    Name                     |         Type          |     Default     | Description                                 |
-| :-----------------------------------------: | :-------------------: | :-------------: | :------------------------------------------ |
-|              **[`url`](#url)**              | `{Boolean\|Function}` |     `true`      | Enable/Disable `url()` handling             |
-|           **[`import`](#import)**           | `{Boolean\/Function}` |     `true`      | Enable/Disable @import handling             |
-|          **[`modules`](#modules)**          |  `{Boolean\|String}`  |     `false`     | Enable/Disable CSS Modules and setup mode   |
-|   **[`localIdentName`](#localidentname)**   |      `{String}`       | `[hash:base64]` | Configure the generated ident               |
-|        **[`sourceMap`](#sourcemap)**        |      `{Boolean}`      |     `false`     | Enable/Disable Sourcemaps                   |
-|        **[`camelCase`](#camelcase)**        |  `{Boolean\|String}`  |     `false`     | Export Classnames in CamelCase              |
-|    **[`importLoaders`](#importloaders)**    |      `{Number}`       |       `0`       | Number of loaders applied before CSS loader |
-| **[`exportOnlyLocals`](#exportonlylocals)** |      `{Boolean}`      |     `false`     | Export only locals                          |
+|                    Name                     |            Type             | Default | Description                                        |
+| :-----------------------------------------: | :-------------------------: | :-----: | :------------------------------------------------- |
+|              **[`url`](#url)**              |    `{Boolean\|Function}`    | `true`  | Enable/Disable `url()` handling                    |
+|           **[`import`](#import)**           |    `{Boolean\|Function}`    | `true`  | Enable/Disable @import handling                    |
+|          **[`modules`](#modules)**          | `{Boolean\|String\|Object}` | `false` | Enable/Disable CSS Modules and setup their options |
+|        **[`sourceMap`](#sourcemap)**        |         `{Boolean}`         | `false` | Enable/Disable Sourcemaps                          |
+|    **[`importLoaders`](#importloaders)**    |         `{Number}`          |   `0`   | Number of loaders applied before CSS loader        |
+| **[`localsConvention`](#localsconvention)** |         `{String}`          | `asIs`  | Setup style of exported classnames                 |
+|       **[`onlyLocals`](#onlylocals)**       |         `{Boolean}`         | `false` | Export only locals                                 |
 
 ### `url`
 
 Type: `Boolean|Function`
 Default: `true`
 
-Control `url()` resolving. Absolute urls are not resolving.
+Control `url()` resolving. Absolute URLs and root-relative URLs are not resolving.
 
 Examples resolutions:
 
@@ -161,7 +156,7 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
           url: true,
@@ -183,14 +178,18 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
           url: (url, resourcePath) => {
             // resourcePath - path to css file
 
-            // `url()` with `img.png` stay untouched
-            return url.includes('img.png');
+            // Don't handle `img.png` urls
+            if (url.includes('img.png')) {
+              return false;
+            }
+
+            return true;
           },
         },
       },
@@ -237,7 +236,7 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
           import: true,
@@ -259,7 +258,7 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
           import: (parsedImport, resourcePath) => {
@@ -267,8 +266,12 @@ module.exports = {
             // parsedImport.media - media query of `@import`
             // resourcePath - path to css file
 
-            // `@import` with `style.css` stay untouched
-            return parsedImport.url.includes('style.css');
+            // Don't handle `style.css` import
+            if (parsedImport.url.includes('style.css')) {
+              return false;
+            }
+
+            return true;
           },
         },
       },
@@ -277,24 +280,15 @@ module.exports = {
 };
 ```
 
-### [`modules`](https://github.com/css-modules/css-modules)
+### `modules`
 
-Type: `Boolean|String`
+Type: `Boolean|String|Object`
 Default: `false`
 
-The `modules` option enables/disables the **CSS Modules** spec and setup basic behaviour.
-
-|      Name      |    Type     | Description                                                                                                                      |
-| :------------: | :---------: | :------------------------------------------------------------------------------------------------------------------------------- |
-|   **`true`**   | `{Boolean}` | Enables local scoped CSS by default (use **local** mode by default)                                                              |
-|  **`false`**   | `{Boolean}` | Disable the **CSS Modules** spec, all **CSS Modules** features (like `@value`, `:local`, `:global` and `composes`) will not work |
-| **`'local'`**  | `{String}`  | Enables local scoped CSS by default (same as `true` value)                                                                       |
-| **`'global'`** | `{String}`  | Enables global scoped CSS by default                                                                                             |
+The `modules` option enables/disables the **[CSS Modules](https://github.com/css-modules/css-modules)** specification and setup basic behaviour.
 
 Using `false` value increase performance because we avoid parsing **CSS Modules** features, it will be useful for developers who use vanilla css or use other technologies.
 
-You can read about **modes** below.
-
 **webpack.config.js**
 
 ```js
@@ -302,7 +296,7 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
           modules: true,
@@ -313,6 +307,8 @@ module.exports = {
 };
 ```
 
+#### `Features`
+
 ##### `Scope`
 
 Using `local` value requires you to specify `:global` classes.
@@ -325,7 +321,7 @@ Styles can be locally scoped to avoid globally scoping styles.
 The syntax `:local(.className)` can be used to declare `className` in the local scope. The local identifiers are exported by the module.
 
 With `:local` (without brackets) local mode can be switched on for this selector.
-The `:global(.className)` nocation can be used to declare an explicit global selector.
+The `:global(.className)` notation can be used to declare an explicit global selector.
 With `:global` (without brackets) global mode can be switched on for this selector.
 
 The loader replaces local selectors with unique identifiers. The chosen unique identifiers are exported by the module.
@@ -438,13 +434,36 @@ To import from multiple modules use multiple `composes:` rules.
 }
 ```
 
-### `localIdentName`
+##### `Values`
 
-Type: `String`
-Default: `[hash:base64]`
+You can use `@value` to specific values to be reused throughout a document.
 
-You can configure the generated ident with the `localIdentName` query parameter.
-See [loader-utils's documentation](https://github.com/webpack/loader-utils#interpolatename) for more information on options.
+We recommend use prefix `v-` for values, `s-` for selectors and `m-` for media at-rules.
+
+```css
+@value v-primary: #BF4040;
+@value s-black: black-selector;
+@value m-large: (min-width: 960px);
+
+.header {
+  color: v-primary;
+  padding: 0 10px;
+}
+
+.s-black {
+  color: black;
+}
+
+@media m-large {
+  .header {
+    padding: 0 20px;
+  }
+}
+```
+
+#### `Boolean`
+
+Enable **CSS Modules** features.
 
 **webpack.config.js**
 
@@ -453,11 +472,10 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
           modules: true,
-          localIdentName: '[path][name]__[local]--[hash:base64:5]',
         },
       },
     ],
@@ -465,7 +483,9 @@ module.exports = {
 };
 ```
 
-You can also specify the absolute path to your custom `getLocalIdent` function to generate classname based on a different schema.
+#### `String`
+
+Enable **CSS Modules** features and setup `mode`.
 
 **webpack.config.js**
 
@@ -474,15 +494,37 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
-          modules: true,
-          context: path.resolve(__dirname, 'context'), // Allow to redefine basic loader context for `local-ident-name`
-          hashPrefix: 'hash', // Allow to add custom hash to generate more unique classes
-          localIdentName: '[path][name]__[local]--[hash:base64:5]',
-          getLocalIdent: (context, localIdentName, localName, options) => {
-            return 'whatever_random_class_name';
+          // Using `local` value has same effect like using `modules: true`
+          modules: 'global',
+        },
+      },
+    ],
+  },
+};
+```
+
+#### `Object`
+
+Enable **CSS Modules** features and setup options for them.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: 'css-loader',
+        options: {
+          modules: {
+            mode: 'local',
+            localIdentName: '[path][name]__[local]--[hash:base64:5]',
+            context: path.resolve(__dirname, 'src'),
+            hashPrefix: 'my-custom-hash',
           },
         },
       },
@@ -491,16 +533,40 @@ module.exports = {
 };
 ```
 
-### `sourceMap`
+##### `mode`
 
-Type: `Boolean`
-Default: `true`
+Type: `String`
+Default: `local`
 
-To include source maps set the `sourceMap` option.
+Setup `mode` option. You can omit the value when you want `local` mode.
 
-I.e. the `mini-css-extract-plugin` can handle them.
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: 'css-loader',
+        options: {
+          modules: {
+            mode: 'global',
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `localIdentName`
 
-They are not enabled by default because they expose a runtime overhead and increase in bundle size (JS source maps do not). In addition to that relative paths are buggy and you need to use an absolute public path which includes the server URL.
+Type: `String`
+Default: `[hash:base64]`
+
+You can configure the generated ident with the `localIdentName` query parameter.
+See [loader-utils's documentation](https://github.com/webpack/loader-utils#interpolatename) for more information on options.
 
 **webpack.config.js**
 
@@ -509,10 +575,12 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
-          sourceMap: true,
+          modules: {
+            localIdentName: '[path][name]__[local]--[hash:base64:5]',
+          },
         },
       },
     ],
@@ -520,34 +588,96 @@ module.exports = {
 };
 ```
 
-### `camelCase`
+##### `context`
 
-Type: `Boolean|String`
-Default: `false`
+Type: `String`
+Default: `undefined`
 
-By default, the exported JSON keys mirror the class names. If you want to camelize class names (useful in JS), pass the query parameter `camelCase` to css-loader.
+Allow to redefine basic loader context for local ident name.
+By default we use `rootContext` of loader.
 
-|        Name        |    Type     | Description                                                                                                              |
-| :----------------: | :---------: | :----------------------------------------------------------------------------------------------------------------------- |
-|    **`false`**     | `{Boolean}` | Class names will be camelized, the original class name will not to be removed from the locals                            |
-|     **`true`**     | `{Boolean}` | Class names will be camelized                                                                                            |
-|   **`'dashes'`**   | `{String}`  | Only dashes in class names will be camelized                                                                             |
-|    **`'only'`**    | `{String}`  | Introduced in `0.27.1`. Class names will be camelized, the original class name will be removed from the locals           |
-| **`'dashesOnly'`** | `{String}`  | Introduced in `0.27.1`. Dashes in class names will be camelized, the original class name will be removed from the locals |
+**webpack.config.js**
 
-**file.css**
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: 'css-loader',
+        options: {
+          modules: {
+            context: path.resolve(__dirname, 'context'),
+          },
+        },
+      },
+    ],
+  },
+};
+```
 
-```css
-.class-name {
-}
+##### `hashPrefix`
+
+Type: `String`
+Default: `undefined`
+
+Allow to add custom hash to generate more unique classes.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: 'css-loader',
+        options: {
+          modules: {
+            hashPrefix: 'hash',
+          },
+        },
+      },
+    ],
+  },
+};
 ```
 
-**file.js**
+##### `getLocalIdent`
+
+Type: `Function`
+Default: `undefined`
+
+You can also specify the absolute path to your custom `getLocalIdent` function to generate classname based on a different schema.
+By default we use built-in function to generate a classname.
+
+**webpack.config.js**
 
 ```js
-import { className } from 'file.css';
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: 'css-loader',
+        options: {
+          modules: {
+            getLocalIdent: (context, localIdentName, localName, options) => {
+              return 'whatever_random_class_name';
+            },
+          },
+        },
+      },
+    ],
+  },
+};
 ```
 
+##### `localIdentRegExp`
+
+Type: `String|RegExp`
+Default: `undefined`
+
 **webpack.config.js**
 
 ```js
@@ -555,10 +685,43 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
-          camelCase: true,
+          modules: {
+            localIdentRegExp: /page-(.*)\.css/i,
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+### `sourceMap`
+
+Type: `Boolean`
+Default: `false`
+
+To include source maps set the `sourceMap` option.
+
+I.e. the `mini-css-extract-plugin` can handle them.
+
+They are not enabled by default because they expose a runtime overhead and increase in bundle size (JS source maps do not).
+
+In addition to that relative paths are buggy and you need to use an absolute public path which includes the server URL.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: 'css-loader',
+        options: {
+          sourceMap: true,
         },
       },
     ],
@@ -580,7 +743,7 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         use: [
           'style-loader',
           {
@@ -600,7 +763,53 @@ module.exports = {
 
 This may change in the future when the module system (i. e. webpack) supports loader matching by origin.
 
-### `exportOnlyLocals`
+### `localsConvention`
+
+Type: `String`
+Default: `undefined`
+
+By default, the exported JSON keys mirror the class names (i.e `asIs` value).
+
+|         Name          |    Type    | Description                                                                                      |
+| :-------------------: | :--------: | :----------------------------------------------------------------------------------------------- |
+|     **`'asIs'`**      | `{String}` | Class names will be exported as is.                                                              |
+|   **`'camelCase'`**   | `{String}` | Class names will be camelized, the original class name will not to be removed from the locals    |
+| **`'camelCaseOnly'`** | `{String}` | Class names will be camelized, the original class name will be removed from the locals           |
+|    **`'dashes'`**     | `{String}` | Only dashes in class names will be camelized                                                     |
+|  **`'dashesOnly'`**   | `{String}` | Dashes in class names will be camelized, the original class name will be removed from the locals |
+
+**file.css**
+
+```css
+.class-name {
+}
+```
+
+**file.js**
+
+```js
+import { className } from 'file.css';
+```
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: 'css-loader',
+        options: {
+          localsConvention: 'camelCase',
+        },
+      },
+    ],
+  },
+};
+```
+
+### `onlyLocals`
 
 Type: `Boolean`
 Default: `false`
@@ -616,10 +825,10 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         loader: 'css-loader',
         options: {
-          exportOnlyLocals: true,
+          onlyLocals: true,
         },
       },
     ],
@@ -640,14 +849,14 @@ module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
+        test: /\.css$/i,
         use: ['style-loader', 'css-loader'],
       },
       {
-        test: /\.(png|jpg|gif|svg|eot|ttf|woff|woff2)$/,
+        test: /\.(png|jpe?g|gif|svg|eot|ttf|woff|woff2)$/,
         loader: 'url-loader',
         options: {
-          limit: 10000,
+          limit: 8192,
         },
       },
     ],
@@ -658,7 +867,10 @@ module.exports = {
 ### Extract
 
 For production builds it's recommended to extract the CSS from your bundle being able to use parallel loading of CSS/JS resources later on.
-This can be achieved by using the [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) to extract the CSS when running in production mode.
+
+- This can be achieved by using the [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) to extract the CSS when running in production mode.
+
+- As an alternative, if seeking better development performance and css outputs that mimic production. [extract-css-chunks-webpack-plugin](https://github.com/faceyspacey/extract-css-chunks-webpack-plugin) offers a hot module reload friendly, extended version of mini-css-extract-plugin. HMR real CSS files in dev, works like mini-css in non-dev
 
 ## Contributing
 
@@ -672,21 +884,15 @@ Please take a moment to read our contributing guidelines if you haven't yet done
 
 [npm]: https://img.shields.io/npm/v/css-loader.svg
 [npm-url]: https://npmjs.com/package/css-loader
-
 [node]: https://img.shields.io/node/v/css-loader.svg
 [node-url]: https://nodejs.org
-
 [deps]: https://david-dm.org/webpack-contrib/css-loader.svg
 [deps-url]: https://david-dm.org/webpack-contrib/css-loader
-
-[tests]: https://img.shields.io/circleci/project/github/webpack-contrib/css-loader.svg
-[tests-url]: https://circleci.com/gh/webpack-contrib/css-loader
-
+[tests]: https://dev.azure.com/webpack-contrib/css-loader/_apis/build/status/webpack-contrib.css-loader?branchName=master
+[tests-url]: https://dev.azure.com/webpack-contrib/css-loader/_build/latest?definitionId=2&branchName=master
 [cover]: https://codecov.io/gh/webpack-contrib/css-loader/branch/master/graph/badge.svg
 [cover-url]: https://codecov.io/gh/webpack-contrib/css-loader
-
 [chat]: https://badges.gitter.im/webpack/webpack.svg
 [chat-url]: https://gitter.im/webpack/webpack
-
 [size]: https://packagephobia.now.sh/badge?p=css-loader
 [size-url]: https://packagephobia.now.sh/result?p=css-loader