diff options
Diffstat (limited to 'tools/node_modules/eslint/node_modules/strip-json-comments/readme.md')
| -rw-r--r-- | tools/node_modules/eslint/node_modules/strip-json-comments/readme.md | 28 |
1 files changed, 20 insertions, 8 deletions
diff --git a/tools/node_modules/eslint/node_modules/strip-json-comments/readme.md b/tools/node_modules/eslint/node_modules/strip-json-comments/readme.md index 0ee58dfe3a..9ebfc206c4 100644 --- a/tools/node_modules/eslint/node_modules/strip-json-comments/readme.md +++ b/tools/node_modules/eslint/node_modules/strip-json-comments/readme.md @@ -6,27 +6,30 @@ This is now possible: ```js { - // rainbows + // Rainbows "unicorn": /* ❤ */ "cake" } ``` It will replace single-line comments `//` and multi-line comments `/**/` with whitespace. This allows JSON error positions to remain as close as possible to the original source. -Also available as a [gulp](https://github.com/sindresorhus/gulp-strip-json-comments)/[grunt](https://github.com/sindresorhus/grunt-strip-json-comments)/[broccoli](https://github.com/sindresorhus/broccoli-strip-json-comments) plugin. +Also available as a [Gulp](https://github.com/sindresorhus/gulp-strip-json-comments)/[Grunt](https://github.com/sindresorhus/grunt-strip-json-comments)/[Broccoli](https://github.com/sindresorhus/broccoli-strip-json-comments) plugin. ## Install ``` -$ npm install --save strip-json-comments +$ npm install strip-json-comments ``` ## Usage ```js -const json = '{/*rainbows*/"unicorn":"cake"}'; +const json = `{ + // Rainbows + "unicorn": /* ❤ */ "cake" +}`; JSON.parse(stripJsonComments(json)); //=> {unicorn: 'cake'} @@ -35,9 +38,9 @@ JSON.parse(stripJsonComments(json)); ## API -### stripJsonComments(input, [options]) +### stripJsonComments(jsonString, [options]) -#### input +#### jsonString Type: `string` @@ -45,14 +48,23 @@ Accepts a string with JSON and returns a string without comments. #### options +Type: `object` + ##### whitespace -Type: `boolean` +Type: `boolean`<br> Default: `true` Replace comments with whitespace instead of stripping them entirely. +## Benchmark + +``` +$ npm run bench +``` + + ## Related - [strip-json-comments-cli](https://github.com/sindresorhus/strip-json-comments-cli) - CLI for this module @@ -61,4 +73,4 @@ Replace comments with whitespace instead of stripping them entirely. ## License -MIT © [Sindre Sorhus](http://sindresorhus.com) +MIT © [Sindre Sorhus](https://sindresorhus.com) |