jsoncommentstrip

README

go-jsoncommentstrip

GO library for strip JSON comments from input.

Comment Types

Single Line

{  
  // this is a comment
  "not_a_comment": "// this is not a comment"  
}

Multiple Lines

[
  /* multi
   line
   "comment",
   */
   "value": "this is not comment" /* this is another comment */
]

Escaping in JSON

{
    "test": "\"valid string // /*" // escaped string
}

Line Endings Support

Library normally working with *NIX \n and Windows \r\n line endings.

Commandline Tool

$ go get github.com/RaveNoX/go-jsoncommentstrip/cmd/jsoncommentstrip
$ cat json_with_comments.json | jsoncommentstrip

License

MIT

Documentation

Overview

Package jsoncommentstrip contains functions which strips comments from JSON input.

Supported comment types:

- Single line:

{
  // this is a single line comment
}

- Multiple lines:

{
  /* multiple
   * lines comments
   * works
   */
}

Supported line breaks:

\n    - unix style
\r\n  - windows style

Supported escaping in JSON:

{
    "test": "\"valid string // /*"
}

Index

• type Reader
  • func NewReader(input io.Reader) Reader

Types

type Reader

type Reader interface {
	Read(buff []byte) (count int, err error)
}

Reader reader which reads JSON and strips comments from it

func NewReader

func NewReader(input io.Reader) Reader

NewReader creates new Reader instance