eslint-plugin-json-format weekly downloads statistics

eslint-plugin-json-format

An ESLint plugin to lint, format, auto-fix, and sort your json files.

Features

• lint, format, and auto-fix json files (files ending with .json or rc) • auto-sort package.json files (default true, can be disabled and sorting configured) • ignores json-with-comments files (default ["/.tsconfig.json", ".vscode/"]) • ignores certain files by default (default ["**/package-lock.json"])

Installation

You'll first need to install ESLint:

Next, install eslint-plugin-json-format:

Usage

Add json-format to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

cli example:

Note: In order to lint hidden files (e.g. .eslintrc.json), you'll need to modify/create a .eslintignore in your project root with these contents: .eslintignore:

Settings

default settings (.eslintrc):

Note: glob patterns use minimatch against path names relative to the project root (cwd)

sort-package-json order

You can configure the exact sort order of your package.json files (or turn it off entirely with false)

Available sorting options

false: disable package.json sorting.

"standard": default from sort-package-json. This is a sane, standard order.

"pro": places scripts and dependencies at the top, reducing need to scroll down to view them. Pros only.

["your", "custom", "order", "here"]: provide an array to manually set the sort order.

Settings examples

to turn off sorting package.json files for example, in your .eslintrc:

to format tsconfig.json (this will strip comments!), in your .eslintrc:

change the sort order of package.json:

Editor Configuration

VSCode:

In order for editor integration via the vscode-eslint extension, you'll need to enable linting json files.

settings.json:

to auto-format* json-with-comments-files, also add "language": "jsonc" (* will strip comments)

License

MIT

Credits

large amount of code borrowed from eslint-plugin-html

Description from the npm listing.