Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/okunishinishi/node-fmtjson

Node.js module to format json file.
https://github.com/okunishinishi/node-fmtjson

json

Last synced: 2 months ago
JSON representation

Node.js module to format json file.

Awesome Lists containing this project

README

        

fmtjson
==========

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/okunishinishi/node-fmtjson
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-fmtjson
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-fmtjson.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-fmtjson
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-fmtjson.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-fmtjson/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-fmtjson
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-fmtjson.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-fmtjson.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-fmtjson
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-fmtjson.svg
[bd_npm_url]: http://www.npmjs.org/package/fmtjson
[bd_npm_shield_url]: http://img.shields.io/npm/v/fmtjson.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

Format json files.

Installation
-----

```bash
$ npm install fmtjson --save
```

Usage
---------

Format json files.

```javascript
'use strict'

const fmtjson = require('fmtjson')

fmtjson([
'src/**/*.json'
], {
sort: true
}).then(() => {
/* ... */
})
```

Options
-------

| Key | Description | Default |
| --- | --- | --- |
| indent | Number of indent | 2 |
| sort | Sort properties or not. | false |
| mode | File permission | '644' |

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-fmtjson/blob/master/LICENSE).