Completing vue-loader support

Author: weaverryan

fixtures/vuejs/App.vue

@@ -0,0 +1,50 @@
+<template>
+  <div id="app">
+    <img src="./assets/logo.png">
+    <hello></hello>
+  </div>
+</template>
+
+<script>
+import Hello from './components/Hello'
+
+class TestClassSyntax {
+
+}
+
+export default {
+  name: 'app',
+  components: {
+    Hello
+  }
+}
+</script>
+
+<style>
+#app {
+  font-family: 'Avenir', Helvetica, Arial, sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  text-align: center;
+  color: #2c3e50;
+  margin-top: 60px;
+}
+</style>
+
+<style lang="scss">
+#app {
+  display: flex;
+  color: #2c3e90;
+}
+</style>
+
+<style lang="sass">
+#app
+  color: #2c3e90
+</style>
+
+<style lang="less">
+#app {
+  margin-top: 40px;
+}
+</style>

fixtures/vuejs/assets/logo.png

@@ -0,0 +1,53 @@
+<template>
+  <div class="hello">
+    <h1>{{ msg }}</h1>
+    <h2>Essential Links</h2>
+    <ul>
+      <li><a href="https://vuejs.org" target="_blank">Core Docs</a></li>
+      <li><a href="https://forum.vuejs.org" target="_blank">Forum</a></li>
+      <li><a href="https://gitter.im/vuejs/vue" target="_blank">Gitter Chat</a></li>
+      <li><a href="https://twitter.com/vuejs" target="_blank">Twitter</a></li>
+      <br>
+      <li><a href="http://vuejs-templates.github.io/webpack/" target="_blank">Docs for This Template</a></li>
+    </ul>
+    <h2>Ecosystem</h2>
+    <ul>
+      <li><a href="http://router.vuejs.org/" target="_blank">vue-router</a></li>
+      <li><a href="http://vuex.vuejs.org/" target="_blank">vuex</a></li>
+      <li><a href="http://vue-loader.vuejs.org/" target="_blank">vue-loader</a></li>
+      <li><a href="https://github.com/vuejs/awesome-vue" target="_blank">awesome-vue</a></li>
+    </ul>
+  </div>
+</template>
+
+<script>
+export default {
+  name: 'hello',
+  data () {
+    return {
+      msg: 'Welcome to Your Vue.js App'
+    }
+  }
+}
+</script>
+
+<!-- Add "scoped" attribute to limit CSS to this component only -->
+<style scoped>
+h1, h2 {
+  font-weight: normal;
+}
+
+ul {
+  list-style-type: none;
+  padding: 0;
+}
+
+li {
+  display: inline-block;
+  margin: 0 10px;
+}
+
+a {
+  color: #42b983;
+}
+</style>

fixtures/vuejs/components/Hello.vue

@@ -0,0 +1,8 @@
+import Vue from 'vue'
+import App from './App'
+
+new Vue({
+  el: '#app',
+  template: '<App/>',
+  components: { App }
+})

fixtures/vuejs/main.js

@@ -330,7 +330,8 @@ module.exports = {
     },
 
     /**
-     * If enabled, the react preset is added to Babel:
+     * If enabled, the react preset is added to Babel.
+     *
      * https://babeljs.io/docs/plugins/preset-react/
      *
      * @returns {exports}
@@ -342,14 +343,15 @@ module.exports = {
     },
 
     /**
-     * If enabled, the vue-loader is added:
-     * https://vue-loader.vuejs.org/en/
+     * If enabled, the Vue.js loader is enabled.
      *
-     * @param {object} options see https://vue-loader.vuejs.org/en/configurations/advanced.html
-     * @return {exports}
+     * https://github.com/vuejs/vue-loader
+     *
+     * @param {object} vueLoaderOptions: https://vue-loader.vuejs.org/en/configurations/advanced.html
+     * @returns {exports}
      */
-    enableVueLoader(options = {}) {
-        webpackConfig.enableVueLoader(options);
+    enableVueLoader(vueLoaderOptions = {}) {
+        webpackConfig.enableVueLoader(vueLoaderOptions);
 
         return this;
     },

index.js

@@ -45,13 +45,13 @@ class WebpackConfig {
             resolve_url_loader: true
         };
         this.useLessLoader = false;
-        this.useVueLoader = false;
-        this.vueOptions = {};
         this.cleanupOutput = false;
         this.sharedCommonsEntryName = null;
         this.providedVariables = {};
         this.babelConfigurationCallback = function() {};
         this.useReact = false;
+        this.useVueLoader = false;
+        this.vueLoaderOptions = {};
         this.loaders = [];
     }
 
@@ -224,9 +224,9 @@ class WebpackConfig {
         this.useReact = true;
     }
 
-    enableVueLoader(options) {
+    enableVueLoader(vueLoaderOptions = {}) {
         this.useVueLoader = true;
-        this.vueOptions = options;
+        this.vueLoaderOptions = vueLoaderOptions;
     }
 
     cleanupOutputBeforeBuild() {

lib/WebpackConfig.js

@@ -11,6 +11,7 @@
 
 const webpack = require('webpack');
 const ExtractTextPlugin = require('extract-text-webpack-plugin');
+const extractText = require('./loaders/extract-text');
 const ManifestPlugin = require('./webpack/webpack-manifest-plugin');
 const DeleteUnusedEntriesJSPlugin = require('./webpack/delete-unused-entries-js-plugin');
 const AssetOutputDisplayPlugin = require('./friendly-errors/asset-output-display-plugin');
@@ -26,6 +27,7 @@ const cssLoaderUtil = require('./loaders/css');
 const sassLoaderUtil = require('./loaders/sass');
 const lessLoaderUtil = require('./loaders/less');
 const babelLoaderUtil = require('./loaders/babel');
+const vueLoaderUtil = require('./loaders/vue');
 
 class ConfigGenerator {
     /**
@@ -68,7 +70,10 @@ class ConfigGenerator {
         config.stats = this.buildStatsConfig();
 
         config.resolve = {
-            extensions: ['.js', '.jsx']
+            extensions: ['.js', '.jsx', '.vue'],
+            alias: {
+                'vue$': 'vue/dist/vue.esm.js',
+            }
         };
 
         return config;
@@ -111,10 +116,7 @@ class ConfigGenerator {
             },
             {
                 test: /\.css$/,
-                use: ExtractTextPlugin.extract({
-                    fallback: 'style-loader' + this.getSourceMapOption(),
-                    use: cssLoaderUtil.getLoaders(this.webpackConfig)
-                })
+                use: extractText.extract(this.webpackConfig, cssLoaderUtil.getLoaders(this.webpackConfig, false))
             },
             {
                 test: /\.(png|jpg|jpeg|gif|ico|svg)$/,
@@ -137,30 +139,21 @@ class ConfigGenerator {
         if (this.webpackConfig.useSassLoader) {
             rules.push({
                 test: /\.s[ac]ss$/,
-                use: ExtractTextPlugin.extract({
-                    fallback: 'style-loader' + this.getSourceMapOption(),
-                    use: sassLoaderUtil.getLoaders(this.webpackConfig)
-                })
+                use: extractText.extract(this.webpackConfig, sassLoaderUtil.getLoaders(this.webpackConfig))
             });
         }
 
         if (this.webpackConfig.useLessLoader) {
             rules.push({
                 test: /\.less/,
-                use: ExtractTextPlugin.extract({
-                    fallback: 'style-loader' + this.getSourceMapOption(),
-                    use: lessLoaderUtil.getLoaders(this.webpackConfig)
-                })
+                use: extractText.extract(this.webpackConfig, lessLoaderUtil.getLoaders(this.webpackConfig))
             });
         }
 
         if (this.webpackConfig.useVueLoader) {
-            loaderFeatures.ensureLoaderPackagesExist('vue');
-
             rules.push({
-                test: /\.vue/,
-                loader: 'vue-loader',
-                options: this.webpackConfig.vueOptions
+                test: /\.vue$/,
+                use: vueLoaderUtil.getLoaders(this.webpackConfig, this.webpackConfig.vueLoaderOptions)
             });
         }
 
@@ -387,10 +380,6 @@ class ConfigGenerator {
             https: this.webpackConfig.useDevServerInHttps()
         };
     }
-
-    getSourceMapOption() {
-        return this.webpackConfig.useSourceMaps ? '?sourceMap' : '';
-    }
 }
 
 /**

lib/config-generator.js

@@ -38,7 +38,9 @@ const loaderFeatures = {
     },
     vue: {
         method: 'enableVueLoader()',
-        packages: ['vue-loader', 'vue-template-compiler'],
+        // vue is needed so the end-user can do things
+        // vue-template-compiler is a peer dep of vue-loader
+        packages: ['vue', 'vue-loader', 'vue-template-compiler'],
         description: 'load VUE files'
     }
 };

lib/loader-features.js

@@ -13,10 +13,11 @@ const loaderFeatures = require('../loader-features');
 
 /**
  * @param {WebpackConfig} webpackConfig
+ * @param {bool} ignorePostCssLoader If true, postcss-loader will never be added
  * @return {Array} of loaders to use for CSS files
  */
 module.exports = {
-    getLoaders(webpackConfig) {
+    getLoaders(webpackConfig, skipPostCssLoader) {
         const cssLoaders = [
             {
                 loader: 'css-loader',
@@ -27,7 +28,7 @@ module.exports = {
             },
         ];
 
-        if (webpackConfig.usePostCssLoader) {
+        if (webpackConfig.usePostCssLoader && !skipPostCssLoader) {
             loaderFeatures.ensureLoaderPackagesExist('postcss');
 
             cssLoaders.push({

lib/loaders/css.js

@@ -0,0 +1,29 @@
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+const ExtractTextPlugin = require('extract-text-webpack-plugin');
+
+/**
+ * Wraps style loaders with the ExtractTextPlugin.
+ *
+ * @param {WebpackConfig} webpackConfig
+ * @param {Array} loaders An array of some style loaders
+ * @param {bool} useVueStyleLoader
+ * @return {Array}
+ */
+module.exports = {
+    extract(webpackConfig, loaders, useVueStyleLoader = false) {
+        return ExtractTextPlugin.extract({
+            fallback: (useVueStyleLoader ? 'vue-style-loader' : 'style-loader') + (webpackConfig.useSourceMaps ? '?sourceMap' : ''),
+            use: loaders
+        });
+    }
+};

lib/loaders/extract-text.js

@@ -14,14 +14,15 @@ const cssLoader = require('./css');
 
 /**
  * @param {WebpackConfig} webpackConfig
+ * @param {bool} ignorePostCssLoader If true, postcss-loader will never be added
  * @return {Array} of loaders to use for Less files
  */
 module.exports = {
-    getLoaders(webpackConfig) {
+    getLoaders(webpackConfig, ignorePostCssLoader = false) {
         loaderFeatures.ensureLoaderPackagesExist('less');
 
         return [
-            ...cssLoader.getLoaders(webpackConfig),
+            ...cssLoader.getLoaders(webpackConfig, ignorePostCssLoader),
             {
                 loader: 'less-loader',
                 options: {

lib/loaders/less.js

@@ -14,13 +14,15 @@ const cssLoader = require('./css');
 
 /**
  * @param {WebpackConfig} webpackConfig
+ * @param {Object} sassOption Options to pass to the loader
+ * @param {bool} ignorePostCssLoader If true, postcss-loader will never be added
  * @return {Array} of loaders to use for Sass files
  */
 module.exports = {
-    getLoaders(webpackConfig) {
+    getLoaders(webpackConfig, sassOptions = {}, ignorePostCssLoader = false) {
         loaderFeatures.ensureLoaderPackagesExist('sass');
 
-        const sassLoaders = [...cssLoader.getLoaders(webpackConfig)];
+        const sassLoaders = [...cssLoader.getLoaders(webpackConfig, ignorePostCssLoader)];
         if (true === webpackConfig.sassOptions.resolve_url_loader) {
             // responsible for resolving SASS url() paths
             // without this, all url() paths must be relative to the
@@ -35,10 +37,10 @@ module.exports = {
 
         sassLoaders.push({
             loader: 'sass-loader',
-            options: {
+            options: Object.assign(sassOptions, {
                 // needed by the resolve-url-loader
                 sourceMap: (true === webpackConfig.sassOptions.resolve_url_loader) || webpackConfig.useSourceMaps
-            }
+            }),
         });
 
         return sassLoaders;