css-loader 1.0.1 → 7.1.4

package/README.md

@@ -1,10 +1,3 @@
-[![npm][npm]][npm-url]
-[![node][node]][node-url]
-[![deps][deps]][deps-url]
-[![tests][tests]][tests-url]
-[![coverage][cover]][cover-url]
-[![chat][chat]][chat-url]
-
 <div align="center">
   <img width="180" height="180" vspace="20"
     src="https://cdn.worldvectorlogo.com/logos/css-3.svg">
@@ -12,170 +5,453 @@
     <img width="200" height="200"
       src="https://webpack.js.org/assets/icon-square-big.svg">
   </a>
-  <h1>CSS Loader</h1>
 </div>
 
-<h2 align="center">Install</h2>
+[![npm][npm]][npm-url]
+[![node][node]][node-url]
+[![tests][tests]][tests-url]
+[![coverage][cover]][cover-url]
+[![discussion][discussion]][discussion-url]
+[![size][size]][size-url]
+
+# css-loader
+
+The `css-loader` interprets `@import` and `url()` like `import/require()` and resolves them.
+
+## Getting Started
 
-```bash
+> [!WARNING]
+>
+> To use the latest version of css-loader, webpack@5 is required
+
+To begin, you'll need to install `css-loader`:
+
+```console
 npm install --save-dev css-loader
 ```
 
-<h2 align="center">Usage</h2>
+or
+
+```console
+yarn add -D css-loader
+```
+
+or
 
-The `css-loader` interprets `@import` and `url()` like `import/require()`
-and will resolve them.
+```console
+pnpm add -D css-loader
+```
 
-Good loaders for requiring your assets are the [file-loader](https://github.com/webpack/file-loader)
-and the [url-loader](https://github.com/webpack/url-loader) which you should specify in your config (see [below](https://github.com/webpack-contrib/css-loader#assets)).
+Then, add the loader to your `webpack` configuration. For example:
 
 **file.js**
+
 ```js
-import css from 'file.css';
+import * as css from "file.css";
 ```
 
 **webpack.config.js**
+
 ```js
 module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
-        use: [ 'style-loader', 'css-loader' ]
-      }
-    ]
-  }
-}
+        test: /\.css$/i,
+        use: ["style-loader", "css-loader"],
+      },
+    ],
+  },
+};
 ```
 
-### `toString`
+Finally, run `webpack` using the method you normally use (e.g., via CLI or an npm script).
 
-You can also use the css-loader results directly as a string, such as in Angular's component style.
+If you need to extract CSS into a separate file (i.e. do not store CSS in a JS module), consider using the [recommend example](https://github.com/webpack/css-loader#recommend).
+
+## Options
+
+- **[`url`](#url)**
+- **[`import`](#import)**
+- **[`modules`](#modules)**
+- **[`sourceMap`](#sourcemap)**
+- **[`importLoaders`](#importloaders)**
+- **[`esModule`](#esmodule)**
+- **[`exportType`](#exporttype)**
+
+### `url`
+
+Type:
+
+```ts
+type url =
+  | boolean
+  | {
+      filter: (url: string, resourcePath: string) => boolean;
+    };
+```
+
+Default: `true`
+
+Enables or disables handling the CSS functions `url` and `image-set`.
+
+- If set to `false`, `css-loader` will not parse any paths specified in `url` or `image-set`.
+- You can also pass a function to control this behavior dynamically based on the asset path.
+
+As of version [4.0.0](https://github.com/webpack/css-loader/main/CHANGELOG.md#400-2020-07-25), absolute paths are resolved based on the server root.
+
+Examples resolutions:
 
-**webpack.config.js**
 ```js
-{
-   test: /\.css$/,
-   use: [
-     'to-string-loader',
-     'css-loader'
-   ]
-}
+url(image.png) => require('./image.png')
+url('image.png') => require('./image.png')
+url(./image.png) => require('./image.png')
+url('./image.png') => require('./image.png')
+url('http://dontwritehorriblecode.com/2112.png') => require('http://dontwritehorriblecode.com/2112.png')
+image-set(url('image2x.png') 1x, url('image1x.png') 2x) => require('./image1x.png') and require('./image2x.png')
 ```
 
-or
+To import assets from a `node_modules` path (including `resolve.modules`) or an `alias`, prefix it with a `~`:
 
 ```js
-const css = require('./test.css').toString();
+url(~module/image.png) => require('module/image.png')
+url('~module/image.png') => require('module/image.png')
+url(~aliasDirectory/image.png) => require('otherDirectory/image.png')
+```
+
+#### `boolean`
+
+Enable/disable `url()` resolving.
+
+**webpack.config.js**
 
-console.log(css); // {String}
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          url: true,
+        },
+      },
+    ],
+  },
+};
 ```
 
-If there are SourceMaps, they will also be included in the result string.
+#### `object`
 
-If, for one reason or another, you need to extract CSS as a
-plain string resource (i.e. not wrapped in a JS module) you
-might want to check out the [extract-loader](https://github.com/peerigon/extract-loader).
-It's useful when you, for instance, need to post process the CSS as a string.
+Allows filtering of `url()` values.
+
+Any filtered `url()` will not be resolved (left in the code as they were written).
 
 **webpack.config.js**
+
 ```js
-{
-   test: /\.css$/,
-   use: [
-     'handlebars-loader', // handlebars loader expects raw resource string
-     'extract-loader',
-     'css-loader'
-   ]
-}
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          url: {
+            filter: (url, resourcePath) => {
+              // resourcePath - path to css file
+
+              // Don't handle `img.png` urls
+              if (url.includes("img.png")) {
+                return false;
+              }
+
+              // Don't handle images under root-relative /external_images/
+              if (/^\/external_images\//.test(url)) {
+                return false;
+              }
+
+              return true;
+            },
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+### `import`
+
+Type:
+
+<!-- use other name to prettify since import is reserved keyword -->
+
+```ts
+type importFn =
+  | boolean
+  | {
+      filter: (
+        url: string,
+        media: string,
+        resourcePath: string,
+        supports?: string,
+        layer?: string,
+      ) => boolean;
+    };
 ```
 
-<h2 align="center">Options</h2>
+Default: `true`
 
-|Name|Type|Default|Description|
-|:--:|:--:|:-----:|:----------|
-|**[`url`](#url)**|`{Boolean}`|`true`| Enable/Disable `url()` handling|
-|**[`import`](#import)** |`{Boolean}`|`true`| Enable/Disable @import handling|
-|**[`modules`](#modules)**|`{Boolean}`|`false`|Enable/Disable CSS Modules|
-|**[`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|
+Allows you to enable or disable handling of `@import` at-rules.
 
-### `url`
+Controls how `@import` statements are resolved.
 
-To disable `url()` resolving by `css-loader` set the option to `false`.
+Absolute URLs in `@import` will be moved in runtime code.
 
-To be compatible with existing css files (if not in CSS Module mode).
+Examples resolutions:
 
 ```
-url(image.png) => require('./image.png')
-url(~module/image.png) => require('module/image.png')
+@import 'style.css' => require('./style.css')
+@import url(style.css) => require('./style.css')
+@import url('style.css') => require('./style.css')
+@import './style.css' => require('./style.css')
+@import url(./style.css) => require('./style.css')
+@import url('./style.css') => require('./style.css')
+@import url('http://dontwritehorriblecode.com/style.css') => @import url('http://dontwritehorriblecode.com/style.css') in runtime
 ```
 
-### `import`
-
-To disable `@import` resolving by `css-loader` set the option to `false`
+To import styles from a `node_modules` path (include `resolve.modules`) or an `alias`, prefix it with a `~`:
 
-```css
-@import url('https://fonts.googleapis.com/css?family=Roboto');
 ```
+@import url(~module/style.css) => require('module/style.css')
+@import url('~module/style.css') => require('module/style.css')
+@import url(~aliasDirectory/style.css) => require('otherDirectory/style.css')
+```
+
+#### `boolean`
+
+Enable/disable `@import` resolving.
+
+**webpack.config.js**
 
-> _⚠️ Use with caution, since this disables resolving for **all** `@import`s, including css modules `composes: xxx from 'path/to/file.css'` feature._
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          import: true,
+        },
+      },
+    ],
+  },
+};
+```
 
-### [`modules`](https://github.com/css-modules/css-modules)
+#### `object`
 
-The query parameter `modules` enables the **CSS Modules** spec.
+##### `filter`
 
-This enables local scoped CSS by default. (You can switch it off with `:global(...)` or `:global` for selectors and/or rules.).
+Type:
 
-#### `Scope`
+```ts
+type filter = (url: string, media: string, resourcePath: string) => boolean;
+```
 
-By default CSS exports all classnames into a global selector scope. Styles can be locally scoped to avoid globally scoping styles.
+Default: `undefined`
 
-The syntax `:local(.className)` can be used to declare `className` in the local scope. The local identifiers are exported by the module.
+Allows filtering of `@import`.
 
-With `:local` (without brackets) local mode can be switched on for this selector. `:global(.className)` can be used to declare an explicit global selector. With `:global` (without brackets) global mode can be switched on for this selector.
+Any filtered `@import` will not be resolved (left in the code as they were written).
 
-The loader replaces local selectors with unique identifiers. The chosen unique identifiers are exported by the module.
+**webpack.config.js**
 
-```css
-:local(.className) { background: red; }
-:local .className { color: green; }
-:local(.className .subClass) { color: green; }
-:local .className .subClass :global(.global-class-name) { color: blue; }
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          import: {
+            filter: (url, media, resourcePath) => {
+              // resourcePath - path to css file
+
+              // Don't handle `style.css` import
+              if (url.includes("style.css")) {
+                return false;
+              }
+
+              return true;
+            },
+          },
+        },
+      },
+    ],
+  },
+};
 ```
 
-```css
-._23_aKvs-b8bW2Vg3fwHozO { background: red; }
-._23_aKvs-b8bW2Vg3fwHozO { color: green; }
-._23_aKvs-b8bW2Vg3fwHozO ._13LGdX8RMStbBE9w-t0gZ1 { color: green; }
-._23_aKvs-b8bW2Vg3fwHozO ._13LGdX8RMStbBE9w-t0gZ1 .global-class-name { color: blue; }
+### `modules`
+
+Type:
+
+```ts
+type modules =
+  | boolean
+  | "local"
+  | "global"
+  | "pure"
+  | "icss"
+  | {
+      auto: boolean | regExp | ((resourcePath: string) => boolean);
+      mode:
+        | "local"
+        | "global"
+        | "pure"
+        | "icss"
+        | ((resourcePath) => "local" | "global" | "pure" | "icss");
+      localIdentName: string;
+      localIdentContext: string;
+      localIdentHashSalt: string;
+      localIdentHashFunction: string;
+      localIdentHashDigest: string;
+      localIdentRegExp: string | regExp;
+      getLocalIdent: (
+        context: LoaderContext,
+        localIdentName: string,
+        localName: string,
+      ) => string;
+      namedExport: boolean;
+      exportGlobals: boolean;
+      exportLocalsConvention:
+        | "as-is"
+        | "camel-case"
+        | "camel-case-only"
+        | "dashes"
+        | "dashes-only"
+        | ((name: string) => string);
+      exportOnlyLocals: boolean;
+      getJSON: ({
+        resourcePath,
+        imports,
+        exports,
+        replacements,
+      }: {
+        resourcePath: string;
+        imports: object[];
+        exports: object[];
+        replacements: object[];
+      }) => Promise<void> | void;
+    };
 ```
 
-> ℹ️ Identifiers are exported
+Default: `undefined`
+
+Allows you to enable or disable CSS Modules or ICSS and configure them:
+
+- `undefined`: Enables CSS modules for all files matching `/\.module\.\w+$/i.test(filename)` or `/\.icss\.\w+$/i.test(filename)` regexp.
+- `true`: Enables CSS modules for all files.
+- `false`: Disables CSS Modules for all files.
+- `string`: Disables CSS Modules for all files and set the `mode` option (see [mode](https://github.com/webpack/css-loader#mode) for details).
+- `object`: Enables CSS modules for all files unless the `modules.auto` option is provided. otherwise the `modules.auto` option will determine whether if it is CSS Modules or not (see [auto](https://github.com/webpack/css-loader#auto) for more details).
+
+The `modules` option enables/disables the **[CSS Modules](https://github.com/css-modules/css-modules)** specification and configures its behavior.
+
+Setting `modules: false` can improve performance because we avoid parsing **CSS Modules** features, this is useful for developers using use vanilla CSS or other technologies.
+
+**webpack.config.js**
 
 ```js
-exports.locals = {
-  className: '_23_aKvs-b8bW2Vg3fwHozO',
-  subClass: '_13LGdX8RMStbBE9w-t0gZ1'
-}
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: true,
+        },
+      },
+    ],
+  },
+};
 ```
 
-CamelCase is recommended for local selectors. They are easier to use within the imported JS module.
+#### `Features`
+
+##### `Scope`
+
+- Using `local` value requires you to specify `:global` classes.
+- Using `global` value requires you to specify `:local` classes.
+- Using `pure` value requires selectors must contain at least one local class or ID.
+
+You can find more information on scoping module [here](https://github.com/css-modules/css-modules).
+
+With CSS Modules, styles are scoped locally, preventing conflicts with global styles.
+
+Use `:local(.className)` to declare a `className` in the local scope. The local identifiers are exported by the module.
+
+- With `:local` (without parentheses) local mode can be switched `on` for this selector.
+- The `:global(.className)` notation can be used to declare an explicit global selector.
+- With `:global` (without parentheses) global mode can be switched `on` for this selector.
+
+The loader replaces local selectors with unique, scoped identifiers. The chosen unique identifiers are exported by the module.
+
+```css
+:local(.className) {
+  background: red;
+}
+:local .className {
+  color: green;
+}
+:local(.className .subClass) {
+  color: green;
+}
+:local .className .subClass :global(.global-class-name) {
+  color: blue;
+}
+```
 
-`url()` URLs in block scoped (`:local .abc`) rules behave like requests in modules.
+Output (example):
 
+```css
+._23_aKvs-b8bW2Vg3fwHozO {
+  background: red;
+}
+._23_aKvs-b8bW2Vg3fwHozO {
+  color: green;
+}
+._23_aKvs-b8bW2Vg3fwHozO ._13LGdX8RMStbBE9w-t0gZ1 {
+  color: green;
+}
+._23_aKvs-b8bW2Vg3fwHozO ._13LGdX8RMStbBE9w-t0gZ1 .global-class-name {
+  color: blue;
+}
 ```
-file.png => ./file.png
-~module/file.png => module/file.png
+
+> [!NOTE]
+>
+> Identifiers are exported
+
+```js
+exports.locals = {
+  className: "_23_aKvs-b8bW2Vg3fwHozO",
+  subClass: "_13LGdX8RMStbBE9w-t0gZ1",
+};
 ```
 
-You can use `:local(#someId)`, but this is not recommended. Use classes instead of ids.
+CamelCase naming is recommended for local selectors, as it simplifies usage in imported JS modules.
 
-#### `Composing`
+Although you can use `:local(#someId)`, but this is not recommended. Prefer classes instead of IDs for modular styling.
 
-When declaring a local classname you can compose a local class from another local classname.
+##### `Composing`
+
+When declaring a local class name, you can compose it from one or more other local class names.
 
 ```css
 :local(.className) {
@@ -189,16 +465,16 @@ When declaring a local classname you can compose a local class from another loca
 }
 ```
 
-This doesn't result in any change to the CSS itself but exports multiple classnames.
+This does not alter the final CSS output, but the generated `subClass` will include both class names in its export.
 
 ```js
 exports.locals = {
-  className: '_23_aKvs-b8bW2Vg3fwHozO',
-  subClass: '_13LGdX8RMStbBE9w-t0gZ1 _23_aKvs-b8bW2Vg3fwHozO'
-}
+  className: "_23_aKvs-b8bW2Vg3fwHozO",
+  subClass: "_13LGdX8RMStbBE9w-t0gZ1 _23_aKvs-b8bW2Vg3fwHozO",
+};
 ```
 
-``` css
+```css
 ._23_aKvs-b8bW2Vg3fwHozO {
   background: red;
   color: yellow;
@@ -209,20 +485,24 @@ exports.locals = {
 }
 ```
 
-#### `Importing`
+##### `Importing`
+
+To import a local class names from another module.
 
-To import a local classname from another module.
+> [!NOTE]
+>
+> It is highly recommended to include file extensions when importing a file, since it is possible to import a file with any extension and it is not known in advance which file to use.
 
 ```css
 :local(.continueButton) {
-  composes: button from 'library/button.css';
+  composes: button from "library/button.css";
   background: red;
 }
 ```
 
 ```css
 :local(.nameEdit) {
-  composes: edit highlight from './edit.css';
+  composes: edit highlight from "./edit.css";
   background: red;
 }
 ```
@@ -231,224 +511,1854 @@ To import from multiple modules use multiple `composes:` rules.
 
 ```css
 :local(.className) {
-  composes: edit hightlight from './edit.css';
-  composes: button from 'module/button.css';
+  composes:
+    edit highlight from "./edit.css",
+    button from "module/button.css",
+    classFromThisModule;
+  background: red;
+}
+```
+
+or
+
+```css
+:local(.className) {
+  composes: edit highlight from "./edit.css";
+  composes: button from "module/button.css";
   composes: classFromThisModule;
   background: red;
 }
 ```
 
-### `localIdentName`
+##### `Values`
 
-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.
+You can use `@value` to specific values to be reused throughout a document.
 
- **webpack.config.js**
-```js
-{
-  test: /\.css$/,
-  use: [
-    {
-      loader: 'css-loader',
-      options: {
-        modules: true,
-        localIdentName: '[path][name]__[local]--[hash:base64:5]'
-      }
-    }
-  ]
+We recommend following a naming convention:
+
+- `v-` prefix for values
+- `s-` prefix for selectors
+- `m-` prefix 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;
 }
-```
 
-You can also specify the absolute path to your custom `getLocalIdent` function to generate classname based on a different schema. This requires `webpack >= 2.2.1` (it supports functions in the `options` object).
+.s-black {
+  color: black;
+}
 
-**webpack.config.js**
-```js
-{
-  loader: 'css-loader',
-  options: {
-    modules: true,
-    localIdentName: '[path][name]__[local]--[hash:base64:5]',
-    getLocalIdent: (context, localIdentName, localName, options) => {
-      return 'whatever_random_class_name'
-    }
+@media m-large {
+  .header {
+    padding: 0 20px;
   }
 }
 ```
 
-> ℹ️ For prerendering with extract-text-webpack-plugin you should use `css-loader/locals` instead of `style-loader!css-loader` **in the prerendering bundle**. It doesn't embed CSS but only exports the identifier mappings.
+#### `boolean`
 
-### `sourceMap`
+Enable **CSS Modules** features.
+
+**webpack.config.js**
 
-To include source maps set the `sourceMap` option.
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: true,
+        },
+      },
+    ],
+  },
+};
+```
 
-I.e. the extract-text-webpack-plugin can handle them.
+#### `string`
 
-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.
+Enable **CSS Modules** features and setup `mode`.
 
 **webpack.config.js**
+
 ```js
-{
-  loader: 'css-loader',
-  options: {
-    sourceMap: true
-  }
-}
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          // Using `local` value has same effect like using `modules: true`
+          modules: "global",
+        },
+      },
+    ],
+  },
+};
 ```
 
-### `camelCase`
+#### `object`
 
-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.
+Enable **CSS Modules** features and configure its behavior through `options`.
 
-|Name|Type|Description|
-|:--:|:--:|:----------|
-|**`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**
-```css
-.class-name {}
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            mode: "local",
+            auto: true,
+            exportGlobals: true,
+            localIdentName: "[path][name]__[local]--[hash:base64:5]",
+            localIdentContext: path.resolve(__dirname, "src"),
+            localIdentHashSalt: "my-custom-hash",
+            namedExport: true,
+            exportLocalsConvention: "as-is",
+            exportOnlyLocals: false,
+            getJSON: ({ resourcePath, imports, exports, replacements }) => {},
+          },
+        },
+      },
+    ],
+  },
+};
 ```
 
-**file.js**
-```js
-import { className } from 'file.css';
+##### `auto`
+
+Type:
+
+```ts
+type auto =
+  | boolean
+  | regExp
+  | ((
+      resourcePath: string,
+      resourceQuery: string,
+      resourceFragment: string,
+    ) => boolean);
 ```
 
+Default: `undefined`
+
+Allows auto enable CSS modules or ICSS based on the file name, query or fragment when `modules` option is an object.
+
+Possible values:
+
+- `undefined`: Enables CSS modules for all files.
+- `true`: Enables CSS modules for files matching `/\.module\.\w+$/i.test(filename)` and `/\.icss\.\w+$/i.test(filename)` regexp.
+- `false`: Disables CSS Modules for all files.
+- `RegExp`: Enables CSS modules for all files matching `/RegExp/i.test(filename)` regexp.
+- `function`: Enables CSS Modules for files based on the file name satisfying your filter function check.
+
+###### `boolean`
+
+Possible values:
+
+- `true`: Enables CSS modules or Interoperable CSS (ICSS) format, sets the [`modules.mode`](#mode) option to `local` value for all files which satisfy `/\.module(s)?\.\w+$/i.test(filename)` condition or sets the [`modules.mode`](#mode) option to `icss` value for all files which satisfy `/\.icss\.\w+$/i.test(filename)` condition.
+- `false`: Disables CSS modules or ICSS format based on filename for all files.
+
 **webpack.config.js**
+
 ```js
-{
-  loader: 'css-loader',
-  options: {
-    camelCase: true
-  }
-}
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            auto: true,
+          },
+        },
+      },
+    ],
+  },
+};
 ```
 
-### `importLoaders`
+###### `RegExp`
 
-The query parameter `importLoaders` allows you to configure how many loaders before `css-loader` should be applied to `@import`ed resources.
+Enables CSS modules for files based on the filename satisfying your regex check.
 
 **webpack.config.js**
+
 ```js
-{
-  test: /\.css$/,
-  use: [
-    'style-loader',
-    {
-      loader: 'css-loader',
-      options: {
-        importLoaders: 2 // 0 => no loaders (default); 1 => postcss-loader; 2 => postcss-loader, sass-loader
-      }
-    },
-    'postcss-loader',
-    'sass-loader'
-  ]
-}
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            auto: /\.custom-module\.\w+$/i,
+          },
+        },
+      },
+    ],
+  },
+};
 ```
 
-This may change in the future when the module system (i. e. webpack) supports loader matching by origin.
-
-<h2 align="center">Examples</h2>
-
-### Assets
+###### `function`
 
-The following `webpack.config.js` can load CSS files, embed small PNG/JPG/GIF/SVG images as well as fonts as [Data URLs](https://tools.ietf.org/html/rfc2397) and copy larger files to the output directory.
+Enables CSS Modules for files based on the filename, query or fragment satisfying your filter function check.
 
 **webpack.config.js**
+
 ```js
 module.exports = {
   module: {
     rules: [
       {
-        test: /\.css$/,
-        use: [ 'style-loader', 'css-loader' ]
-      },
-      {
-        test: /\.(png|jpg|gif|svg|eot|ttf|woff|woff2)$/,
-        loader: 'url-loader',
+        test: /\.css$/i,
+        loader: "css-loader",
         options: {
-          limit: 10000
-        }
-      }
-    ]
-  }
-}
+          modules: {
+            auto: (resourcePath, resourceQuery, resourceFragment) => {
+              return resourcePath.endsWith(".custom-module.css");
+            },
+          },
+        },
+      },
+    ],
+  },
+};
 ```
 
-### Extract
+##### `mode`
+
+Type:
+
+```ts
+type mode =
+  | "local"
+  | "global"
+  | "pure"
+  | "icss"
+  | ((
+      resourcePath: string,
+      resourceQuery: string,
+      resourceFragment: string,
+    ) => "local" | "global" | "pure" | "icss");
+```
 
-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.
-
-<h2 align="center">Maintainers</h2>
-
-<table>
-  <tbody>
-    <tr>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://github.com/bebraw.png?v=3&s=150">
-        </br>
-        <a href="https://github.com/bebraw">Juho Vepsäläinen</a>
-      </td>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://github.com/d3viant0ne.png?v=3&s=150">
-        </br>
-        <a href="https://github.com/d3viant0ne">Joshua Wiens</a>
-      </td>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://github.com/SpaceK33z.png?v=3&s=150">
-        </br>
-        <a href="https://github.com/SpaceK33z">Kees Kluskens</a>
-      </td>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://github.com/TheLarkInn.png?v=3&s=150">
-        </br>
-        <a href="https://github.com/TheLarkInn">Sean Larkin</a>
-      </td>
-    </tr>
-    <tr>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://github.com/michael-ciniawsky.png?v=3&s=150">
-        </br>
-        <a href="https://github.com/michael-ciniawsky">Michael Ciniawsky</a>
-      </td>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://github.com/evilebottnawi.png?v=3&s=150">
-        </br>
-        <a href="https://github.com/evilebottnawi">Evilebot Tnawi</a>
-      </td>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://github.com/joscha.png?v=3&s=150">
-        </br>
-        <a href="https://github.com/joscha">Joscha Feth</a>
-      </td>
-    </tr>
-  <tbody>
-</table>
+Default: `'local'`
 
+Setup `mode` option. You can omit the value when you want `local` mode.
 
-[npm]: https://img.shields.io/npm/v/css-loader.svg
-[npm-url]: https://npmjs.com/package/css-loader
+Controls the level of compilation applied to the input styles.
 
-[node]: https://img.shields.io/node/v/css-loader.svg
-[node-url]: https://nodejs.org
+- The `local`, `global`, and `pure` handles `class` and `id` scoping and `@value` values.
+- The `icss` will only compile the low level `Interoperable CSS (ICSS)` format for declaring `:import` and `:export` dependencies between CSS and other languages.
 
-[deps]: https://david-dm.org/webpack-contrib/css-loader.svg
-[deps-url]: https://david-dm.org/webpack-contrib/css-loader
+ICSS underpins CSS Module support, and provides a low level syntax for other tools to implement CSS-module variations of their own.
 
-[tests]: http://img.shields.io/travis/webpack-contrib/css-loader.svg
-[tests-url]: https://travis-ci.org/webpack-contrib/css-loader
+###### `string`
 
-[cover]: https://codecov.io/gh/webpack-contrib/css-loader/branch/master/graph/badge.svg
-[cover-url]: https://codecov.io/gh/webpack-contrib/css-loader
+Possible values - `local`, `global`, `pure`, and `icss`.
+
+**webpack.config.js**
 
-[chat]: https://badges.gitter.im/webpack/webpack.svg
-[chat-url]: https://gitter.im/webpack/webpack
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            mode: "global",
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+###### `function`
+
+Allows setting different values for the `mode` option based on the filename, query or fragment.
+Possible return values - `local`, `global`, `pure` and `icss`.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            // Callback must return "local", "global", or "pure" values
+            mode: (resourcePath, resourceQuery, resourceFragment) => {
+              if (/pure.css$/i.test(resourcePath)) {
+                return "pure";
+              }
+
+              if (/global.css$/i.test(resourcePath)) {
+                return "global";
+              }
+
+              return "local";
+            },
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `localIdentName`
+
+Type:
+
+```ts
+type localIdentName = string;
+```
+
+Default: `'[hash:base64]'`
+
+Allows to configure the generated local ident name.
+
+For more information on options see:
+
+- [webpack template strings](https://webpack.js.org/configuration/output/#template-strings),
+- [output.hashDigest](https://webpack.js.org/configuration/output/#outputhashdigest),
+- [output.hashDigestLength](https://webpack.js.org/configuration/output/#outputhashdigestlength),
+- [output.hashFunction](https://webpack.js.org/configuration/output/#outputhashfunction),
+- [output.hashSalt](https://webpack.js.org/configuration/output/#outputhashsalt).
+
+Supported template strings:
+
+- `[name]` the basename of the resource
+- `[folder]` the folder the resource relative to the `compiler.context` option or `modules.localIdentContext` option.
+- `[path]` the path of the resource relative to the `compiler.context` option or `modules.localIdentContext` option.
+- `[file]` - filename and path.
+- `[ext]` - extension with leading `.`.
+- `[hash]` - the hash of the string, generated based on `localIdentHashSalt`, `localIdentHashFunction`, `localIdentHashDigest`, `localIdentHashDigestLength`, `localIdentContext`, `resourcePath` and `exportName`
+- `[<hashFunction>:hash:<hashDigest>:<hashDigestLength>]` - hash with hash settings.
+- `[local]` - original class.
+
+Recommendations:
+
+- Use `'[path][name]__[local]'` for development
+- Use `'[hash:base64]'` for production
+
+The `[local]` placeholder contains original class.
+
+**Note:** all reserved characters (`<>:"/\|?*`) and control filesystem characters (excluding characters in the `[local]` placeholder) will be converted to `-`.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            localIdentName: "[path][name]__[local]--[hash:base64:5]",
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `localIdentContext`
+
+Type:
+
+```ts
+type localIdentContex = string;
+```
+
+Default: `compiler.context`
+
+Allows redefining the basic loader context for local ident name.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            localIdentContext: path.resolve(__dirname, "src"),
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `localIdentHashSalt`
+
+Type:
+
+```ts
+type localIdentHashSalt = string;
+```
+
+Default: `undefined`
+
+Allows to add custom hash to generate more unique classes.
+
+For more information see [output.hashSalt](https://webpack.js.org/configuration/output/#outputhashsalt).
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            localIdentHashSalt: "hash",
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `localIdentHashFunction`
+
+Type:
+
+```ts
+type localIdentHashFunction = string;
+```
+
+Default: `md4`
+
+Allows to specify hash function to generate classes .
+
+For more information see [output.hashFunction](https://webpack.js.org/configuration/output/#outputhashfunction).
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            localIdentHashFunction: "md4",
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `localIdentHashDigest`
+
+Type:
+
+```ts
+type localIdentHashDigest = string;
+```
+
+Default: `hex`
+
+Allows to specify hash digest to generate classes.
+
+For more information see [output.hashDigest](https://webpack.js.org/configuration/output/#outputhashdigest).
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            localIdentHashDigest: "base64",
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `localIdentHashDigestLength`
+
+Type:
+
+```ts
+type localIdentHashDigestLength = number;
+```
+
+Default: `20`
+
+Allows to specify hash digest length to generate classes.
+
+For more information, see [output.hashDigestLength](https://webpack.js.org/configuration/output/#outputhashdigestlength).
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            localIdentHashDigestLength: 5,
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `hashStrategy`
+
+Type: `'resource-path-and-local-name' | 'minimal-subset'`
+Default: `'resource-path-and-local-name'`
+
+Should local name be used when computing the hash.
+
+- `'resource-path-and-local-name'` Both resource path and local name are used when hashing. Each identifier in a module gets its own hash digest, always.
+- `'minimal-subset'` Auto detect if identifier names can be omitted from hashing. Use this value to optimize the output for better GZIP or Brotli compression.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            hashStrategy: "minimal-subset",
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `localIdentRegExp`
+
+Type:
+
+```ts
+type localIdentRegExp = string | RegExp;
+```
+
+Default: `undefined`
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            localIdentRegExp: /page-(.*)\.css/i,
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `getLocalIdent`
+
+Type:
+
+```ts
+type getLocalIdent = (
+  context: LoaderContext,
+  localIdentName: string,
+  localName: string,
+) => string;
+```
+
+Default: `undefined`
+
+Allows to specify a function to generate the classname.
+
+By default we use built-in function to generate a classname.
+
+If your custom function returns `null` or `undefined`, the built-in generator is used as a `fallback`.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            getLocalIdent: (context, localIdentName, localName, options) => {
+              return "whatever_random_class_name";
+            },
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `namedExport`
+
+Type:
+
+```ts
+type namedExport = boolean;
+```
+
+Default: Depends on the value of the `esModule` option. If the value of the `esModule` options is `true`, `namedExport` defaults to `true` ; otherwise, it defaults to `false`.
+
+Enables or disables ES modules named export for locals.
+
+> [!WARNING]
+>
+> The `default` class name cannot be used directly when `namedExport` is `true` because `default` is a reserved keyword in ECMAScript modules. It is automatically renamed to `_default`.
+
+**styles.css**
+
+```css
+.foo-baz {
+  color: red;
+}
+.bar {
+  color: blue;
+}
+.default {
+  color: green;
+}
+```
+
+**index.js**
+
+```js
+import * as styles from "./styles.css";
+
+// If using `exportLocalsConvention: "as-is"` (default value):
+console.log(styles["foo-baz"], styles.bar);
+
+// If using `exportLocalsConvention: "camel-case-only"`:
+console.log(styles.fooBaz, styles.bar);
+
+// For the `default` classname
+console.log(styles["_default"]);
+```
+
+You can enable ES module named export using:
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          esModule: true,
+          modules: {
+            namedExport: true,
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+To set a custom name for namedExport, can use [`exportLocalsConvention`](#exportLocalsConvention) option as a function.
+
+See below in the [`examples`](#examples) section.
+
+##### `exportGlobals`
+
+Type:
+
+```ts
+type exportsGLobals = boolean;
+```
+
+Default: `false`
+
+Allow `css-loader` to export names from global class or ID, so you can use that as local name.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            exportGlobals: true,
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `exportLocalsConvention`
+
+Type:
+
+```ts
+type exportLocalsConvention =
+  | "as-is"
+  | "camel-case"
+  | "camel-case-only"
+  | "dashes"
+  | "dashes-only"
+  | ((name: string) => string);
+```
+
+Default: Depends on the value of the `modules.namedExport` option:
+
+- If `true` - `as-is`
+- Otherwise `camel-case-only` (class names converted to camelCase, original name removed).
+
+> [!WARNING]
+>
+> Names of locals are converted to camelCase when the named export is `false`, i.e. the `exportLocalsConvention` option has`camelCaseOnly` value by default.
+> You can set this back to any other valid option but selectors which are not valid JavaScript identifiers may run into problems which do not implement the entire modules specification.
+
+Style of exported class names.
+
+###### `string`
+
+By default, the exported JSON keys mirror the class names (i.e `as-is` value).
+
+|          Name           |   Type   | Description                                                                                         |
+| :---------------------: | :------: | :-------------------------------------------------------------------------------------------------- |
+|      **`'as-is'`**      | `string` | Class names will be exported as is.                                                                 |
+|   **`'camel-case'`**    | `string` | Class names will be camelCased, but the original class name will not to be removed from the locals. |
+| **`'camel-case-only'`** | `string` | Class names will be camelCased, and original class name will be removed from the locals.            |
+|     **`'dashes'`**      | `string` | Only dashes in class names will be camelCased                                                       |
+|   **`'dashes-only'`**   | `string` | Dashes in class names will be camelCased, 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: {
+          modules: {
+            exportLocalsConvention: "camel-case-only",
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+###### `function`
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            exportLocalsConvention: function (name) {
+              return name.replace(/-/g, "_");
+            },
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            exportLocalsConvention: function (name) {
+              return [
+                name.replace(/-/g, "_"),
+                // dashesCamelCase
+                name.replace(/-+(\w)/g, (match, firstLetter) =>
+                  firstLetter.toUpperCase(),
+                ),
+              ];
+            },
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `exportOnlyLocals`
+
+Type:
+
+```ts
+type exportOnlyLocals = boolean;
+```
+
+Default: `false`
+
+Export only locals.
+
+**Useful** when you use **css modules** for pre-rendering (for example SSR).
+
+For pre-rendering with `mini-css-extract-plugin` you should use this option instead of `style-loader!css-loader` **in the pre-rendering bundle**.
+
+It doesn't embed CSS; it only exports the identifier mappings.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            exportOnlyLocals: true,
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+##### `getJSON`
+
+Type:
+
+```ts
+type getJSON = ({
+  resourcePath,
+  imports,
+  exports,
+  replacements,
+}: {
+  resourcePath: string;
+  imports: object[];
+  exports: object[];
+  replacements: object[];
+}) => Promise<void> | void;
+```
+
+Default: `undefined`
+
+Enables a callback to output the CSS modules mapping JSON.
+
+The callback is invoked with an object containing the following:
+
+- `resourcePath`: the absolute path of the original resource, e.g., `/foo/bar/baz.module.css`
+
+- `imports`: an array of import objects with data about import types and file paths, e.g.,
+
+```json
+[
+  {
+    "type": "icss_import",
+    "importName": "___CSS_LOADER_ICSS_IMPORT_0___",
+    "url": "\"-!../../../../../node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[4].use[1]!../../../../../node_modules/postcss-loader/dist/cjs.js!../../../../../node_modules/sass-loader/dist/cjs.js!../../../../baz.module.css\"",
+    "icss": true,
+    "index": 0
+  }
+]
+```
+
+(Note that this will include all imports, not just those relevant to CSS Modules.)
+
+- `exports`: an array of export objects with exported names and values, e.g.,
+
+```json
+[
+  {
+    "name": "main",
+    "value": "D2Oy"
+  }
+]
+```
+
+- `replacements`: an array of import replacement objects used for linking `imports` and `exports`, e.g.,
+
+```json
+{
+  "replacementName": "___CSS_LOADER_ICSS_IMPORT_0_REPLACEMENT_0___",
+  "importName": "___CSS_LOADER_ICSS_IMPORT_0___",
+  "localName": "main"
+}
+```
+
+Using `getJSON`, it's possible to output a file with all CSS module mappings.
+
+In the following example, we use `getJSON` to cache canonical mappings and add stand-ins for any composed values (through `composes`), and we use a custom plugin to consolidate the values and output them to a file:
+
+**webpack.config.js**
+
+```js
+const path = require("path");
+const fs = require("fs");
+
+const CSS_LOADER_REPLACEMENT_REGEX =
+  /(___CSS_LOADER_ICSS_IMPORT_\d+_REPLACEMENT_\d+___)/g;
+const REPLACEMENT_REGEX = /___REPLACEMENT\[(.*?)]\[(.*?)]___/g;
+const IDENTIFIER_REGEX = /\[(.*?)]\[(.*?)]/;
+const replacementsMap = {};
+const canonicalValuesMap = {};
+const allExportsJson = {};
+
+function generateIdentifier(resourcePath, localName) {
+  return `[${resourcePath}][${localName}]`;
+}
+
+function addReplacements(resourcePath, imports, exportsJson, replacements) {
+  const importReplacementsMap = {};
+
+  // create a dict to quickly identify imports and get their absolute stand-in strings in the currently loaded file
+  // e.g., { '___CSS_LOADER_ICSS_IMPORT_0_REPLACEMENT_0___': '___REPLACEMENT[/foo/bar/baz.css][main]___' }
+  importReplacementsMap[resourcePath] = replacements.reduce(
+    (acc, { replacementName, importName, localName }) => {
+      const replacementImportUrl = imports.find(
+        (importData) => importData.importName === importName,
+      ).url;
+      const relativePathRe = /.*!(.*)"/;
+      const [, relativePath] = replacementImportUrl.match(relativePathRe);
+      const importPath = path.resolve(path.dirname(resourcePath), relativePath);
+      const identifier = generateIdentifier(importPath, localName);
+      return { ...acc, [replacementName]: `___REPLACEMENT${identifier}___` };
+    },
+    {},
+  );
+
+  // iterate through the raw exports and add stand-in variables
+  // ('___REPLACEMENT[<absolute_path>][<class_name>]___')
+  // to be replaced in the plugin below
+  for (const [localName, classNames] of Object.entries(exportsJson)) {
+    const identifier = generateIdentifier(resourcePath, localName);
+
+    if (CSS_LOADER_REPLACEMENT_REGEX.test(classNames)) {
+      // if there are any replacements needed in the concatenated class names,
+      // add them all to the replacements map to be replaced altogether later
+      replacementsMap[identifier] = classNames.replaceAll(
+        CSS_LOADER_REPLACEMENT_REGEX,
+        (_, replacementName) =>
+          importReplacementsMap[resourcePath][replacementName],
+      );
+    } else {
+      // otherwise, no class names need replacements so we can add them to
+      // canonical values map and all exports JSON verbatim
+      canonicalValuesMap[identifier] = classNames;
+
+      allExportsJson[resourcePath] = allExportsJson[resourcePath] || {};
+      allExportsJson[resourcePath][localName] = classNames;
+    }
+  }
+}
+
+function replaceReplacements(classNames) {
+  return classNames.replaceAll(
+    REPLACEMENT_REGEX,
+    (_, resourcePath, localName) => {
+      const identifier = generateIdentifier(resourcePath, localName);
+
+      if (identifier in canonicalValuesMap) {
+        return canonicalValuesMap[identifier];
+      }
+
+      // Recurse through other stand-in that may be imports
+      const canonicalValue = replaceReplacements(replacementsMap[identifier]);
+
+      canonicalValuesMap[identifier] = canonicalValue;
+
+      return canonicalValue;
+    },
+  );
+}
+
+function getJSON({ resourcePath, imports, exports, replacements }) {
+  const exportsJson = exports.reduce((acc, { name, value }) => {
+    return { ...acc, [name]: value };
+  }, {});
+
+  if (replacements.length > 0) {
+    // replacements present --> add stand-in values for absolute paths and local names,
+    // which will be resolved to their canonical values in the plugin below
+    addReplacements(resourcePath, imports, exportsJson, replacements);
+  } else {
+    // no replacements present --> add to canonicalValuesMap verbatim
+    // since all values here are canonical/don't need resolution
+    for (const [key, value] of Object.entries(exportsJson)) {
+      const id = `[${resourcePath}][${key}]`;
+
+      canonicalValuesMap[id] = value;
+    }
+
+    allExportsJson[resourcePath] = exportsJson;
+  }
+}
+
+class CssModulesJsonPlugin {
+  constructor(options) {
+    this.options = options;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  apply(compiler) {
+    compiler.hooks.emit.tap("CssModulesJsonPlugin", () => {
+      for (const [identifier, classNames] of Object.entries(replacementsMap)) {
+        const adjustedClassNames = replaceReplacements(classNames);
+
+        replacementsMap[identifier] = adjustedClassNames;
+
+        const [, resourcePath, localName] = identifier.match(IDENTIFIER_REGEX);
+
+        allExportsJson[resourcePath] = allExportsJson[resourcePath] || {};
+        allExportsJson[resourcePath][localName] = adjustedClassNames;
+      }
+
+      fs.writeFileSync(
+        this.options.filepath,
+        JSON.stringify(
+          // Make path to be relative to `context` (your project root)
+          Object.fromEntries(
+            Object.entries(allExportsJson).map((key) => {
+              key[0] = path
+                .relative(compiler.context, key[0])
+                .replace(/\\/g, "/");
+
+              return key;
+            }),
+          ),
+          null,
+          2,
+        ),
+        "utf8",
+      );
+    });
+  }
+}
+
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: { modules: { getJSON } },
+      },
+    ],
+  },
+  plugins: [
+    new CssModulesJsonPlugin({
+      filepath: path.resolve(__dirname, "./output.css.json"),
+    }),
+  ],
+};
+```
+
+In the above, all import aliases are replaced with `___REPLACEMENT[<resourcePath>][<localName>]___` in `getJSON`, and they're resolved in the custom plugin. All CSS mappings are contained in `allExportsJson`:
+
+```json
+{
+  "foo/bar/baz.module.css": {
+    "main": "D2Oy",
+    "header": "thNN"
+  },
+  "foot/bear/bath.module.css": {
+    "logo": "sqiR",
+    "info": "XMyI"
+  }
+}
+```
+
+This is saved to a local file named `output.css.json`.
+
+### `importLoaders`
+
+Type:
+
+```ts
+type importLoaders = number;
+```
+
+Default: `0`
+
+Allows to enables/disables or sets up the number of loaders applied before CSS loader for `@import` at-rules, CSS Modules and ICSS imports, i.e. `@import`/`composes`/`@value value from './values.css'`/etc.
+
+The option `importLoaders` allows you to configure how many loaders before `css-loader` should be applied to `@import`ed resources and CSS Modules/ICSS imports.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        use: [
+          "style-loader",
+          {
+            loader: "css-loader",
+            options: {
+              importLoaders: 2,
+              // 0 => no loaders (default);
+              // 1 => postcss-loader;
+              // 2 => postcss-loader, sass-loader
+            },
+          },
+          "postcss-loader",
+          "sass-loader",
+        ],
+      },
+    ],
+  },
+};
+```
+
+This may change in the future when the module system (i. e. webpack) supports loader matching by origin.
+
+### `sourceMap`
+
+Type:
+
+```ts
+type sourceMap = boolean;
+```
+
+Default: depends on the `compiler.devtool` value
+
+By default generation of source maps depends on the [`devtool`](https://webpack.js.org/configuration/devtool/) option. All values enable source map generation except `eval` and `false` values.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          sourceMap: true,
+        },
+      },
+    ],
+  },
+};
+```
+
+### `esModule`
+
+Type:
+
+```ts
+type esModule = boolean;
+```
+
+Default: `true`
+
+By default, `css-loader` generates JS modules that use the ES 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 CommonJS module syntax using:
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          esModule: false,
+        },
+      },
+    ],
+  },
+};
+```
+
+### `exportType`
+
+Type:
+
+```ts
+type exportType = "array" | "string" | "css-style-sheet";
+```
+
+Default: `'array'`
+
+Allows exporting styles as array with modules, string or [constructable stylesheet](https://developers.google.com/web/updates/2019/02/constructable-stylesheets) (i.e. [`CSSStyleSheet`](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet)).
+
+The default value is `'array'`, i.e. loader exports an array of modules with a specific API which is used in `style-loader` or other.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        assert: { type: "css" },
+        loader: "css-loader",
+        options: {
+          exportType: "css-style-sheet",
+        },
+      },
+    ],
+  },
+};
+```
+
+**src/index.js**
+
+```js
+import sheet from "./styles.css" assert { type: "css" };
+
+document.adoptedStyleSheets = [sheet];
+shadowRoot.adoptedStyleSheets = [sheet];
+```
+
+#### `'array'`
+
+The default export is array of modules with specific API which is used in `style-loader` or other.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.(sa|sc|c)ss$/i,
+        use: ["style-loader", "css-loader", "postcss-loader", "sass-loader"],
+      },
+    ],
+  },
+};
+```
+
+**src/index.js**
+
+```js
+// `style-loader` applies styles to DOM
+import "./styles.css";
+```
+
+#### `'string'`
+
+> [!WARNING]
+>
+> You should not use [`style-loader`](https://github.com/webpack/style-loader) or [`mini-css-extract-plugin`](https://github.com/webpack/mini-css-extract-plugin) with this value.
+>
+> The `esModule` option should be enabled if you want to use it with [`CSS modules`](https://github.com/webpack/css-loader#modules). By default for locals [named export](https://github.com/webpack/css-loader#namedexport) will be used.
+
+The default export is `string`.
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.(sa|sc|c)ss$/i,
+        use: ["css-loader", "postcss-loader", "sass-loader"],
+      },
+    ],
+  },
+};
+```
+
+**src/index.js**
+
+```js
+import sheet from "./styles.css";
+
+console.log(sheet);
+```
+
+#### `'css-style-sheet'`
+
+> [!WARNING]
+>
+> `@import` rules not yet allowed, more [information](https://web.dev/css-module-scripts/#@import-rules-not-yet-allowed)
+
+> [!WARNING]
+>
+> You don't need [`style-loader`](https://github.com/webpack/style-loader) anymore, please remove it.
+
+> [!WARNING]
+>
+> The `esModule` option should be enabled if you want to use it with [`CSS modules`](https://github.com/webpack/css-loader#modules). By default for locals [named export](https://github.com/webpack/css-loader#namedexport) will be used.
+
+> [!WARNING]
+>
+> Source maps are not currently supported in `Chrome` due to a [bug](https://bugs.chromium.org/p/chromium/issues/detail?id=1174094&q=CSSStyleSheet%20source%20maps&can=2)
+
+The default export is a [constructable stylesheet](https://developers.google.com/web/updates/2019/02/constructable-stylesheets) (i.e. [`CSSStyleSheet`](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet)).
+
+Useful for [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) and shadow DOM.
+
+More information:
+
+- [Using CSS Module Scripts to import stylesheets](https://web.dev/css-module-scripts/)
+- [Constructable Stylesheets: seamless reusable styles](https://developers.google.com/web/updates/2019/02/constructable-stylesheets)
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        assert: { type: "css" },
+        loader: "css-loader",
+        options: {
+          exportType: "css-style-sheet",
+        },
+      },
+
+      // For Sass/SCSS:
+      //
+      // {
+      //   assert: { type: "css" },
+      //   rules: [
+      //     {
+      //       loader: "css-loader",
+      //       options: {
+      //         exportType: "css-style-sheet",
+      //         // Other options
+      //       },
+      //     },
+      //     {
+      //       loader: "sass-loader",
+      //       options: {
+      //         // Other options
+      //       },
+      //     },
+      //   ],
+      // },
+    ],
+  },
+};
+```
+
+**src/index.js**
+
+```js
+// Example for Sass/SCSS:
+// import sheet from "./styles.scss" assert { type: "css" };
+
+// Example for CSS modules:
+// import sheet, { myClass } from "./styles.scss" assert { type: "css" };
+
+// Example for CSS:
+import sheet from "./styles.css" assert { type: "css" };
+
+document.adoptedStyleSheets = [sheet];
+shadowRoot.adoptedStyleSheets = [sheet];
+```
+
+For migration purposes, you can use the following configuration:
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        oneOf: [
+          {
+            assert: { type: "css" },
+            loader: "css-loader",
+            options: {
+              exportType: "css-style-sheet",
+              // Other options
+            },
+          },
+          {
+            use: [
+              "style-loader",
+              {
+                loader: "css-loader",
+                options: {
+                  // Other options
+                },
+              },
+            ],
+          },
+        ],
+      },
+    ],
+  },
+};
+```
+
+## Examples
+
+### Recommend
+
+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/mini-css-extract-plugin), because it creates separate css files.
+
+For `development` mode (including `webpack-dev-server`) you can use [style-loader](https://github.com/webpack/style-loader), because it injects CSS into the DOM using multiple `<style></style>` and works faster.
+
+> [!NOTE]
+>
+> Do not use `style-loader` and `mini-css-extract-plugin` together.
+
+**webpack.config.js**
+
+```js
+const MiniCssExtractPlugin = require("mini-css-extract-plugin");
+const devMode = process.env.NODE_ENV !== "production";
+
+module.exports = {
+  module: {
+    rules: [
+      {
+        // If you enable `experiments.css` or `experiments.futureDefaults`, please uncomment line below
+        // type: "javascript/auto",
+        test: /\.(sa|sc|c)ss$/i,
+        use: [
+          devMode ? "style-loader" : MiniCssExtractPlugin.loader,
+          "css-loader",
+          "postcss-loader",
+          "sass-loader",
+        ],
+      },
+    ],
+  },
+  plugins: [].concat(devMode ? [] : [new MiniCssExtractPlugin()]),
+};
+```
+
+### Disable URL resolving using the `/* webpackIgnore: true */` comment
+
+With the help of the `/* webpackIgnore: true */`comment, it is possible to disable sources handling for rules and for individual declarations.
+
+```css
+/* webpackIgnore: true */
+@import url(./basic.css);
+@import /* webpackIgnore: true */ url(./imported.css);
+
+.class {
+  /* Disabled url handling for the all urls in the 'background' declaration */
+  color: red;
+  /* webpackIgnore: true */
+  background: url("./url/img.png"), url("./url/img.png");
+}
+
+.class {
+  /* Disabled url handling for the first url in the 'background' declaration */
+  color: red;
+  background:
+    /* webpackIgnore: true */ url("./url/img.png"), url("./url/img.png");
+}
+
+.class {
+  /* Disabled url handling for the second url in the 'background' declaration */
+  color: red;
+  background:
+    url("./url/img.png"),
+    /* webpackIgnore: true */ url("./url/img.png");
+}
+
+/* prettier-ignore */
+.class {
+  /* Disabled url handling for the second url in the 'background' declaration */
+  color: red;
+  background: url("./url/img.png"),
+    /* webpackIgnore: true */
+    url("./url/img.png");
+}
+
+/* prettier-ignore */
+.class {
+  /* Disabled url handling for third and sixth urls in the 'background-image' declaration */
+  background-image: image-set(
+    url(./url/img.png) 2x,
+    url(./url/img.png) 3x,
+    /* webpackIgnore:  true */ url(./url/img.png) 4x,
+    url(./url/img.png) 5x,
+    url(./url/img.png) 6x,
+    /* webpackIgnore:  true */
+    url(./url/img.png) 7x
+  );
+}
+```
+
+### Assets
+
+The following `webpack.config.js` can load CSS files, embed small PNG/JPG/GIF/SVG images as well as fonts as [Data URLs](https://tools.ietf.org/html/rfc2397) and copy larger files to the output directory.
+
+**For webpack v5:**
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        use: ["style-loader", "css-loader"],
+      },
+      {
+        test: /\.(png|jpe?g|gif|svg|eot|ttf|woff|woff2)$/i,
+        // More information here https://webpack.js.org/guides/asset-modules/
+        type: "asset",
+      },
+    ],
+  },
+};
+```
+
+### Extract
+
+For production builds it's recommended to extract the CSS from your bundle to enable parallel loading of CSS/JS resources later on.
+
+- This can be achieved by using the [mini-css-extract-plugin](https://github.com/webpack/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.
+
+### Pure CSS, CSS Modules and PostCSS
+
+When you have pure CSS (without CSS modules), CSS modules and PostCSS in your project, you can use this setup:
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        // For pure CSS - /\.css$/i,
+        // For Sass/SCSS - /\.((c|sa|sc)ss)$/i,
+        // For Less - /\.((c|le)ss)$/i,
+        test: /\.((c|sa|sc)ss)$/i,
+        use: [
+          "style-loader",
+          {
+            loader: "css-loader",
+            options: {
+              // Run `postcss-loader` on each CSS `@import` and CSS modules/ICSS imports, do not forget that `sass-loader` compile non CSS `@import`'s into a single file
+              // If you need run `sass-loader` and `postcss-loader` on each CSS `@import` please set it to `2`
+              importLoaders: 1,
+            },
+          },
+          {
+            loader: "postcss-loader",
+            options: { plugins: () => [postcssPresetEnv({ stage: 0 })] },
+          },
+          // Can be `less-loader`
+          {
+            loader: "sass-loader",
+          },
+        ],
+      },
+      // For webpack v5
+      {
+        test: /\.(png|jpe?g|gif|svg|eot|ttf|woff|woff2)$/i,
+        // More information here https://webpack.js.org/guides/asset-modules/
+        type: "asset",
+      },
+    ],
+  },
+};
+```
+
+### Resolve unresolved URLs using an alias
+
+**index.css**
+
+```css
+.class {
+  background: url(/assets/unresolved/img.png);
+}
+```
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        use: ["style-loader", "css-loader"],
+      },
+    ],
+  },
+  resolve: {
+    alias: {
+      "/assets/unresolved/img.png": path.resolve(
+        __dirname,
+        "assets/real-path-to-img/img.png",
+      ),
+    },
+  },
+};
+```
+
+### Named export with custom export names
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/i,
+        loader: "css-loader",
+        options: {
+          modules: {
+            namedExport: true,
+            exportLocalsConvention: function (name) {
+              return name.replace(/-/g, "_");
+            },
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+### Separating `Interoperable CSS`-only and `CSS Module` features
+
+The following setup is an example of allowing `Interoperable CSS` features only (such as `:import` and `:export`) without using further `CSS Module` functionality by setting the `mode` option for all files that do not match the `*.module.scss` naming convention. This is for reference, as having `ICSS` features applied to all files was default `css-loader` behavior before v4.
+
+Meanwhile, all files matching `*.module.scss` are treated as `CSS Modules` in this example.
+
+An example case is assumed where a project requires canvas drawing variables to be synchronized with CSS - canvas drawing uses the same color (set by color name in JavaScript) as HTML background (set by class name in CSS).
+
+**webpack.config.js**
+
+```js
+module.exports = {
+  module: {
+    rules: [
+      // ...
+      // --------
+      // SCSS ALL EXCEPT MODULES
+      {
+        test: /\.scss$/i,
+        exclude: /\.module\.scss$/i,
+        use: [
+          {
+            loader: "style-loader",
+          },
+          {
+            loader: "css-loader",
+            options: {
+              importLoaders: 1,
+              modules: {
+                mode: "icss",
+              },
+            },
+          },
+          {
+            loader: "sass-loader",
+          },
+        ],
+      },
+      // --------
+      // SCSS MODULES
+      {
+        test: /\.module\.scss$/i,
+        use: [
+          {
+            loader: "style-loader",
+          },
+          {
+            loader: "css-loader",
+            options: {
+              importLoaders: 1,
+              modules: {
+                mode: "local",
+              },
+            },
+          },
+          {
+            loader: "sass-loader",
+          },
+        ],
+      },
+      // --------
+      // ...
+    ],
+  },
+};
+```
+
+**variables.scss**
+
+File treated as `ICSS`-only.
+
+```scss
+$colorBackground: red;
+:export {
+  colorBackgroundCanvas: $colorBackground;
+}
+```
+
+**Component.module.scss**
+
+File treated as `CSS Module`.
+
+```scss
+@import "variables.scss";
+.componentClass {
+  background-color: $colorBackground;
+}
+```
+
+**Component.jsx**
+
+Using both `CSS Module` functionality as well as SCSS variables directly in JavaScript.
+
+```jsx
+import * as svars from "variables.scss";
+import * as styles from "Component.module.scss";
+
+// Render DOM with CSS modules class name
+// <div className={styles.componentClass}>
+//   <canvas ref={mountsCanvas}/>
+// </div>
+
+// Somewhere in JavaScript canvas drawing code use the variable directly
+// const ctx = mountsCanvas.current.getContext('2d',{alpha: false});
+ctx.fillStyle = `${svars.colorBackgroundCanvas}`;
+```
+
+## Contributing
+
+We welcome all contributions!
+
+If you are new here, please take a moment to review our contributing guidelines before submitting issues or pull requests.
+
+[CONTRIBUTING](https://github.com/webpack/css-loader?tab=contributing-ov-file#contributing)
+
+## License
+
+[MIT](./LICENSE)
+
+[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
+[tests]: https://github.com/webpack/css-loader/workflows/css-loader/badge.svg
+[tests-url]: https://github.com/webpack/css-loader/actions
+[cover]: https://codecov.io/gh/webpack/css-loader/branch/main/graph/badge.svg
+[cover-url]: https://codecov.io/gh/webpack/css-loader
+[discussion]: https://img.shields.io/github/discussions/webpack/webpack
+[discussion-url]: https://github.com/webpack/webpack/discussions
+[size]: https://packagephobia.now.sh/badge?p=css-loader
+[size-url]: https://packagephobia.now.sh/result?p=css-loader