gulp-vuejs - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "gulp-vuejs",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Fast and uncomplicated .vue file compiler for Gulp.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # gulp-vue
-Plain and simple fast(blazingly if you wish) and uncomplicated .vue file compiler
-for Gulp. Compiles all templates to an object. Template namespace is configurable
-and filled dynamically based on your template app structure. No inline stylesheets
-and javascripts. This is bad practice.
+Simple and fast .vue template compiler for Gulp. Compiles all templates to an
+object. Template namespace is configurable and filled dynamically based on your
+template app structure. Intentionally no inline stylesheets and javascript.
 
-# Install
-With [npm](https://www.npmjs.com/) do:
+# Install and usage
+Install like:
 
     npm install gulp-vue --save-dev
 
-
+Make a templates directory and optionally subdirectories to use template
+prefixes, e.g. `templates/mymodule`:
 Then use it in your gulp file like:
@@ -17,13 +17,24 @@
 
-    gulp.task('templates', 'Builds all Vue components.', () => {
-        gulp.src('./src/js/**/*.vue')
+    gulp.task('templates', 'Build Vue templates', () => {
+        gulp.src('./src/templates/**/*.vue')
         .pipe(vue('templates.js', {
-            namespace: 'global.tpl',
-            prefixStart: 'modules',
-            prefixIgnore: ['templates'],
+            prefixStart: 'templates',
+            commonjs: false,
         }))
         .on('error', notify.onError('Error: <%= error.message %>'))
-        .pipe(size(extend({title: 'templates'}, sizeOptions)))
+        .pipe(ifElse(PRODUCTION, () => uglify()))
+        .on('end', () => {
+            if (!PRODUCTION) del(path.join(BUILD_DIR, 'templates.js.gz'), {force: true})
+        })
         .pipe(gulp.dest(BUILD_DIR))
-        .pipe(ifElse(watcher, livereload))
+        .pipe(size(extend({title: 'templates'}, sizeConfig)))
+        .pipe(ifElse(PRODUCTION, () => gzip(gzipConfig)))
+        .pipe(ifElse(PRODUCTION, () => gulp.dest(BUILD_DIR)))
+        .pipe(size(extend({title: 'templates [gzip]'}, sizeConfig)))
+        .pipe(ifElse(isWatching, livereload))
     })
+
+This will generate a Javascript file, where templates are accessible from
+`window.templates`. You can optionally use the `commonjs` option to generate a
+module, which you can require in your code if you want to keep the templates
+within a predefined namespace and part of an existing browserify entry.

No alert changes

Improved metrics

Total package byte prevSize

13329

increased by5.26%

Number of lines in readme file

40

increased by37.93%

No dependency changes