https://github.com/polyseam/jsonct

JSON with comments and multiline strings
https://github.com/polyseam/jsonct

Last synced: 9 months ago
JSON representation

JSON with comments and multiline strings

• Host: GitHub
• URL: https://github.com/polyseam/jsonct
• Owner: polyseam
• License: mit
• Created: 2023-05-18T23:34:10.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-29T01:04:18.000Z (almost 2 years ago)
• Last Synced: 2025-04-02T12:47:22.036Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 12.1 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# JSONCT - JSON with comments and template literals

[Blog Post](https://dev.to/polyseam/json-with-multiline-strings-4645)

JSON is used all over the web, and it is used to encode so many types of data.

It is missing two critical features for many use cases though:

1. There is no native comment syntax - but JSONC fixed this by allowing JS style

   comments!

2. There is no support for multi-line strings, which are an extremely helpful

   construct for all kinds of programs.

JSONCT allows the JS template literal syntax for multiline strings as an

extension of JSONC. This allows for a very natural way to write JSON documents,

and is very easy to parse.

```text

{

    "name": "JSONCT",

    // comments are handled just like JSONC

    "description": "JSON with comments and template literals",

    "markdown": `

# JSONCT - JSON with comments and template literals

---

Why doesn't this exist?`

}

```