Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rhysd/fixjson
JSON Fixer for Humans using (relaxed) JSON5
https://github.com/rhysd/fixjson
fixer formatter json
Last synced: 14 days ago
JSON representation
JSON Fixer for Humans using (relaxed) JSON5
- Host: GitHub
- URL: https://github.com/rhysd/fixjson
- Owner: rhysd
- License: mit
- Created: 2018-01-11T11:13:56.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-17T01:05:04.000Z (about 1 year ago)
- Last Synced: 2024-10-18T21:59:14.455Z (26 days ago)
- Topics: fixer, formatter, json
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/fixjson
- Size: 199 KB
- Stars: 124
- Watchers: 4
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
JSON fixer for Humans
=====================
[![npm version][]][fixjson]
[![ci-badge][]][ci]
[fixjson][] is a JSON file fixer/formatter for humans using (relaxed) JSON5.
fixjson provides:
- Pretty-printing JSON5 input
- ES5 syntax is available to write up JSON
- Fixes various failures while humans writing JSON
- Fixes trailing commas objects or arrays
- Fixes missing commas for elements of objects or arrays
- Adds quotes to keys in objects
- Newlines in strings
- Hex numbers
- Fixes single quotes to double quotes
fixjson reads an input in [relaxed JSON5][forked json5] format and outputs it in JSON format. Indent
width is automatically detected.
This CLI tool aims to be used with editor extensions.
- [vim-fixjson][] (dedicated Vim plugin)
- [ALE][] (Vim plugin)
- [neoformat][] (Vim plugin)
- [vim-autoformat][] (Vim plugin)
## Screenshots of Fixes
When moving a line to another line, you no longer need to care about a trailing comma:
And you also don't need to care about a trailing comma of a previous line when adding a new element
to an object or an array:
When adding a new key-value to an object, quotes of the key are fixed. And single quotes for strings
are also fixed to double quotes:
JSON string does not allow multi-line string. `\n` is required to embed multi-line string to JSON.
fixjson automatically fixes newlines in strings. This is useful when copy&paste some string to JSON
file:
JSON only accepts decimal digits for numbers. fixjson automatically converts `0x` hex numbers to
decimal numbers. You no longer need to convert hex numbers manually:
And of course it pretty-prints the JSON code, with automatic indent detection:
## Installation
```sh
$ npm install -g fixjson
```
It installs `fixjson` command globally.
## Usage
```sh
fixjson [--write|--indent|--minify|--stdin-filename] [paths...]
```
If paths are given, glob such as `dir/**/*.json` is available. If the path is a directory, it formats
all JSON files in the directory. If no path is given, it reads from STDIN.
If `--write` (or `-w`) option is provided, it overwrites files.
If `--indent {num}` (or `-i {num}`) is not provided, it detects indent spaces.
Please see `fixjson --help` for more details.
## License
Distributed under the MIT License. Please see [LICENSE](LICENSE).
[fixjson]: https://www.npmjs.com/package/fixjson
[vim-fixjson]: https://github.com/rhysd/vim-fixjson
[forked json5]: https://github.com/rhysd/json5
[npm version]: https://badge.fury.io/js/fixjson.svg
[ci-badge]: https://github.com/rhysd/fixjson/workflows/CI/badge.svg?branch=ga&event=push
[ci]: https://github.com/rhysd/fixjson/actions?query=workflow%3ACI
[neoformat]: https://github.com/sbdchd/neoformat
[vim-autoformat]: https://github.com/Chiel92/vim-autoformat
[ALE]: https://github.com/w0rp/ale