https://github.com/gregoryv/ingrid

.ini file parser
https://github.com/gregoryv/ingrid

Last synced: about 1 year ago
JSON representation

.ini file parser

• Host: GitHub
• URL: https://github.com/gregoryv/ingrid
• Owner: gregoryv
• License: mit
• Created: 2023-09-22T21:28:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-27T06:06:25.000Z (over 2 years ago)
• Last Synced: 2025-02-05T07:19:35.420Z (over 1 year ago)
• Language: Go
• Homepage:
• Size: 119 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: license.txt

Awesome Lists containing this project

README

          

 

Package ingrid parses .ini files.

## Quickstart

	$ go get -u github.com/gregoryv/ingrid

## Features

The format is often used in .ini, .conf or .cfg files. This

implementation is focused on performance and comes with minor

limitations.

  - comments start with # or ;

  - values may be quoted using ", ` (backtick), or ' (single tick)

  - sections start with [ and end with ]

  - spaces before and after key, values are removed

## Limitations

Currently the limitations for this implementation are

  - no spaces in keys

  - no comments after a key value pair

  - no multiline values

## Example

    package ingrid_test

    

    import (

    	"bufio"

    	"errors"

    	"fmt"

    	"strings"

    

    	"github.com/gregoryv/ingrid"

    )

    

    func Example() {

    	input := `# generic things

    debug = false

    # default for servers

    bind= localhost:80

    

    [example]

    text = "escaped \""

    hostname = "example.com"

    more = 'single "quoted" string'

    

    [github]

    hostname=github.com

    bind=localhost:443

    empty=

    

    # invalid lines

    color

    my name = john

    [trouble

    text='...

    `

    	mapping := func(section, key, value, comment string, err error) {

    		switch {

    		case errors.Is(err, ingrid.ErrSyntax):

    			fmt.Printf("input line:%v\n", err)

    

    		case key != "":

    			fmt.Printf("%s%s=%s\n", prefix(section), key, value)

    		}

    	}

    	ingrid.Map(mapping, bufio.NewScanner(strings.NewReader(input)))

    	// output:

    	// debug=false

    	// bind=localhost:80

    	// example.text=escaped "

    	// example.hostname=example.com

    	// example.more=single "quoted" string

    	// github.hostname=github.com

    	// github.bind=localhost:443

    	// github.empty=

    	// input line:17 color SYNTAX ERROR: missing equal sign

    	// input line:18 my name = john SYNTAX ERROR: space not allowed in key

    	// input line:19 [trouble SYNTAX ERROR: missing right bracket

    	// input line:20 text='... SYNTAX ERROR: missing end quote

    }

    

    // prefix returns section. if not empty.

    func prefix(section string) string {

    	if len(section) == 0 {

    		return ""

    	}

    	return section + "."

    }

## Benchmark

     goos: linux

     goarch: amd64

     pkg: github.com/gregoryv/ingrid

     cpu: Intel(R) Xeon(R) E-2288G CPU @ 3.70GHz

     Benchmark_Map-16  154855074     7.678 ns/op    0 B/op    0 allocs/op