.config/coc/extensions/node_modules/coc-prettier/node_modules/strip-json-comments/readme.md

   1 # strip-json-comments [![Build Status](https://travis-ci.com/sindresorhus/strip-json-comments.svg?branch=master)](https://travis-ci.com/github/sindresorhus/strip-json-comments)
   2
   3 > Strip comments from JSON. Lets you use comments in your JSON files!
   4
   5 This is now possible:
   6
   7 ```js
   8 {
   9         // Rainbows
  10         "unicorn": /* ❤ */ "cake"
  11 }
  12 ```
  13
  14 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.
  15
  16 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.
  17
  18 ## Install
  19
  20 ```
  21 $ npm install strip-json-comments
  22 ```
  23
  24 ## Usage
  25
  26 ```js
  27 const json = `{
  28         // Rainbows
  29         "unicorn": /* ❤ */ "cake"
  30 }`;
  31
  32 JSON.parse(stripJsonComments(json));
  33 //=> {unicorn: 'cake'}
  34 ```
  35
  36 ## API
  37
  38 ### stripJsonComments(jsonString, options?)
  39
  40 #### jsonString
  41
  42 Type: `string`
  43
  44 Accepts a string with JSON and returns a string without comments.
  45
  46 #### options
  47
  48 Type: `object`
  49
  50 ##### whitespace
  51
  52 Type: `boolean`\
  53 Default: `true`
  54
  55 Replace comments with whitespace instead of stripping them entirely.
  56
  57 ## Benchmark
  58
  59 ```
  60 $ npm run bench
  61 ```
  62
  63 ## Related
  64
  65 - [strip-json-comments-cli](https://github.com/sindresorhus/strip-json-comments-cli) - CLI for this module
  66 - [strip-css-comments](https://github.com/sindresorhus/strip-css-comments) - Strip comments from CSS
  67
  68 ---
  69
  70 <div align="center">
  71         <b>
  72                 <a href="https://tidelift.com/subscription/pkg/npm-strip-json-comments?utm_source=npm-strip-json-comments&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
  73         </b>
  74         <br>
  75         <sub>
  76                 Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
  77         </sub>
  78 </div>