JsonRepair Sharp

Jsonrepair Sharp is a near-literal translation of the TypeScript JsonRepair library, see https://github.com/josdejong/jsonrepair

The jsonrepair library is basically an extended JSON parser. It parses the provided JSON document character by character. When it encounters a non-valid JSON structures it wil look to see it it can reconstruct the intended JSON. For example, after encountering an opening bracket {, it expects a key wrapped in double quotes. When it encounters a key without quotes, or wrapped in other quote characters, it will change these to double quotes instead.

The library has many uses, such as:

Convert from an a Word document
Convert from objects with a JSON-like structure, such as Javascript
Convert from a string containing a JSON document
Convert from MongoDB output
Convert from Newline Delimited JSON logs
Convert from JSON dialects
Convert from Truncated or corrupted JSON.

But with the advent of Language Model Models (LLMs) there is yet another use-case. LLMs are notoriously bad in consistently outputting well-formed datastructures, even as simple as JSON. Requiry-ing is expensive and time consuming. Jsonrepair comes to the rescue by repair these JSON modules files, and increasing changes of smooth processing.

The library can fix the following issues:

Add missing quotes around keys
Add missing escape characters
Add missing commas
Add missing closing brackets
Replace single quotes with double quotes
Replace special quote characters like “...” with regular double quotes
Replace special white space characters with regular spaces
Replace Python constants None, True, and False with null, true, and false
Strip trailing commas
Strip comments like /* ... */ and // ...
Strip JSONP notation like callback({ ... })
Strip escape characters from an escaped string like {\"stringified\": \"content\"}
Strip MongoDB data types like NumberLong(2) and ISODate("2012-12-19T06:01:17.171Z")
Concatenate strings like "long text" + "more text on next line"
Turn newline delimited JSON into a valid JSON array, for example:
```
{ "id": 1, "name": "John" }
{ "id": 2, "name": "Sarah" }
```

In LLM mode

Strip characters heading the JSON opening brace and trailing the JSON closing brace.

Use

Use the original typescript version in a full-fledged application: https://jsoneditoronline.org Read the background article "How to fix JSON and validate it with ease"

Code example

// Enable throwing exceptions when JSON code can not be repaired or even understood (enabled by default)
JsonRepair.ThrowExceptions = true;

// Set context as LLM or Other. This will repair the json slightly differently. (Other by default)
JsonRepair.Context         = Other;

 try
 {
     // The following is invalid JSON: is consists of JSON contents copied from 
     // a JavaScript code base, where the keys are missing double quotes, 
     // and strings are using single quotes:
     string json = "{name: 'John'}";
     string repaired = JSONRepair.JsonRepair(json);
     Console.WriteLine(repaired);
     // Output: {"name": "John"}
 }
 catch (JSONRepairError err)
 {
     Console.WriteLine(err.Message);
     Console.WriteLine("Position: " + err.Data["Position"]);
 }

Command Line Interface (CLI)

The github archive comes with a jsonrepair cli tool, it can be used on the command line. To use, build JsonRepair-CLI.

Usage:

$ jsonrepair "inputfilename.json" {OPTIONS}

Options:

--version,   -v                       Show application version
--help,      -h                       Show help
--new,       -n "outputfilename.json" Write to new file
--overwrite, -o                       Replace the input file
--llm,       -l                       Parse in LLM mode

Example usage:

$ jsonrepair "broken.json"                         # Repair a file, output to console
$ jsonrepair "broken.json" > "repaired.json"       # Repair a file, output to command line and pipe to file
$ jsonrepair "broken.json" -n -l "repaired.json"   # Repair a file in LLM mode, output to command line and pipe to file
$ jsonrepair "broken.json" --overwrite             # Repair a file, replace the input json file

GUI

The archive also comes with a minimal GUI that shows a somewhat simplistic diff between the original and fixed JSON This GUI heavily leans on the awesome FastColoredTextBox library and the the diff sample in particular.

Alternatives:

Similar libraries:

Acknowledgements

Thanks go out to Jos de Jong, who not only did all the heavy lifting in the original jsonrepair for typescript library, but also patiently helped getting this port to pass all unit tests.

License

Released under the MITS license.

thijse / jsonrepairsharp Goto Github PK