jsoncr

README

JSONCR

JSONCR is a Go package that provides method to remove comments and indentations in JSON. Both block and line comments are supported. Common use is to process the JSON config file.

Getting Started

Installing

$ go get github.com/thedevop1/jsoncr

Example

    const j = `/* Comment */
{
    "example": "value" // more comment
}`
	condense, err := jsoncr.Remove(strings.NewReader(j))
	if err != nil {
        // error handling
    }
    var z interface{}
	err = json.Unmarshal(condense, &z)
	if err != nil {
        // error handling
	}

Documentation

Overview

Package jsoncr provides method to remove comments and indentations in JSON.

Index

• func Remove(r io.Reader) ([]byte, error)

Examples

• Remove

Functions

func Remove

func Remove(r io.Reader) ([]byte, error)

Remove comments and indentations from r.

Example

package main

import (
	"encoding/json"
	"fmt"
	"strings"

	"github.com/thedevop1/jsoncr"
)

func main() {
	const j = `// JSON with commments
{	"configDesc": "configuration data", // config comment
	/* configBool:
		 false (default)
	*/
	"configBool": true					// override default
}`
	condenseJ, err := jsoncr.Remove(strings.NewReader(j))
	if err != nil {
		fmt.Println(err)
		return
	}
	var z interface{}
	err = json.Unmarshal(condenseJ, &z)
	if err != nil {
		fmt.Println("error Unmarshal", err)
		return
	}
	fmt.Println(z)

}

Output:

map[configBool:true configDesc:configuration data]