Snork.JsonCommentStripper 1.0.0

.NET Standard 2.1

dotnet add package Snork.JsonCommentStripper --version 1.0.0

NuGet\Install-Package Snork.JsonCommentStripper -Version 1.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Snork.JsonCommentStripper" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Snork.JsonCommentStripper --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Snork.JsonCommentStripper, 1.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Snork.JsonCommentStripper as a Cake Addin
#addin nuget:?package=Snork.JsonCommentStripper&version=1.0.0

// Install Snork.JsonCommentStripper as a Cake Tool
#tool nuget:?package=Snork.JsonCommentStripper&version=1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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.

This code is adapted from a JavaScript version by Sindre Sorhus.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.1 is compatible.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.1
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.0.0	126	6/2/2024

Initial release