feat(aurelia): Add an Aurelia plugin option and expose module resolve

index.js

@@ -629,6 +629,33 @@ const publicApi = {
         return this;
     },
 
+    /**
+     * If enabled, the Aurelia plugin is enabled
+     *
+     * https://github.com/aurelia/webpack-plugin
+     *
+     * Encore.enableAureliaPlugin();
+     *
+     * or with configuration options:
+     *
+     * Encore.enableAureliaPlugin(function(options) {
+     *      // Set the startup module to hint webpack to module tracing
+     *      options.aureliaApp = "main";
+     * });
+     *
+     * Read about more configuration options that are available:
+     *
+     * https://github.com/aurelia/webpack-plugin/wiki
+     *
+     * @param {function} aureliaPluginOptionsCallback
+     * @returns {exports}
+     */
+    enableAureliaPlugin(aureliaPluginOptionsCallback = () => {}) {
+        webpackConfig.enableAureliaPlugin(aureliaPluginOptionsCallback);
+
+        return this;
+    },
+
     /**
      * If enabled, display build notifications using
      * webpack-notifier.
@@ -705,6 +732,12 @@ const publicApi = {
         return this;
     },
 
+    configureResolveModules(directories) {
+        webpackConfig.configureResolveModules(directories);
+
+        return this;
+    },
+
     /**
      * If enabled, the output directory is emptied between each build (to remove old files).
      *

lib/WebpackConfig.js

@@ -45,6 +45,7 @@ class WebpackConfig {
         this.sharedCommonsEntryName = null;
         this.providedVariables = {};
         this.configuredFilenames = {};
+        this.resolveModules = null;
 
         // Features/Loaders flags
         this.useVersioning = false;
@@ -59,6 +60,7 @@ class WebpackConfig {
         this.useReact = false;
         this.usePreact = false;
         this.useVueLoader = false;
+        this.useAurelia = false;
         this.useTypeScriptLoader = false;
         this.useForkedTypeScriptTypeChecking = false;
         this.useWebpackNotifier = false;
@@ -93,6 +95,7 @@ class WebpackConfig {
         this.manifestPluginOptionsCallback = () => {};
         this.uglifyJsPluginOptionsCallback = () => {};
         this.notifierPluginOptionsCallback = () => {};
+        this.aureliaPluginOptionsCallback = () => {};
     }
 
     getContext() {
@@ -403,6 +406,16 @@ class WebpackConfig {
         this.vueLoaderOptionsCallback = vueLoaderOptionsCallback;
     }
 
+    enableAureliaPlugin(aureliaPluginOptionsCallback = () => {}) {
+        this.useAurelia = true;
+
+        if (typeof aureliaPluginOptionsCallback !== 'function') {
+            throw new Error('Argument 1 to enableVueLoader() must be a callback function.');
+        }
+
+        this.aureliaPluginOptionsCallback = aureliaPluginOptionsCallback;
+    }
+
     enableBuildNotifications(enabled = true, notifierPluginOptionsCallback = () => {}) {
         if (typeof notifierPluginOptionsCallback !== 'function') {
             throw new Error('Argument 2 to enableBuildNotifications() must be a callback function.');
@@ -436,6 +449,14 @@ class WebpackConfig {
         this.configuredFilenames = configuredFilenames;
     }
 
+    configureResolveModules(directories = ['node_modules']) {
+        if (!Array.isArray(directories)) {
+            throw new Error('Argument 1 to configureResolveModules() must be an Array of directories - e.g. [\'./path/to/modules\']');
+        }
+
+        this.resolveModules = directories;
+    }
+
     cleanupOutputBeforeBuild(paths = ['**/*'], cleanWebpackPluginOptionsCallback = () => {}) {
         if (!Array.isArray(paths)) {
             throw new Error('Argument 1 to cleanupOutputBeforeBuild() must be an Array of paths - e.g. [\'**/*\']');

lib/config-generator.js

@@ -19,6 +19,7 @@ const stylusLoaderUtil = require('./loaders/stylus');
 const babelLoaderUtil = require('./loaders/babel');
 const tsLoaderUtil = require('./loaders/typescript');
 const vueLoaderUtil = require('./loaders/vue');
+
 // plugins utils
 const extractTextPluginUtil = require('./plugins/extract-text');
 const deleteUnusedEntriesPluginUtil = require('./plugins/delete-unused-entries');
@@ -33,6 +34,7 @@ const uglifyPluginUtil = require('./plugins/uglify');
 const friendlyErrorPluginUtil = require('./plugins/friendly-errors');
 const assetOutputDisplay = require('./plugins/asset-output-display');
 const notifierPluginUtil = require('./plugins/notifier');
+const aureliaPluginUtil = require('./plugins/aurelia');
 const PluginPriorities = require('./plugins/plugin-priorities');
 
 class ConfigGenerator {
@@ -89,6 +91,10 @@ class ConfigGenerator {
             config.resolve.alias['react-dom'] = 'preact-compat';
         }
 
+        if (this.webpackConfig.resolveModules) {
+            config.resolve.modules = this.webpackConfig.resolveModules;
+        }
+
         return config;
     }
 
@@ -209,6 +215,12 @@ class ConfigGenerator {
             });
         }
 
+        if (this.webpackConfig.useAurelia) {
+            rules.push(
+                { test: /\.html$/i, use: 'html-loader' }
+            );
+        }
+
         this.webpackConfig.loaders.forEach((loader) => {
             rules.push(loader);
         });
@@ -243,6 +255,8 @@ class ConfigGenerator {
 
         notifierPluginUtil(plugins, this.webpackConfig);
 
+        aureliaPluginUtil(plugins, this.webpackConfig);
+
         if (!this.webpackConfig.runtimeConfig.outputJson) {
             const friendlyErrorPlugin = friendlyErrorPluginUtil(this.webpackConfig);
             plugins.push({

lib/features.js

@@ -63,6 +63,11 @@ const features = {
         packages: ['vue', 'vue-loader', 'vue-template-compiler'],
         description: 'load VUE files'
     },
+    aurelia: {
+        method: 'enableAureliaPlugin()',
+        packages: ['aurelia-webpack-plugin'],
+        description: 'Build Aurelia projects'
+    },
     notifier: {
         method: 'enableBuildNotifications()',
         packages: ['webpack-notifier'],

lib/plugins/aurelia.js

@@ -0,0 +1,37 @@
+/*
+ * This file is part of the Symfony Webpack Encore package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+const PluginPriorities = require('./plugin-priorities');
+const loaderFeatures = require('../features');
+const { AureliaPlugin } = require('aurelia-webpack-plugin');
+
+/**
+ * @param {Array} plugins
+ * @param {WebpackConfig} webpackConfig
+ * @return {void}
+ */
+module.exports = function(plugins, webpackConfig) {
+    if (!webpackConfig.useAurelia) return;
+
+    loaderFeatures.ensurePackagesExist('aurelia');
+
+    const aureliaPluginOptions = {};
+
+    webpackConfig.aureliaPluginOptionsCallback.apply(
+        aureliaPluginOptions,
+        [aureliaPluginOptions]
+    );
+
+    plugins.push({
+        plugin: new AureliaPlugin(aureliaPluginOptions),
+        priority: PluginPriorities.AureliaPlugin
+    });
+};

lib/plugins/plugin-priorities.js

@@ -26,4 +26,5 @@ module.exports = {
     NamedModulesPlugin: 0,
     WebpackChunkHash: 0,
     WebpackNotifier: 0,
+    AureliaPlugin: 0
 };

package.json

@@ -49,6 +49,7 @@
     "yargs": "^8.0.1"
   },
   "devDependencies": {
+    "aurelia-webpack-plugin": "^2.0.0-rc.5",
     "autoprefixer": "^6.7.7",
     "babel-plugin-transform-react-jsx": "^6.24.1",
     "babel-preset-es2015": "^6.24.1",

test/config-generator.js

@@ -619,4 +619,43 @@ describe('The config-generator function', () => {
             });
         });
     });
+
+    describe('Test resolveModules option', () => {
+        it('should not appear in config if not set', () => {
+            const config = createConfig();
+            config.outputPath = '/tmp/public/build';
+            config.setPublicPath('/build/');
+
+            const actualConfig = configGenerator(config);
+
+            expect(actualConfig.resolve).not.to.include.keys('modules');
+        });
+
+        it('should have node_modules set as default if called without arguments', () => {
+            const config = createConfig();
+            config.outputPath = '/tmp/public/build';
+            config.setPublicPath('/build/');
+            config.configureResolveModules();
+
+            const actualConfig = configGenerator(config);
+
+            expect(actualConfig.resolve.modules.length).to.equal(1);
+            expect(actualConfig.resolve.modules[0]).to.equal('node_modules');
+        });
+
+        it('should set the module paths used as arguments', () => {
+            const config = createConfig();
+            config.outputPath = '/tmp/public/build';
+            config.setPublicPath('/build/');
+
+            const modulePath = '/foo/bar';
+
+            config.configureResolveModules([modulePath]);
+
+            const actualConfig = configGenerator(config);
+
+            expect(actualConfig.resolve.modules.length).to.equal(1);
+            expect(actualConfig.resolve.modules[0]).to.equal(modulePath);
+        });
+    });
 });

test/plugins/aurelia.js

@@ -0,0 +1,50 @@
+/*
+ * This file is part of the Symfony Webpack Encore package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+const expect = require('chai').expect;
+const { AureliaPlugin } = require('aurelia-webpack-plugin');
+const WebpackConfig = require('../../lib/WebpackConfig');
+const RuntimeConfig = require('../../lib/config/RuntimeConfig');
+const aureliaPluginUtil = require('../../lib/plugins/aurelia');
+
+function createConfig() {
+    const runtimeConfig = new RuntimeConfig();
+    runtimeConfig.context = __dirname;
+    runtimeConfig.babelRcFileExists = false;
+
+    return new WebpackConfig(runtimeConfig);
+}
+describe('plugins/aurelia', () => {
+    it('is disabled by default', () => {
+        const config = createConfig();
+        const plugins = [];
+
+        aureliaPluginUtil(plugins, config);
+        expect(plugins.length).to.equal(0);
+    });
+
+    it('uses an options callback', () => {
+        const config = createConfig();
+        const plugins = [];
+
+        config.enableAureliaPlugin((options) => {
+            options.aureliaApp = 'foo';
+        });
+
+        aureliaPluginUtil(plugins, config);
+
+        expect(plugins.length).to.equal(1);
+        expect(plugins[0].plugin).to.be.instanceOf(AureliaPlugin);
+
+        // Ensure that the options were set
+        expect(plugins[0].plugin.options.aureliaApp).to.equal('foo');
+    });
+});