Skip to content

Commit cb6d49a

Browse files
committed
docs: Mention the rolup plugin
1 parent 07398ca commit cb6d49a

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
[![devDependency Status](https://david-dm.org/prantlf/jsonlint/dev-status.svg)](https://david-dm.org/prantlf/jsonlint#info=devDependencies)
88
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
99

10-
A [JSON]/[JSON5] parser and validator with a command-line client. A [pure JavaScript version] of the service provided at [jsonlint.com].
10+
A [JSON]/CJSON/[JSON5] parser, validator and pretty-printer with a command-line client. A [pure JavaScript version] of the service provided at [jsonlint.com].
1111

1212
This is a fork of the original package with the following enhancements:
1313

1414
* Handles multiple files on the command line (by Greg Inman).
1515
* Walks directories recursively (by Paul Vollmer).
1616
* Provides 100% compatible interface to the native `JSON.parse` method.
17-
* Optionally recognizes JavaScript-style comments and single quoted strings.
17+
* Optionally recognizes JavaScript-style comments (CJSON) and single quoted strings (JSON5).
1818
* Optionally ignores trailing commas and reports duplicate object keys as an error.
1919
* Supports [JSON Schema] drafts 04, 06 and 07.
2020
* Offers pretty-printing including comment-stripping and object keys without quotes (JSON5).
@@ -30,6 +30,7 @@ Integration to the favourite task loaders for JSON file validation is provided b
3030

3131
* [`Grunt`] - see [`@prantlf/grunt-jsonlint`]
3232
* [`Gulp`] - see [`@prantlf/gulp-jsonlint`]
33+
* [`Rollup`] - see [`rollup-plugin-jsonlint`]
3334

3435
## Synopsis
3536

@@ -189,7 +190,7 @@ const validate = compile('string with JSON schema', {
189190

190191
### Pretty-Printing
191192

192-
You can parse a JSON string to an array of tokens and print it back to a string with some changes applied. It can be unification of whitespace or tripping comments, for example. (Raw token values must be enabled when tokenizing the JSON input.)
193+
You can parse a JSON string to an array of tokens and print it back to a string with some changes applied. It can be unification of whitespace, reformatting or stripping comments, for example. (Raw token values must be enabled when tokenizing the JSON input.)
193194

194195
```js
195196
const { tokenize } = require('@prantlf/jsonlint')
@@ -330,8 +331,10 @@ Licensed under the [MIT License].
330331
[UMD]: https://github.com/umdjs/umd
331332
[`Grunt`]: https://gruntjs.com/
332333
[`Gulp`]: http://gulpjs.com/
334+
[`Rollup`]: https://rollupjs.org/
333335
[`@prantlf/grunt-jsonlint`]: https://www.npmjs.com/package/@prantlf/grunt-jsonlint
334336
[`@prantlf/gulp-jsonlint`]: https://www.npmjs.com/package/@prantlf/gulp-jsonlint
337+
[`rollup-plugin-jsonlint`]: https://www.npmjs.com/package/rollup-plugin-jsonlint
335338
[7x faster than the custom parser]: ./benchmarks/results/performance.md#results
336339
[parser benchmark]: ./benchmarks#json-parser-comparison
337340
[a lot slower]: ./benchmarks/results/performance.md#results

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@prantlf/jsonlint",
33
"version": "0.0.0-development",
4-
"description": "JSON parser, syntax and schema validator and pretty-printer.",
4+
"description": "JSON/CJSON/JSON5 parser, syntax and schema validator and pretty-printer.",
55
"author": "Ferdinand Prantl <prantlf@gmail.com> (http://prantl.tk)",
66
"contributors": [
77
"Greg Inman <ginman@itriagehealth.com>",

0 commit comments

Comments
 (0)