Strip comments from JSON. Lets you use comments in your JSON files!
Get Started
$ dotnet add package Snork.JsonCommentStripperReadme
Snork.JsonCommentStripper
Strip comments from JSON. Lets you use comments in your JSON files!
This is now possible:
{
// 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.
Usage
using Snork.JsonCommentStripper;
string json = @"{
// Rainbows
\"unicorn\": /* ❤ */ \"cake\"
}";
Console.WriteLine(Stripper.Execute(json));
//=> {unicorn: 'cake'}
API
Stripper.StripJsonComments(string input, StripperOptions options = null)
input
Type: string
Accepts a string with JSON and returns a string without comments.
options
Type: StripperOptions
TrailingCommas
Type: boolean
Default: false
Strip trailing commas in addition to comments.
ReplaceWithWhiteSpace
Type: boolean
Default: true
Replace comments and trailing commas with whitespace instead of stripping them entirely.
Related
This code is adapted from a JavaScript version by Sindre Sorhus.