gulp-handlebars-render - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

test/index.spec.js

+var expect = require('chai').expect,
+    es     = require('event-stream'),
+    File   = require('vinyl'),
+    render = require('../');
+
+describe('gulp-handlebars-render', function() {
+  
+  it('should render a template with data', function(done){
+    var fakeFile = new File({
+          contents: new Buffer('<h1>{{test}}</h1>'),
+          path: '/some/path'
+        });
+
+    var myRender = render({test: "test data"});
+    myRender.once('data', function(file){
+      var result = file.contents.toString();
+      expect(result).to.equal('<h1>test data</h1>');
+      done();
+    });
+    myRender.write(fakeFile);
+  });
+
+  it('return error with stream', function(done){
+    var fakeFile = new File({
+      contents: es.readArray(['stream', 'with', 'those', 'contents']),
+      path: '/some/path'
+    });
+    var myRender = render({test: "test data"});
+    myRender.on('error', function(err){
+      expect(err.message).to.equal("Streaming not supported");
+      done();
+    });
+    myRender.write(fakeFile);
+
+  });
+
+
+});

.travis.yml

@@ -5,3 +5,2 @@ language: node_js
   - "0.10"
-  - "0.8"
 
@@ -8,0 +7,0 @@ deploy:

package.json

 {
   "name": "gulp-handlebars-render",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Renders handlebars templates",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"YOLO\" && exit 0"
+    "test": "npm run unit && npm run cov",
+    "unit": "mocha -R spec",
+    "cov": "mocha -r blanket -R travis-cov"
   },
@@ -19,2 +21,11 @@ "repository": {
   ],
+  "config": {
+    "blanket": {
+      "pattern": "index.js",
+      "data-cover-never": "node_modules"
+    },
+    "travis-cov": {
+      "threshold": 80
+    }
+  },
   "author": "Mark Wilkerson <[e-mail]>",
@@ -30,3 +41,11 @@ "license": "MIT",
     "through2": "^0.6.3"
+  },
+  "devDependencies": {
+    "blanket": "^1.1.6",
+    "chai": "^1.9.2",
+    "event-stream": "^3.1.7",
+    "mocha": "^1.21.4",
+    "travis-cov": "^0.2.5",
+    "vinyl": "^0.4.3"
   }
 }

README.md

@@ -6,2 +6,42 @@ gulp-handlebars-render  [![Build Status](https://travis-ci.org/markhuge/gulp-handlebars-render.svg)](https://travis-ci.org/markhuge/gulp-handlebars-render)
 
-Don't use me yet. Mark is a jerk and is deploying this for personal use before he writes tests.
+# Abstract
+
+My usecase is fully rendering hbs templates with data for livereload preview. 
+
+# Install
+
+`npm install gulp-handlebars-render --save-dev`
+
+# Usage
+
+The plugin accepts a data object, which it will apply to any handlebars templates that are passed into it.
+
+The output will be a rendered HTML file per template. 
+
+```javascript
+var gulp       = require('gulp'),
+    connect    = require('gulp-connect'),
+    cache      = require('gulp-cached'),
+    render     = require('gulp-handlebars-render');
+
+var content = {
+  title: "Lorem ipsum dolor sit amet"
+  author: "Frindle Babbin"
+  content: "This is a post"
+}
+
+gulp.task('connect', function() {
+  connect.server({
+    root: 'build/',
+    livereload: true
+  });
+});
+
+gulp.task('html', function () {
+ gulp.src('./src/templates/*.hbs')
+    .pipe(cache('html'))
+    .pipe(render(content))
+    .pipe(gulp.dest('build/'))
+    .pipe(connect.reload());
+});
+```

No alert changes

Improved metrics

Total package byte prevSize

6084

58.31%

Number of package files

7

16.67%

Lines of code

52

136.36%

Number of lines in readme file

46

666.67%

Worsened metrics

Dev dependency count

6

Infinity%

No dependency changes