strip-json-comments
Advanced tools
strip-json-comments - npm Package Compare versions
Comparing version 1.0.4 to 2.0.0
| { | ||
| "name": "strip-json-comments", | ||
| "version": "1.0.4", | ||
| "version": "2.0.0", | ||
| "description": "Strip comments from JSON. Lets you use comments in your JSON files!", | ||
| "license": "MIT", | ||
| "repository": "sindresorhus/strip-json-comments", | ||
| "author": { | ||
| "name": "Sindre Sorhus", | ||
| "email": "sindresorhus@gmail.com", | ||
| "url": "sindresorhus.com" | ||
| }, | ||
| "engines": { | ||
| "node": ">=0.10.0" | ||
| }, | ||
| "scripts": { | ||
| "test": "xo && ava" | ||
| }, | ||
| "files": [ | ||
| "index.js" | ||
| ], | ||
| "keywords": [ | ||
@@ -20,28 +36,8 @@ "json", | ||
| "env", | ||
| "environment", | ||
| "cli", | ||
| "bin" | ||
| "environment" | ||
| ], | ||
| "license": "MIT", | ||
| "author": { | ||
| "name": "Sindre Sorhus", | ||
| "email": "sindresorhus@gmail.com", | ||
| "url": "sindresorhus.com" | ||
| }, | ||
| "files": [ | ||
| "cli.js", | ||
| "strip-json-comments.js" | ||
| ], | ||
| "main": "strip-json-comments", | ||
| "bin": "cli.js", | ||
| "repository": "sindresorhus/strip-json-comments", | ||
| "scripts": { | ||
| "test": "mocha --ui tdd" | ||
| }, | ||
| "devDependencies": { | ||
| "mocha": "*" | ||
| }, | ||
| "engines": { | ||
| "node": ">=0.8.0" | ||
| "ava": "*", | ||
| "xo": "*" | ||
| } | ||
| } |
@@ -14,30 +14,19 @@ # strip-json-comments [](https://travis-ci.org/sindresorhus/strip-json-comments) | ||
| It will remove single-line comments `//` and multi-line comments `/**/`. | ||
| 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. | ||
| - | ||
| *There's also [`json-comments`](https://npmjs.org/package/json-comments), but it's only for Node.js, inefficient, bloated as it also minifies, and comes with a `require` hook, which is :(* | ||
| ## Install | ||
| ```sh | ||
| ``` | ||
| $ npm install --save strip-json-comments | ||
| ``` | ||
| ```sh | ||
| $ bower install --save strip-json-comments | ||
| ``` | ||
| ```sh | ||
| $ component install sindresorhus/strip-json-comments | ||
| ``` | ||
| ## Usage | ||
| ```js | ||
| var json = '{/*rainbows*/"unicorn":"cake"}'; | ||
| const json = '{/*rainbows*/"unicorn":"cake"}'; | ||
| JSON.parse(stripJsonComments(json)); | ||
@@ -50,3 +39,3 @@ //=> {unicorn: 'cake'} | ||
| ### stripJsonComments(input) | ||
| ### stripJsonComments(input, [options]) | ||
@@ -59,21 +48,16 @@ #### input | ||
| #### options | ||
| ## CLI | ||
| ##### whitespace | ||
| ```sh | ||
| $ npm install --global strip-json-comments | ||
| ``` | ||
| Type: `boolean` | ||
| Default: `true` | ||
| ```sh | ||
| $ strip-json-comments --help | ||
| Replace comments with whitespace instead of stripping them entirely. | ||
| strip-json-comments input-file > output-file | ||
| # or | ||
| strip-json-comments < input-file > output-file | ||
| ``` | ||
| ## Related | ||
| - [`strip-css-comments`](https://github.com/sindresorhus/strip-css-comments) | ||
| - [strip-json-comments-cli](https://github.com/sindresorhus/strip-json-comments-cli) - CLI for this module | ||
| - [strip-css-comments](https://github.com/sindresorhus/strip-css-comments) - Strip comments from CSS | ||
@@ -80,0 +64,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
Improved metrics
- Number of low supply chain risk alerts
- decreased by-50%
1
Worsened metrics
- Total package byte prevSize
- decreased by-18.22%
5015
- Dev dependency count
- increased by100%
2
- Number of package files
- decreased by-20%
4
- Lines of code
- decreased by-35.79%
61
- Number of lines in readme file
- decreased by-19.75%
65