Skip to content

Latest commit

 

History

History
59 lines (32 loc) · 1.11 KB

README.md

File metadata and controls

59 lines (32 loc) · 1.11 KB

#gulp-json-to-yaml

A Gulp plugin to convert JSON toYAML using js-yaml.

Install

npm install --save-dev gulp-json-to-yaml

Usage

var jsonToYaml = require('gulp-json-to-yaml');

gulp.src('./src/*.json')
  .pipe(jsonToYaml())
  .pipe(gulp.dest('./dist/'))

gulp.src('./src/*.json')
  .pipe(jsonToYaml({ safe: true}))
  .pipe(gulp.dest('./dist/'))

API

jsonToYaml([options])

options.safe

Type: Boolean

Default: true

Enable or disable support for regexps, functions and undefined.

This flag should always be enabled when working with untrusted data.

When this flag is enabled then [safeDump] method is used, otherwise [dump]. The options object is passed on to js-yaml methods. See js-yaml for details

options.filename

Type String

Default: the path of the file processed

String to be used as a file path in error/warning messages.

License

MIT