Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wmfs/xml2csv

package tymly

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/wmfs/xml2csv
Owner: wmfs
License: mit
Created: 2018-06-11T15:39:01.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-10-30T01:00:12.000Z (3 months ago)
Last Synced: 2024-10-30T03:50:45.048Z (3 months ago)
Topics: package, tymly
Language: JavaScript
Size: 372 KB
Stars: 5
Watchers: 8
Forks: 10
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # xml2csv

[![Tymly Package](https://img.shields.io/badge/tymly-package-blue.svg)](https://tymly.io/)

[![npm (scoped)](https://img.shields.io/npm/v/@wmfs/xml2csv.svg)](https://www.npmjs.com/package/@wmfs/xml2csv)

[![CircleCI](https://circleci.com/gh/wmfs/xml2csv.svg?style=svg)](https://circleci.com/gh/wmfs/xml2csv)

[![codecov](https://codecov.io/gh/wmfs/xml2csv/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/xml2csv)

[![CodeFactor](https://www.codefactor.io/repository/github/wmfs/xml2csv/badge)](https://www.codefactor.io/repository/github/wmfs/xml2csv)

[![Dependabot badge](https://img.shields.io/badge/Dependabot-active-brightgreen.svg)](https://dependabot.com/)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly/blob/master/packages/pg-concat/LICENSE)

> Takes an XML file and transforms it into a CSV file, based on format of the map you provide with options. 

## Install

```bash

$ npm install @wmfs/xml2csv --save

```

## Usage

### Use with callback

```javascript

const xml2csv = require('@wmfs/xml2csv')

xml2csv(

  {

    xmlPath: 'path/to/file.xml',

    csvPath: 'path/to/file.csv',

    rootXMLElement: 'Person',

    headerMap: [

      ['Name', 'name', 'string'],

      ['Age', 'age', 'integer'],

      ['Gender', 'gender', 'string'],

      ['Brother', 'brother', 'string', 'Siblings'],

      ['Sister', 'sister', 'string', 'Siblings']

    ]

  },

  function (err, info) {

    console.log(err, info)

    // Done!

  }

)

```

### Use with Promises

```javascript

const xml2csv = require('@wmfs/xml2csv')

xml2csv(

  {

    xmlPath: 'path/to/file.xml',

    csvPath: 'path/to/file.csv',

    rootXMLElement: 'Person',

    headerMap: [

      ['Name', 'name', 'string'],

      ['Age', 'age', 'integer'],

      ['Gender', 'gender', 'string'],

      ['Brother', 'brother', 'string', 'Siblings'],

      ['Sister', 'sister', 'string', 'Siblings']

    ]

  },

)

.then(console.log)

.catch(console.log);

```

### Use with async/await

```javascript

const xml2csv = require('@wmfs/xml2csv')

try {

  const res = await xml2csv(

    {

      xmlPath: 'path/to/file.xml',

      csvPath: 'path/to/file.csv',

      rootXMLElement: 'Person',

      headerMap: [

        ['Name', 'name', 'string'],

        ['Age', 'age', 'integer'],

        ['Gender', 'gender', 'string'],

        ['Brother', 'brother', 'string', 'Siblings'],

        ['Sister', 'sister', 'string', 'Siblings']

      ]

    },

  )

  console.log(res)

} catch(err) {

  console.log(err)

}

```

Input:

```

    

        Maggie

        3

        Female

        

            Bart

            Lisa

        

    

    

        Marge

        45

        Female

    

```

Output:

```

name, age, gender, brother, sister

"Maggie",3,"Female","Bart","Lisa"

"Marge",45,"Female",,

```

## xml2csv(`options`, `callback`)

### Options

| Property              | Type      | Notes  |

| --------              | ----      | -----  |

| `xmlPath`             | `string`  | A path to the xml input file. Cannot be provide with `xmlStream` property.

| `xmlStream`           | `fs.ReadStream`  | A readable stream from an xml file. Cannot be provide with `xmlPath` property.

| `csvPath`             | `string`  | The path and filename of the generated CSV output file (note that any intermediate folders will be created). Cannot be provide with `csvStream` property.

| `csvStream`           | `fs.WriteStream`  | A writeable stream for the generated CSV data. Cannot be provide with `csvPath` property.

| `rootXMLElement`      | `string`  | The XML root tag for each record, element to split records on in XML file.

| `headerMap`           | `[array]` | See the [Header Map](#headerMap) section for more details.

| `strict`              | `[boolean]` | Should the sax parser run in strict mode ? Defaults to `true`.

### options.headerMap

options.headerMap needs to be in the structure of:

```

[

    [xmlTag, csvHeader, type, parent],

    [xmlTag, csvHeader, type, parent],

    ...

]

```

* xmlTag and csvHeader must be the related fields

* type must be integer, date or string

* parent is optional, must be the parent tag in format of the XML tag

## Testing

```bash

$ npm test

```

## License

[MIT](https://github.com/wmfs/tymly/xml2csv/blob/master/LICENSE)