Package Exports
- gulp-json-editor
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-json-editor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
gulp-json-editor
gulp-json-editor is a gulp plugin to edit JSON object.
Usage
var jeditor = require("gulp-json-editor");
/*
edit JSON object by merging with user specific object
*/
gulp.src("./manifest.json")
.pipe(jeditor({
'version': '1.2.3'
}))
.pipe(gulp.dest("./dest"));
/*
edit JSON object by using user specific function
*/
gulp.src("./manifest.json")
.pipe(jeditor(function(json) {
json.version = "1.2.3";
return json; // must return JSON object.
}))
.pipe(gulp.dest("./dest"));
/*
specify js-beautify option
*/
gulp.src("./manifest.json")
.pipe(jeditor({
'version': '1.2.3'
},
// the second argument is passed to js-beautify as its option
{
'indent_char': '\t',
'indent_size': 1
}))
.pipe(gulp.dest("./dest"));Note
In case of such above situation, all of comment and whitespace in source file is NOT kept in destination file.
Disable beautification
gulp.src("./manifest.json")
.pipe(jeditor({
'version': '1.2.3'
},
{
beautify: false
}))
.pipe(gulp.dest("./dest"));API
jeditor(editorObject, [jsBeautifyOptions])
editorObject
Type: JSON object
JSON object to merge with.
jsBeautifyOptions
Type: object
This object is passed to js-beautify as its option.
jeditor(editorFunction, [jsBeautifyOptions])
editorFunction
Type: function
The editorFunction must have the following signature: function (json) {}, and must return JSON object.
jsBeautifyOptions
Type: object
This object is passed to js-beautify as its option.