feature #300 Allow to replace options in configuration callbacks (Lyrkan)

This PR was squashed before being merged into the master branch (closes #300).

Discussion
----------

Allow to replace options in configuration callbacks

This PR closes #298 by using the return value of callback functions (for loaders/plugins) as options if it is an object.

For instance:

```js
Encore.configureUglifyJsPlugin((options) => {
    return {
        ...options,
        beautify: true
    };
});
```

Commits
-------

3dfc787 Revert a forgotten 'let' to a 'const'
ef992c1 Replace duplicated 'options callback' logic by an utility method
ecb623c Allow to replace options in configuration callbacks

Author: weaverryan

lib/config-generator.js

@@ -223,7 +223,7 @@ class ConfigGenerator {
         if (this.webpackConfig.useVueLoader) {
             rules.push({
                 test: /\.vue$/,
-                use: vueLoaderUtil.getLoaders(this.webpackConfig, this.webpackConfig.vueLoaderOptionsCallback)
+                use: vueLoaderUtil.getLoaders(this.webpackConfig)
             });
         }
 

lib/loaders/babel.js

@@ -10,6 +10,7 @@
 'use strict';
 
 const loaderFeatures = require('../features');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
@@ -67,12 +68,7 @@ module.exports = {
                 }
             }
 
-            // allow for babel config to be controlled
-            webpackConfig.babelConfigurationCallback.apply(
-                // use babelConfig as the this variable
-                babelConfig,
-                [babelConfig]
-            );
+            babelConfig = applyOptionsCallback(webpackConfig.babelConfigurationCallback, babelConfig);
         }
 
         return [

lib/loaders/coffee-script.js

@@ -10,6 +10,7 @@
 'use strict';
 
 const loaderFeatures = require('../features');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
@@ -26,16 +27,10 @@ module.exports = {
             }
         };
 
-        // allow options to be configured
-        webpackConfig.coffeeScriptConfigurationCallback.apply(
-            options,
-            [options]
-        );
-
         return [
             {
                 loader: 'coffee-loader',
-                options: options,
+                options: applyOptionsCallback(webpackConfig.coffeeScriptConfigurationCallback, options)
             },
         ];
     }

lib/loaders/css.js

@@ -10,6 +10,7 @@
 'use strict';
 
 const loaderFeatures = require('../features');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
@@ -42,16 +43,9 @@ module.exports = {
                 sourceMap: webpackConfig.useSourceMaps
             };
 
-            // allow options to be configured
-            webpackConfig.postCssLoaderOptionsCallback.apply(
-                // use config as the this variable
-                postCssLoaderOptions,
-                [postCssLoaderOptions]
-            );
-
             cssLoaders.push({
                 loader: 'postcss-loader',
-                options: postCssLoaderOptions
+                options: applyOptionsCallback(webpackConfig.postCssLoaderOptionsCallback, postCssLoaderOptions)
             });
         }
 

lib/loaders/less.js

@@ -11,6 +11,7 @@
 
 const loaderFeatures = require('../features');
 const cssLoader = require('./css');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
@@ -25,18 +26,11 @@ module.exports = {
             sourceMap: webpackConfig.useSourceMaps
         };
 
-        // allow options to be configured
-        webpackConfig.lessLoaderOptionsCallback.apply(
-            // use config as the this variable
-            config,
-            [config]
-        );
-
         return [
             ...cssLoader.getLoaders(webpackConfig, ignorePostCssLoader),
             {
                 loader: 'less-loader',
-                options: config
+                options: applyOptionsCallback(webpackConfig.lessLoaderOptionsCallback, config)
             },
         ];
     }

lib/loaders/sass.js

@@ -11,6 +11,7 @@
 
 const loaderFeatures = require('../features');
 const cssLoader = require('./css');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
@@ -35,21 +36,14 @@ module.exports = {
             });
         }
 
-        let config = Object.assign({}, sassOptions, {
+        const config = Object.assign({}, sassOptions, {
             // needed by the resolve-url-loader
             sourceMap: (true === webpackConfig.sassOptions.resolveUrlLoader) || webpackConfig.useSourceMaps
         });
 
-        // allow options to be configured
-        webpackConfig.sassLoaderOptionsCallback.apply(
-            // use config as the this variable
-            config,
-            [config]
-        );
-
         sassLoaders.push({
             loader: 'sass-loader',
-            options: config,
+            options: applyOptionsCallback(webpackConfig.sassLoaderOptionsCallback, config)
         });
 
         return sassLoaders;

lib/loaders/stylus.js

@@ -11,6 +11,7 @@
 
 const loaderFeatures = require('../features');
 const cssLoader = require('./css');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
@@ -25,18 +26,11 @@ module.exports = {
             sourceMap: webpackConfig.useSourceMaps
         };
 
-        // allow options to be configured
-        webpackConfig.stylusLoaderOptionsCallback.apply(
-            // use config as the this variable
-            config,
-            [config]
-        );
-
         return [
             ...cssLoader.getLoaders(webpackConfig, ignorePostCssLoader),
             {
                 loader: 'stylus-loader',
-                options: config
+                options: applyOptionsCallback(webpackConfig.stylusLoaderOptionsCallback, config)
             },
         ];
     }

lib/loaders/typescript.js

@@ -11,6 +11,7 @@
 
 const loaderFeatures = require('../features');
 const babelLoader = require('./babel');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
@@ -26,11 +27,7 @@ module.exports = {
         };
 
         // allow for ts-loader config to be controlled
-        webpackConfig.tsConfigurationCallback.apply(
-            // use config as the this variable
-            config,
-            [config]
-        );
+        config = applyOptionsCallback(webpackConfig.tsConfigurationCallback, config);
 
         // fork-ts-checker-webpack-plugin integration
         if (webpackConfig.useForkedTypeScriptTypeChecking) {

lib/loaders/vue.js

@@ -15,14 +15,14 @@ const sassLoaderUtil = require('./sass');
 const lessLoaderUtil = require('./less');
 const babelLoaderUtil = require('./babel');
 const extractText = require('./extract-text');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
- * @param {function} vueLoaderOptionsCallback
  * @return {Array} of loaders to use for Vue files
  */
 module.exports = {
-    getLoaders(webpackConfig, vueLoaderOptionsCallback) {
+    getLoaders(webpackConfig) {
         loaderFeatures.ensurePackagesExist('vue');
 
         /*
@@ -117,16 +117,14 @@ module.exports = {
             };
         }
 
-        let options = {
+        const options = {
             loaders: loaders
         };
-        // allow the options to be mutated via a callback
-        vueLoaderOptionsCallback(options);
 
         return [
             {
                 loader: 'vue-loader',
-                options: options
+                options: applyOptionsCallback(webpackConfig.vueLoaderOptionsCallback, options)
             }
         ];
     }

lib/plugins/clean.js

@@ -11,6 +11,7 @@
 
 const CleanWebpackPlugin = require('clean-webpack-plugin');
 const PluginPriorities = require('./plugin-priorities');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * Updates plugins array passed adding CleanWebpackPlugin instance
@@ -30,15 +31,10 @@ module.exports = function(plugins, webpackConfig) {
         verbose: false,
     };
 
-    webpackConfig.cleanWebpackPluginOptionsCallback.apply(
-        cleanWebpackPluginOptions,
-        [cleanWebpackPluginOptions]
-    );
-
     plugins.push({
         plugin: new CleanWebpackPlugin(
             webpackConfig.cleanWebpackPluginPaths,
-            cleanWebpackPluginOptions
+            applyOptionsCallback(webpackConfig.cleanWebpackPluginOptionsCallback, cleanWebpackPluginOptions)
         ),
         priority: PluginPriorities.CleanWebpackPlugin
     });

lib/plugins/define.js

@@ -11,6 +11,7 @@
 
 const webpack = require('webpack');
 const PluginPriorities = require('./plugin-priorities');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {Array} plugins
@@ -24,13 +25,10 @@ module.exports = function(plugins, webpackConfig) {
         }
     };
 
-    webpackConfig.definePluginOptionsCallback.apply(
-        definePluginOptions,
-        [definePluginOptions]
-    );
-
     plugins.push({
-        plugin: new webpack.DefinePlugin(definePluginOptions),
+        plugin: new webpack.DefinePlugin(
+            applyOptionsCallback(webpackConfig.definePluginOptionsCallback, definePluginOptions)
+        ),
         priority: PluginPriorities.DefinePlugin
     });
 };

lib/plugins/extract-text.js

@@ -11,6 +11,7 @@
 
 const ExtractTextPlugin = require('extract-text-webpack-plugin');
 const PluginPriorities = require('./plugin-priorities');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {Array} plugins
@@ -45,13 +46,10 @@ module.exports = function(plugins, webpackConfig) {
         allChunks: false
     };
 
-    webpackConfig.extractTextPluginOptionsCallback.apply(
-        extractTextPluginOptions,
-        [extractTextPluginOptions]
-    );
-
     plugins.push({
-        plugin: new ExtractTextPlugin(extractTextPluginOptions),
+        plugin: new ExtractTextPlugin(
+            applyOptionsCallback(webpackConfig.extractTextPluginOptionsCallback, extractTextPluginOptions)
+        ),
         priority: PluginPriorities.ExtractTextWebpackPlugin
     });
 };

lib/plugins/forked-ts-types.js

@@ -11,23 +11,19 @@
 
 const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin'); // eslint-disable-line
 const PluginPriorities = require('./plugin-priorities');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
  * @return {void}
  */
 module.exports = function(webpackConfig) {
-    let config = {};
-
-    // allow for ts-loader config to be controlled
-    webpackConfig.forkedTypeScriptTypesCheckOptionsCallback.apply(
-        // use config as the this variable
-        config,
-        [config]
-    );
+    const config = {};
 
     webpackConfig.addPlugin(
-        new ForkTsCheckerWebpackPlugin(config),
+        new ForkTsCheckerWebpackPlugin(
+            applyOptionsCallback(webpackConfig.forkedTypeScriptTypesCheckOptionsCallback, config)
+        ),
         PluginPriorities.ForkTsCheckerWebpackPlugin
     );
 };

lib/plugins/friendly-errors.js

@@ -16,6 +16,7 @@ const missingPostCssConfigTransformer = require('../friendly-errors/transformers
 const missingPostCssConfigFormatter = require('../friendly-errors/formatters/missing-postcss-config');
 const vueUnactivatedLoaderTransformer = require('../friendly-errors/transformers/vue-unactivated-loader-error');
 const vueUnactivatedLoaderFormatter = require('../friendly-errors/formatters/vue-unactivated-loader-error');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {WebpackConfig} webpackConfig
@@ -39,10 +40,7 @@ module.exports = function(webpackConfig) {
         }
     };
 
-    webpackConfig.friendlyErrorsPluginOptionsCallback.apply(
-        friendlyErrorsPluginOptions,
-        [friendlyErrorsPluginOptions]
+    return new FriendlyErrorsWebpackPlugin(
+        applyOptionsCallback(webpackConfig.friendlyErrorsPluginOptionsCallback, friendlyErrorsPluginOptions)
     );
-
-    return new FriendlyErrorsWebpackPlugin(friendlyErrorsPluginOptions);
 };

lib/plugins/loader-options.js

@@ -11,6 +11,7 @@
 
 const webpack = require('webpack');
 const PluginPriorities = require('./plugin-priorities');
+const applyOptionsCallback = require('../utils/apply-options-callback');
 
 /**
  * @param {Array} plugins
@@ -35,13 +36,10 @@ module.exports = function(plugins, webpackConfig) {
         }
     };
 
-    webpackConfig.loaderOptionsPluginOptionsCallback.apply(
-        loaderOptionsPluginOptions,
-        [loaderOptionsPluginOptions]
-    );
-
     plugins.push({
-        plugin: new webpack.LoaderOptionsPlugin(loaderOptionsPluginOptions),
+        plugin: new webpack.LoaderOptionsPlugin(
+            applyOptionsCallback(webpackConfig.loaderOptionsPluginOptionsCallback, loaderOptionsPluginOptions)
+        ),
         priority: PluginPriorities.LoaderOptionsPlugin
     });
 };