gulp-confidence
v0.0.1
Published
a gulp plugin for confidenceJS
Downloads
1
Readme
gulp-confidence
Confidence JSON plugin for GulpJS
gulp-confidence
retreive parameterized confidence documents using gulp.
Issues with the output should be reported on the confidence issue tracker.
Install
$ npm install --save-dev gulp-confidence
Usage
config/base.config.json
{
"hello":{
"$filter": "place"
"world": "Hello World",
"$default": "Hello Mars"
}
}
gulpfile.js
var gulp = require('gulp');
var confidence = require('gulp-confidence');
gulp.task('default', function () {
return gulp.src('config/base.config.json')
.pipe(confidence({place: "world"}))
.pipe(gulp.dest('dist'));
});
dist/base.config.json
{
"hello": "Hello World"
}
You can alternatively use gulp-data to inject the data:
gulpfile.js
var gulp = require('gulp');
var confidence = require('gulp-confidence');
var data = require('gulp-data');
gulp.task('default', function () {
return gulp.src('src/greeting.html')
.pipe(data(function () {
return {place: "world"};
}))
.pipe(confidence())
.pipe(gulp.dest('dist'));
});
dist/base.config.json
{
"hello": "Hello World"
}
API
See the Confidence Store
docs.
confidence(data, options)
data
Type: Object
The criteria object used to populate the text.
options
Type: Object
Currently just supports a "key" key, that allows you to specify the key used in the get()
command
Notes
If you use grunt instead of gulp, but want to perform a similar task, use grunt-confidence.
License
MIT