css-loader 0.25.0 → 0.26.4

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright JS Foundation and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,66 +1,148 @@
-# css loader for webpack
+[![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="200" height="200"
+    src="https://cdn.worldvectorlogo.com/logos/css-3.svg">
+  <a href="https://github.com/webpack/webpack">
+    <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>
+
+```bash
+npm install --save-dev css-loader
+```
+
+<h2 align="center">Usage</h2>
+
+The `css-loader` interprets `@import` and `url()` like `requires`.
 
-## installation
+Use the loader either via your webpack config, CLI or inline.
 
-`npm install css-loader --save-dev`
+### Via webpack config (recommended)
+
+**webpack.config.js**
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/,
+        use: [ 'style-loader', 'css-loader' ]
+      }
+    ]
+  }
+}
+```
+
+**In your application**
+```js
+import css from 'file.css';
+```
+
+### CLI
+
+```bash
+webpack --module-bind 'css=style-loader!css-loader'
+```
 
-## Usage
+**In your application**
+```js
+import css from 'file.css';
+```
 
-[Documentation: Using loaders](http://webpack.github.io/docs/using-loaders.html)
+### Inline
 
-``` javascript
-var css = require("css!./file.css");
-// => returns css code from file.css, resolves imports and url(...)
+**In your application**
+```js
+import css from 'style-loader!css-loader!./file.css';
 ```
 
-`@import` and `url(...)` are interpreted like `require()` and will be resolved by the css-loader.
+<h2 align="center">Options</h2>
+
+`@import` and `url()` are interpreted like `import` and will be resolved by the 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).
 
 To be compatible with existing css files (if not in CSS Module mode):
-* `url(image.png)` => `require("./image.png")`
-* `url(~module/image.png)` => `require("module/image.png")`
 
-### Example config
+* `url(image.png)` => `require('./image.png')`
+* `url(~module/image.png)` => `require('module/image.png')`
+
+<h2 align="center">Options</h2>
 
-This webpack config can load css files, embed small png images as Data Urls and jpg images as files.
+|Name|Default|Description|
+|:--:|:-----:|:----------|
+|**`root`**|`/`|Path to resolve URLs, URLs starting with `/` will not be translated|
+|**`modules`**|`false`|Enable/Disable CSS Modules|
+|**`import`** |`true`| Enable/Disable @import handling|
+|**`url`**|`true`| Enable/Disable `url()` handling|
+|**`minimize`**|`false`|Enable/Disable minification|
+|**`sourceMap`**|`false`|Enable/Disable Sourcemaps|
+|**`camelCase`**|`false`|Export Classnames in CamelCase|
+|**`importLoaders`**|`0`|Number of loaders applied before CSS loader|
 
-``` javascript
+The following webpack config 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.
+
+**webpack.config.js**
+```js
 module.exports = {
   module: {
-    loaders: [
-      { test: /\.css$/, loader: "style-loader!css-loader" },
-      { test: /\.png$/, loader: "url-loader?limit=100000" },
-      { test: /\.jpg$/, loader: "file-loader" }
+    rules: [
+      {
+        test: /\.css$/,
+        use: [ 'style-loader', 'css-loader' ]
+      },
+      {
+        test: /\.(png|jpg|gif|svg|eot|ttf|woff|woff2)$/,
+        loader: 'url-loader',
+        options: {
+          limit: 10000
+        }
+      }
     ]
   }
 };
 ```
 
-### 'Root-relative' urls
+### Root
+
+For URLs that start with a `/`, the default behavior is to not translate them:
 
-For urls that start with a `/`, the default behavior is to not translate them:
 * `url(/image.png)` => `url(/image.png)`
 
-If a `root` query parameter is set, however, it will be prepended to the url
+If a `root` query parameter is set, however, it will be prepended to the URL
 and then translated:
 
-With a config like:
-
-``` javascript
-    loaders: [
-      { test: /\.css$/, loader: "style-loader!css-loader?root=." },
-      ...
+**webpack.config.js**
+```js
+rules: [
+  {
+    test: /\.css$/,
+    use: [
+      'style-loader',
+      {
+        loader: 'css-loader',
+        options: { root: '.' }
+      }
     ]
+  }
+]
 ```
 
-The result is:
-
-* `url(/image.png)` => `require("./image.png")`
+* `url(/image.png)` => `require('./image.png')`
 
 Using 'Root-relative' urls is not recommended. You should only use it for legacy CSS files.
 
-### Local scope
+### CSS Scope
 
 By default CSS exports all class names into a global selector scope. Styles can be locally scoped to avoid globally scoping styles.
 
@@ -70,17 +152,15 @@ With `:local` (without brackets) local mode can be switched on for this selector
 
 The loader replaces local selectors with unique identifiers. The choosen unique identifiers are exported by the module.
 
-Example:
-
-``` css
+**app.css**
+```css
 :local(.className) { background: red; }
 :local .className { color: green; }
 :local(.className .subClass) { color: green; }
 :local .className .subClass :global(.global-class-name) { color: blue; }
 ```
 
-is transformed to
-
+**app.bundle.css**
 ``` css
 ._23_aKvs-b8bW2Vg3fwHozO { background: red; }
 ._23_aKvs-b8bW2Vg3fwHozO { color: green; }
@@ -88,37 +168,71 @@ is transformed to
 ._23_aKvs-b8bW2Vg3fwHozO ._13LGdX8RMStbBE9w-t0gZ1 .global-class-name { color: blue; }
 ```
 
-and the identifiers are exported:
+> Note: Identifiers are exported
 
 ``` js
 exports.locals = {
-  className: "_23_aKvs-b8bW2Vg3fwHozO",
-  subClass: "_13LGdX8RMStbBE9w-t0gZ1"
+  className: '_23_aKvs-b8bW2Vg3fwHozO',
+  subClass: '_13LGdX8RMStbBE9w-t0gZ1'
 }
 ```
 
-Camelcasing is recommended for local selectors. They are easier to use in the importing javascript module.
+CamelCase is recommended for local selectors. They are easier to use in the within the imported JS module.
 
-`url(...)` URLs in block scoped (`:local .abc`) rules behave like requests in modules:
-  * `./file.png` instead of `file.png`
-  * `module/file.png` instead of `~module/file.png`
+`url()` URLs in block scoped (`:local .abc`) rules behave like requests in modules:
 
+* `./file.png` instead of `file.png`
+* `module/file.png` instead of `~module/file.png`
 
 You can use `:local(#someId)`, but this is not recommended. Use classes instead of ids.
 
-You can configure the generated ident with the `localIdentName` query parameter (default `[hash:base64]`). Example: `css-loader?localIdentName=[path][name]---[local]---[hash:base64:5]` for easier debugging.
+You can configure the generated ident with the `localIdentName` query parameter (default `[hash:base64]`).
+
+ **webpack.config.js**
+ ```js
+{
+  test: /\.css$/,
+  use: [
+    {
+      loader: 'css-loader',
+      options: {
+        modules: true,
+        localIdentName: '[path][name]__[local]--[hash:base64:5]'
+      }
+    }
+  ]
+}
+```
+
+You can also specify the absolute path to your custom `getLocalIdent` function to generate classname based on a different schema. Note that this requires `webpack >= v2.x.` since to be able to pass function in. For example:
 
-Note: 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.
+```js
+{
+  test: /\.css$/,
+  use: [
+    {
+      loader: 'css-loader',
+      options: {
+        modules: true,
+        localIdentName: '[path][name]__[local]--[hash:base64:5]',
+        getLocalIdent: (context, localIdentName, localName, options) => {
+          return 'whatever_random_class_name'
+        }
+      }
+    }
+  ]
+}
+```
 
-### CSS Modules
+Note: 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.
 
-See [CSS Modules](https://github.com/css-modules/css-modules).
+### [CSS Modules](https://github.com/css-modules/css-modules)
 
-The query parameter `modules` enables the **CSS Modules** spec. (`css-loader?modules`)
+The query parameter `modules` enables the **CSS Modules** spec.
 
-This enables Local scoped CSS by default. (You can switch it off with `:global(...)` or `:global` for selectors and/or rules.)
+This enables local scoped CSS by default. (You can switch it off with `:global(...)` or `:global` for selectors and/or rules.)
 
-### Composing CSS classes
+### CSS Composing
 
 When declaring a local class name you can compose a local class from another local class name.
 
@@ -136,15 +250,13 @@ When declaring a local class name you can compose a local class from another loc
 
 This doesn't result in any change to the CSS itself but exports multiple class names:
 
-``` js
+```js
 exports.locals = {
-  className: "_23_aKvs-b8bW2Vg3fwHozO",
-  subClass: "_13LGdX8RMStbBE9w-t0gZ1 _23_aKvs-b8bW2Vg3fwHozO"
+  className: '_23_aKvs-b8bW2Vg3fwHozO',
+  subClass: '_13LGdX8RMStbBE9w-t0gZ1 _23_aKvs-b8bW2Vg3fwHozO'
 }
 ```
 
-and CSS is transformed to:
-
 ``` css
 ._23_aKvs-b8bW2Vg3fwHozO {
   background: red;
@@ -156,20 +268,20 @@ and CSS is transformed to:
 }
 ```
 
-### Importing local class names
+### Importing CSS Locals
 
 To import a local class name from another module:
 
 ``` 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;
 }
 ```
@@ -178,8 +290,8 @@ 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 hightlight from './edit.css';
+  composes: button from 'module/button.css';
   composes: classFromThisModule;
   background: red;
 }
@@ -187,30 +299,47 @@ To import from multiple modules use multiple `composes:` rules.
 
 ### SourceMaps
 
-To include SourceMaps set the `sourceMap` query param.
-
-`require("css-loader?sourceMap!./file.css")`
+To include Sourcemaps set the `sourceMap` query param.
 
 I. e. the extract-text-webpack-plugin can handle them.
 
-They are not enabled by default because they expose a runtime overhead and increase in bundle size (JS SourceMap do not). In addition to that relative paths are buggy and you need to use an absolute public path which include the server url.
+They are not enabled by default because they expose a runtime overhead and increase in bundle size (JS SourceMap do not). In addition to that relative paths are buggy and you need to use an absolute public path which include the server URL.
 
-### importing and chained loaders
-
-The query parameter `importLoaders` allow to configure which loaders should be applied to `@import`ed resources.
+**webpack.config.js**
+```js
+{
+  test: /\.css$/,
+  use: [
+    {
+      loader: 'css-loader',
+      options: {
+        sourceMap: true
+      }
+    }
+  ]
+}
+```
 
-`importLoaders` (int): That many loaders after the css-loader are used to import resources.
+### ImportLoaders
 
-Examples:
+The query parameter `importLoaders` allow to configure which loaders should be applied to `@import`ed resources.
 
-``` js
-require("style-loader!css-loader?importLoaders=1!autoprefixer-loader!...")
-// => imported resources are handled this way:
-require("css-loader?importLoaders=1!autoprefixer-loader!...")
+`importLoaders`: That many loaders after the css-loader are used to import resources.
 
-require("style-loader!css-loader!stylus-loader!...")
-// => imported resources are handled this way:
-require("css-loader!...")
+**webpack.config.js**
+```js
+{
+  test: /\.css$/,
+  use: [
+    {
+      loader: 'css-loader',
+      options: {
+        importLoaders: 1
+      }
+    },
+    'postcss-loader'
+  ]
+}
 ```
 
 This may change in the future, when the module system (i. e. webpack) supports loader matching by origin.
@@ -219,41 +348,100 @@ This may change in the future, when the module system (i. e. webpack) supports l
 
 By default the css-loader minimizes the css if specified by the module system.
 
-In some cases the minification is destructive to the css, so you can provide some options to it. cssnano is used for minification and you find a [list of options here](http://cssnano.co/options/). Just provide them as query parameter: i. e. `require("css-loader?-autoprefixer")` to disable removing of deprecated vendor prefixes.
+In some cases the minification is destructive to the css, so you can provide some options to it. cssnano is used for minification and you find a [list of options here](http://cssnano.co/options/).
 
 You can also disable or enforce minification with the `minimize` query parameter.
 
-`require("css-loader?minimize!./file.css")` (enforced)
-
-`require("css-loader?-minimize!./file.css")` (disabled)
-
-### Disable behavior
-
-`css-loader?-url` disables `url(...)` handling.
-
-`css-loader?-import` disables `@import` handling.
-
-### Camel case
+**webpack.config.js**
+```js
+{
+  test: /\.css$/,
+  use: [
+    {
+      loader: 'css-loader',
+      options: {
+        minimize: true || {/* CSSNano Options */}
+      }
+    }
+  ]
+}
+```
 
-By default, the exported JSON keys mirror the class names. If you want to camelize class names (useful in Javascript), pass the query parameter `camelCase` to the loader.
+### CamelCase
 
-Example:
+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.
 
-`css-loader?camelCase`
+**webpack.config.js**
+```js
+{
+  test: /\.css$/,
+  use: [
+    {
+      loader: 'css-loader',
+      options: {
+        camelCase: true
+      }
+    }
+  ]
+}
+```
 
-Usage:
 ```css
-/* file.css */
-
-.class-name { /* ... */ }
+.class-name {}
 ```
 
 ```js
-// javascript
-
-require('file.css').className
+import { className } from 'file.css';
 ```
 
-## License
-
-MIT (http://www.opensource.org/licenses/mit-license.php)
+<h2 align="center">Maintainers</h2>
+
+<table>
+  <tbody>
+    <tr>
+      <td align="center">
+        <img width="150" height="150"
+        src="https://avatars3.githubusercontent.com/u/166921?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://avatars2.githubusercontent.com/u/8420490?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://avatars3.githubusercontent.com/u/533616?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://avatars3.githubusercontent.com/u/3408176?v=3&s=150">
+        </br>
+        <a href="https://github.com/TheLarkInn">Sean Larkin</a>
+      </td>
+    </tr>
+  <tbody>
+</table>
+
+
+[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/css-loader.svg
+[deps-url]: https://david-dm.org/webpack/css-loader
+
+[tests]: http://img.shields.io/travis/webpack/css-loader.svg
+[tests-url]: https://travis-ci.org/webpack/css-loader
+
+[cover]: https://coveralls.io/repos/github/webpack/css-loader/badge.svg
+[cover-url]: https://coveralls.io/github/webpack/css-loader
+
+[chat]: https://badges.gitter.im/webpack/webpack.svg
+[chat-url]: https://gitter.im/webpack/webpack

package/index.js

@@ -1,5 +1,5 @@
-/*
-	MIT License http://www.opensource.org/licenses/mit-license.php
-	Author Tobias Koppers @sokra
-*/
-module.exports = require("./lib/loader");
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Tobias Koppers @sokra
+*/
+module.exports = require("./lib/loader");

package/lib/compile-exports.js

@@ -1,29 +1,38 @@
-var camelCase = require("lodash.camelcase");
-
-function dashesCamelCase(str) {
-  return str.replace(/-(\w)/g, function(match, firstLetter) {
-    return firstLetter.toUpperCase();
-  });
-}
-
-module.exports = function compileExports(result, importItemMatcher, camelCaseKeys) {
-  if (!Object.keys(result.exports).length) {
-    return "";
-  }
-
-  var exportJs = Object.keys(result.exports).reduce(function(res, key) {
-    var valueAsString = JSON.stringify(result.exports[key]);
-    valueAsString = valueAsString.replace(result.importItemRegExpG, importItemMatcher);
-    res.push("\t" + JSON.stringify(key) + ": " + valueAsString);
-
-    if (camelCaseKeys === true) {
-      res.push("\t" + JSON.stringify(camelCase(key)) + ": " + valueAsString);
-    } else if (camelCaseKeys === 'dashes') {
-      res.push("\t" + JSON.stringify(dashesCamelCase(key)) + ": " + valueAsString);
-    }
-
-    return res;
-  }, []).join(",\n");
-
-  return "{\n" + exportJs + "\n}";
-};
+var camelCase = require("lodash.camelcase");
+
+function dashesCamelCase(str) {
+  return str.replace(/-(\w)/g, function(match, firstLetter) {
+    return firstLetter.toUpperCase();
+  });
+}
+
+module.exports = function compileExports(result, importItemMatcher, camelCaseKeys) {
+  if (!Object.keys(result.exports).length) {
+    return "";
+  }
+
+  var exportJs = Object.keys(result.exports).reduce(function(res, key) {
+    var valueAsString = JSON.stringify(result.exports[key]);
+    valueAsString = valueAsString.replace(result.importItemRegExpG, importItemMatcher);
+    function addEntry(k) {
+      res.push("\t" + JSON.stringify(k) + ": " + valueAsString);
+    }
+    addEntry(key);
+
+    var targetKey;
+    if (camelCaseKeys === true) {
+      targetKey = camelCase(key);
+      if (targetKey !== key) {
+        addEntry(targetKey);
+      }
+    } else if (camelCaseKeys === 'dashes') {
+      targetKey = dashesCamelCase(key);
+      if (targetKey !== key) {
+        addEntry(targetKey);
+      }
+    }
+    return res;
+  }, []).join(",\n");
+
+  return "{\n" + exportJs + "\n}";
+};