• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

rejas/gulp-json-editor: A gulp plugin to edit JSON objects

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称(OpenSource Name):

rejas/gulp-json-editor

开源软件地址(OpenSource Url):

https://github.com/rejas/gulp-json-editor

开源编程语言(OpenSource Language):

JavaScript 100.0%

开源软件介绍(OpenSource Introduction):

gulp-json-editor

npm version Automated tests

gulp-json-editor is a gulp plugin to edit JSON objects.

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](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

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.

jeditor(editorFunction, [jsBeautifyOptions], [deepmergeOptions])

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.

deepmergeOptions

Type: object

This object is passed to deepmerge as its option.

License

Copyright (c) 2021 rejas

Licensed under the MIT license.




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap