feat: exportLocalsStyle was remove in favor new localsConvention (#958)

BREAKING CHANGE: rename `exportLocalsStyle` option to `localsConvention` option

Author: evilebottnawi

README.md

@@ -109,15 +109,15 @@ 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        |
-| **[`exportLocalsStyle`](#exportlocalsstyle)** |         `{String}`          | `asIs`  | Setup style of exported classnames                 |
-|        **[`onlyLocals`](#onlylocals)**        |         `{Boolean}`         | `false` | Export only locals                                 |
+|                    Name                     |            Type             | Default | Description                                        |
+| :-----------------------------------------: | :-------------------------: | :-----: | :------------------------------------------------- |
+|              **[`url`](#url)**              |    `{Boolean\|Function}`    | `true`  | Enable/Disable `url()` handling                    |
+|           **[`import`](#import)**           |    `{Boolean\|Function}`    | `true`  | Enable/Disable @import handling                    |
+|          **[`modules`](#modules)**          | `{Boolean\|String\|Object}` | `false` | Enable/Disable CSS Modules and setup their options |
+|        **[`sourceMap`](#sourcemap)**        |         `{Boolean}`         | `false` | Enable/Disable Sourcemaps                          |
+|    **[`importLoaders`](#importloaders)**    |         `{Number}`          |   `0`   | Number of loaders applied before CSS loader        |
+| **[`localsConvention`](#localsconvention)** |         `{String}`          | `asIs`  | Setup style of exported classnames                 |
+|       **[`onlyLocals`](#onlylocals)**       |         `{Boolean}`         | `false` | Export only locals                                 |
 
 ### `url`
 
@@ -763,7 +763,7 @@ module.exports = {
 
 This may change in the future when the module system (i. e. webpack) supports loader matching by origin.
 
-### `exportLocalsStyle`
+### `localsConvention`
 
 Type: `String`
 Default: `undefined`
@@ -801,7 +801,7 @@ module.exports = {
         test: /\.css$/i,
         loader: 'css-loader',
         options: {
-          exportLocalsStyle: 'camelCase',
+          localsConvention: 'camelCase',
         },
       },
     ],

src/index.js

@@ -64,7 +64,7 @@ export default function loader(content, map, meta) {
     icssParser({
       loaderContext: this,
       importPrefix,
-      exportLocalsStyle: options.exportLocalsStyle,
+      localsConvention: options.localsConvention,
     })
   );
 

src/options.json

@@ -84,7 +84,7 @@
         }
       ]
     },
-    "exportLocalsStyle": {
+    "localsConvention": {
       "anyOf": [
         {
           "type": "string",

src/plugins/postcss-icss-parser.js

@@ -67,7 +67,7 @@ export default postcss.plugin(
 
         result.messages.push({
           pluginName,
-          export: getExportItemCode(name, value, options.exportLocalsStyle),
+          export: getExportItemCode(name, value, options.localsConvention),
           type: 'export',
           item: { name, value },
         });

src/utils.js

@@ -253,15 +253,15 @@ function getModuleCode(result, sourceMap, onlyLocals) {
   )}, ""${sourceMap && result.map ? `,${result.map}` : ''}]);\n`;
 }
 
-function getExportItemCode(key, value, localsStyle) {
+function getExportItemCode(key, value, localsConvention) {
   let targetKey;
   const items = [];
 
   function addEntry(k) {
     items.push(`\t${JSON.stringify(k)}: ${JSON.stringify(value)}`);
   }
 
-  switch (localsStyle) {
+  switch (localsConvention) {
     case 'camelCase':
       addEntry(key);
       targetKey = camelCase(key);