css-loader 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [3.1.0](https://github.com/webpack-contrib/css-loader/compare/v3.0.0...v3.1.0) (2019-07-18)
+
+
+### Bug Fixes
+
+* converting all (including reserved and control) filesystem characters to `-` (it was regression in `3.0.0` version) ([#972](https://github.com/webpack-contrib/css-loader/issues/972)) ([f51859b](https://github.com/webpack-contrib/css-loader/commit/f51859b))
+* default context should be undefined instead of null ([#965](https://github.com/webpack-contrib/css-loader/issues/965)) ([9c32885](https://github.com/webpack-contrib/css-loader/commit/9c32885))
+
+
+### Features
+
+* allow `modules.getLocalIdent` to return a falsy value ([#963](https://github.com/webpack-contrib/css-loader/issues/963)) ([9c3571c](https://github.com/webpack-contrib/css-loader/commit/9c3571c))
+* improved validation error messages ([65e4fc0](https://github.com/webpack-contrib/css-loader/commit/65e4fc0))
+
+
+
 ## [3.0.0](https://github.com/webpack-contrib/css-loader/compare/v2.1.1...v3.0.0) (2019-06-11)
 
 

package/README.md

@@ -109,21 +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\|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                                 |
+|                    Name                     |            Type             | Default | Description                                                            |
+| :-----------------------------------------: | :-------------------------: | :-----: | :--------------------------------------------------------------------- |
+|              **[`url`](#url)**              |    `{Boolean\|Function}`    | `true`  | Enables/Disables `url`/`image-set` functions handling                  |
+|           **[`import`](#import)**           |    `{Boolean\|Function}`    | `true`  | Enables/Disables `@import` at-rules handling                           |
+|          **[`modules`](#modules)**          | `{Boolean\|String\|Object}` | `false` | Enables/Disables CSS Modules and their configuration                   |
+|        **[`sourceMap`](#sourcemap)**        |         `{Boolean}`         | `false` | Enables/Disables generation of source maps                             |
+|    **[`importLoaders`](#importloaders)**    |         `{Number}`          |   `0`   | Enables/Disables or setups number of loaders applied before CSS loader |
+| **[`localsConvention`](#localsconvention)** |         `{String}`          | `asIs`  | Style of exported classnames                                           |
+|       **[`onlyLocals`](#onlylocals)**       |         `{Boolean}`         | `false` | Export only locals                                                     |
 
 ### `url`
 
 Type: `Boolean|Function`
 Default: `true`
 
+Enables/Disables `url`/`image-set` functions handling.
 Control `url()` resolving. Absolute URLs and root-relative URLs are not resolving.
 
 Examples resolutions:
@@ -203,6 +204,7 @@ module.exports = {
 Type: `Boolean`
 Default: `true`
 
+Enables/Disables `@import` at-rules handling.
 Control `@import` resolving. Absolute urls in `@import` will be moved in runtime code.
 
 Examples resolutions:
@@ -285,6 +287,8 @@ module.exports = {
 Type: `Boolean|String|Object`
 Default: `false`
 
+Enables/Disables CSS Modules and their configuration.
+
 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.
@@ -568,6 +572,15 @@ 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.
 
+Recommendations:
+
+- use `[path][name]__[local]` for development
+- use `[hash:base64]` for production
+
+The `[local]` placeholder contains original class.
+
+**Note:** all reserved (`<>:"/\|?*`) and control filesystem characters (excluding characters in the `[local]` placeholder) will be converted to `-`.
+
 **webpack.config.js**
 
 ```js
@@ -703,14 +716,12 @@ module.exports = {
 Type: `Boolean`
 Default: `false`
 
-To include source maps set the `sourceMap` option.
+Enables/Disables generation of source maps.
 
-I.e. the `mini-css-extract-plugin` can handle them.
+To include source maps set the `sourceMap` option.
 
 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
@@ -734,6 +745,8 @@ module.exports = {
 Type: `Number`
 Default: `0`
 
+Enables/Disables or setups number of loaders applied before CSS loader.
+
 The option `importLoaders` allows you to configure how many loaders before `css-loader` should be applied to `@import`ed resources.
 
 **webpack.config.js**
@@ -749,7 +762,10 @@ module.exports = {
           {
             loader: 'css-loader',
             options: {
-              importLoaders: 2, // 0 => no loaders (default); 1 => postcss-loader; 2 => postcss-loader, sass-loader
+              importLoaders: 2,
+              // 0 => no loaders (default);
+              // 1 => postcss-loader;
+              // 2 => postcss-loader, sass-loader
             },
           },
           'postcss-loader',
@@ -768,6 +784,8 @@ This may change in the future when the module system (i. e. webpack) supports lo
 Type: `String`
 Default: `undefined`
 
+Style of exported classnames.
+
 By default, the exported JSON keys mirror the class names (i.e `asIs` value).
 
 |         Name          |    Type    | Description                                                                                      |
@@ -814,7 +832,9 @@ module.exports = {
 Type: `Boolean`
 Default: `false`
 
-Export only locals (**useful** when you use **css modules**).
+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 but only exports the identifier mappings.
 

package/dist/index.js

@@ -31,7 +31,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 */
 function loader(content, map, meta) {
   const options = (0, _loaderUtils.getOptions)(this) || {};
-  (0, _schemaUtils.default)(_options.default, options, 'CSS Loader');
+  (0, _schemaUtils.default)(_options.default, options, {
+    name: 'CSS Loader',
+    baseDataPath: 'options'
+  });
   const callback = this.async();
   const sourceMap = options.sourceMap || false; // Some loaders (example `"postcss-loader": "1.x.x"`) always generates source map, we should remove it
   // eslint-disable-next-line no-param-reassign

package/dist/options.json

@@ -2,6 +2,7 @@
   "additionalProperties": false,
   "properties": {
     "url": {
+      "description": "Enables/Disables 'url'/'image-set' functions handling (https://github.com/webpack-contrib/css-loader#url).",
       "anyOf": [
         {
           "type": "boolean"
@@ -12,6 +13,7 @@
       ]
     },
     "import": {
+      "description": "Enables/Disables '@import' at-rules handling (https://github.com/webpack-contrib/css-loader#import).",
       "anyOf": [
         {
           "type": "boolean"
@@ -22,12 +24,12 @@
       ]
     },
     "modules": {
+      "description": "Enables/Disables CSS Modules and their configuration (https://github.com/webpack-contrib/css-loader#modules).",
       "anyOf": [
         {
           "type": "boolean"
         },
         {
-          "type": "string",
           "enum": ["local", "global"]
         },
         {
@@ -35,7 +37,6 @@
           "additionalProperties": false,
           "properties": {
             "mode": {
-              "type": "string",
               "enum": ["local", "global"]
             },
             "localIdentName": {
@@ -72,9 +73,11 @@
       ]
     },
     "sourceMap": {
+      "description": "Enables/Disables generation of source maps (https://github.com/webpack-contrib/css-loader#sourcemap).",
       "type": "boolean"
     },
     "importLoaders": {
+      "description": "Enables/Disables or setups number of loaders applied before CSS loader (https://github.com/webpack-contrib/css-loader#importloaders).",
       "anyOf": [
         {
           "type": "boolean"
@@ -85,14 +88,11 @@
       ]
     },
     "localsConvention": {
-      "anyOf": [
-        {
-          "type": "string",
-          "enum": ["asIs", "camelCase", "camelCaseOnly", "dashes", "dashesOnly"]
-        }
-      ]
+      "description": "Style of exported classnames (https://github.com/webpack-contrib/css-loader#localsconvention).",
+      "enum": ["asIs", "camelCase", "camelCaseOnly", "dashes", "dashesOnly"]
     },
     "onlyLocals": {
+      "description": "Export only locals (https://github.com/webpack-contrib/css-loader#onlylocals).",
       "type": "boolean"
     }
   },

package/dist/utils.js

@@ -86,7 +86,13 @@ function unescape(str) {
     String.fromCharCode(high >> 10 | 0xd800, high & 0x3ff | 0xdc00);
     /* eslint-enable line-comment-position */
   });
-}
+} // eslint-disable-next-line no-control-regex
+
+
+const filenameReservedRegex = /[<>:"/\\|?*\x00-\x1F]/g; // eslint-disable-next-line no-control-regex
+
+const reControlChars = /[\u0000-\u001f\u0080-\u009f]/g;
+const reRelativePath = /^\.+/;
 
 function getLocalIdent(loaderContext, localIdentName, localName, options) {
   if (!options.context) {
@@ -100,7 +106,7 @@ function getLocalIdent(loaderContext, localIdentName, localName, options) {
   // Also directories can contains invalid characters for css we need escape their too
 
   return (0, _cssesc.default)(_loaderUtils.default.interpolateName(loaderContext, localIdentName, options) // For `[hash]` placeholder
-  .replace(/^((-?[0-9])|--)/, '_$1'), {
+  .replace(/^((-?[0-9])|--)/, '_$1').replace(filenameReservedRegex, '-').replace(reControlChars, '-').replace(reRelativePath, '-'), {
     isIdentifier: true
   }).replace(/\\\[local\\\]/gi, localName);
 }
@@ -124,7 +130,6 @@ function getModulesPlugins(options, loaderContext) {
     mode: 'local',
     localIdentName: '[hash:base64]',
     getLocalIdent,
-    context: null,
     hashPrefix: '',
     localIdentRegExp: null
   };
@@ -139,11 +144,21 @@ function getModulesPlugins(options, loaderContext) {
     mode: modulesOptions.mode
   }), (0, _postcssModulesExtractImports.default)(), (0, _postcssModulesScope.default)({
     generateScopedName: function generateScopedName(exportName) {
-      return modulesOptions.getLocalIdent(loaderContext, modulesOptions.localIdentName, exportName, {
+      let localIdent = modulesOptions.getLocalIdent(loaderContext, modulesOptions.localIdentName, exportName, {
         context: modulesOptions.context,
         hashPrefix: modulesOptions.hashPrefix,
         regExp: modulesOptions.localIdentRegExp
       });
+
+      if (!localIdent) {
+        localIdent = getLocalIdent(loaderContext, modulesOptions.localIdentName, exportName, {
+          context: modulesOptions.context,
+          hashPrefix: modulesOptions.hashPrefix,
+          regExp: modulesOptions.localIdentRegExp
+        });
+      }
+
+      return localIdent;
     }
   })];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "css-loader",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "css loader module for webpack",
   "license": "MIT",
   "repository": "webpack-contrib/css-loader",
@@ -52,40 +52,40 @@
     "postcss-modules-scope": "^2.1.0",
     "postcss-modules-values": "^3.0.0",
     "postcss-value-parser": "^4.0.0",
-    "schema-utils": "^1.0.0"
+    "schema-utils": "^2.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.4.4",
-    "@babel/core": "^7.4.5",
-    "@babel/preset-env": "^7.4.5",
-    "@commitlint/cli": "^8.0.0",
-    "@commitlint/config-conventional": "^8.0.0",
-    "@webpack-contrib/defaults": "^5.0.0",
+    "@babel/cli": "^7.5.0",
+    "@babel/core": "^7.5.4",
+    "@babel/preset-env": "^7.5.4",
+    "@commitlint/cli": "^8.1.0",
+    "@commitlint/config-conventional": "^8.1.0",
+    "@webpack-contrib/defaults": "^5.0.2",
     "@webpack-contrib/eslint-config-webpack": "^3.0.0",
     "babel-jest": "^24.8.0",
     "commitlint-azure-pipelines-cli": "^1.0.2",
     "cross-env": "^5.2.0",
-    "del": "^4.1.1",
+    "del": "^5.0.0",
     "del-cli": "^2.0.0",
     "es-check": "^5.0.0",
     "eslint": "^5.16.0",
-    "eslint-config-prettier": "^4.3.0",
-    "eslint-plugin-import": "^2.17.3",
+    "eslint-config-prettier": "^6.0.0",
+    "eslint-plugin-import": "^2.18.0",
     "file-loader": "^4.0.0",
-    "husky": "^2.4.0",
+    "husky": "^3.0.0",
     "jest": "^24.8.0",
     "jest-junit": "^6.4.0",
-    "lint-staged": "^8.2.0",
+    "lint-staged": "^9.2.0",
     "memory-fs": "^0.4.1",
     "npm-run-all": "^4.1.5",
     "postcss-loader": "^3.0.0",
-    "postcss-preset-env": "^6.6.0",
+    "postcss-preset-env": "^6.7.0",
     "prettier": "^1.18.2",
-    "sass": "^1.21.0",
+    "sass": "^1.22.5",
     "sass-loader": "^7.1.0",
     "standard-version": "^6.0.1",
     "strip-ansi": "^5.2.0",
-    "webpack": "^4.33.0"
+    "webpack": "^4.35.0"
   },
   "keywords": [
     "webpack",