gulp-jsontoxml
v1.0.3
Published
Convert json files to xml with gulp
Downloads
21
Maintainers
Readme
gulp-jsontoxml
This plugin is a wrapper for npm package 'xml-js'
The goal of this plugin is to take a JSON file and convert it to XML. The JSON files are passed through gulp.src in the gulpfile.
A sample JSON may look something like
{
"root":{
"section":[
{
"title":[
"First"
],
"content":[
"Data: buffer"
]
},
{
"title":[
"Second"
],
"content":[
"Data: string"
]
}
]
}
}
and if passed in to this plugin will return the following xml
<root>
<section>
<title>First</title>
<content>Data: buffer</content>
</section>
<section>
<title>Second</title>
<content>Data: string</content>
</section>
</root>
The package gulp-xmltojson that converts xml files back to JSON is now available
Compact vs Non Compact
This plugin takes in both compact and non-compact JSON files and the user can specify whether or not the file is in compact format by setting 'compact:true' or 'compact:false' in the options parameter.
A sample compact and non compact JSON comparison can be found here
Usage
gulp-jsontoxml plugin accepts a configObj as its parameter. The configObj will contain any info the plugin needs.
The configObj in this situation is used for users to enter in options that the user can enter inorder to customize the resultant xml file. The table containing the options can be found here
Sample gulpfile.js
let gulp = require('gulp')
import {jsontoxml} from 'gulp-jsontoxml'
var sampleConfigObj = {compact: true, ignoreDeclaration: true, spaces: 4}; // sample configObj
exports.default = function() {
return src('data/*.json')
// pipe the files through our jsontoxml plugin
.pipe(jsontoxml(sampleConfigObj))
.pipe(gulp.dest('../testdata/processed'));
};
Quick Start
- Dependencies:
- Clone this repo and run
npm install
to install npm packages - Debug: with VScode use
Open Folder
to open the project folder, then hit F5 to debug. This runs without compiling to javascript using ts-node - Test:
npm test
ornpm t
- Compile to javascript:
npm run build
Testing
We are using Jest for our testing. Each of our tests are in the test
folder.
- Run
npm test
to run the test suites
Note: This document is written in Markdown. We like to use Typora and Markdown Preview Plus for our Markdown work..