# fmtjson

> Format json files.

Latest version **5.0.2** (published 2020-10-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install fmtjson
pnpm add fmtjson
yarn add fmtjson
bun add fmtjson
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.2 |
| Published | 2020-10-01 |
| First published | 2015-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 4 |
| Unpacked size | 32 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | file, json, format |

## Links

- npm: https://www.npmjs.com/package/fmtjson
- Repository: https://github.com/okunishinishi/node-fmtjson
- Homepage: https://github.com/okunishinishi/node-fmtjson#readme
- Issues: https://github.com/okunishinishi/node-fmtjson/issues
- npm.io page: https://npm.io/package/fmtjson

## Dependencies (4)

- [argx](https://npm.io/package/argx.md) ^4.0.4
- [asfs](https://npm.io/package/asfs.md) ^2.3.0
- [aglob](https://npm.io/package/aglob.md) ^3.0.2
- [writeout](https://npm.io/package/writeout.md) ^2.3.4

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 5.0.2 (latest) — 2020-10-01
- 5.0.1 — 2020-01-26
- 5.0.0 — 2020-01-26
- 4.0.6 — 2019-03-19
- 4.0.5 — 2019-03-19
- 4.0.4 — 2019-03-05
- 4.0.3 — 2019-03-05
- 4.0.2 — 2019-02-24
- 4.0.1 — 2018-10-28
- 4.0.0 — 2017-11-19
- 3.0.7 — 2016-08-16
- 3.0.6 — 2016-08-08
- 3.0.5 — 2016-08-08
- 3.0.4 — 2016-08-08
- 3.0.3 — 2016-07-12
- … 11 more at https://npm.io/package/fmtjson/versions

## README

fmtjson
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![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

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Format json files.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

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


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

Format json files.

```javascript
'use strict'

const fmtjson = require('fmtjson')

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


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Options.md.hbs" Start -->

<a name="section-doc-guides-03-options-md"></a>

Options
-------

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

<!-- Section from "doc/guides/03.Options.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

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

<!-- LICENSE End -->

---
_Source: https://npm.io/package/fmtjson · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._