https://github.com/gulp-community/gulp-json-editor
A gulp plugin to edit JSON objects
https://github.com/gulp-community/gulp-json-editor
gulp gulp-plugin json
Last synced: 10 months ago
JSON representation
A gulp plugin to edit JSON objects
- Host: GitHub
- URL: https://github.com/gulp-community/gulp-json-editor
- Owner: gulp-community
- License: mit
- Created: 2014-02-05T12:37:52.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T08:06:31.000Z (about 1 year ago)
- Last Synced: 2025-04-12T16:19:17.279Z (11 months ago)
- Topics: gulp, gulp-plugin, json
- Language: JavaScript
- Homepage:
- Size: 870 KB
- Stars: 61
- Watchers: 10
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-json-editor
[](https://www.npmjs.com/package/gulp-json-editor)
[](https://github.com/gulp-community/gulp-json-editor/actions/workflows/run-tests.yml)
gulp-json-editor is a [gulp](https://github.com/gulpjs/gulp) plugin to edit JSON objects.
## Usage
```javascript
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](https://github.com/beautify-web/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"));
/*
specify [deepmerge](https://github.com/TehShrike/deepmerge) option
*/
gulp.src("./manifest.json")
.pipe(jeditor({
"authors": ["tomcat"]
},
// the second argument is passed to js-beautify as its option
{},
// the third argument is passed to deepmerge options, eg, arrayMerge options
{
arrayMerge: function (dist,source,options) {return source;}
}))
.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
```javascript
gulp.src("./manifest.json")
.pipe(jeditor({
'version': '1.2.3'
},
{
beautify: false
}))
.pipe(gulp.dest("./dest"));
```
## API
### jeditor(editorObject, [jsBeautifyOptions], [deepmergeOptions])
#### editorObject
Type: `JSON object`
JSON object to merge with.
#### jsBeautifyOptions
Type: `object`
This object is passed to js-beautify as its option.
#### deepmergeOptions
Type: `object`
This object is passed to deepmerge as its [option](https://github.com/TehShrike/deepmerge#options).
### jeditor(editorFunction, [jsBeautifyOptions], [deepmergeOptions])
#### editorFunction
Type: `function`
The `editorFunction` must have the following signature: `function (json) {}`, and must return JSON object or PromiseLike object with JSON object as value.
#### jsBeautifyOptions
Type: `object`
This object is passed to js-beautify as its option.
#### deepmergeOptions
Type: `object`
This object is passed to deepmerge as its [option](https://github.com/TehShrike/deepmerge#options).
## License
Copyright (c) 2024 gulp-community
Licensed under the [MIT license](LICENSE).