config

Sharkk Config File

SCF, pronounced scuff!

A very light, very intuitive config file format! Few symbols, few rules, quite flexible. Has support for comments, arrays, maps, and type guarantees.

Mercilessly benchmarked, fully tested. SCF competes toe-to-toe with Go's native JSON library, and handily outperforms the reference TOML and YAML implementations.

Format

SCF has very very simple syntax.

-- Lua style comments!
host  "localhost"
port  8080        -- no = for assignment!
debug true

allowed_ips {
    "192.168.1.1"
    "192.168.1.2"
    "10.0.0.1"
}

--[[
    Feel free to space out your explanations!

    All is well and good.
]]
database {
    host "db.example.com"
    port 5432
    credentials {
        username "admin"
        password "secure123"
    }
}

Installation

go get git.sharkk.net/Go/Config

Usage

Basic Usage

package main

import (
    "fmt"
    "os"
    
    config "git.sharkk.net/Go/Config"
)

func main() {
    file, err := os.Open("config.conf")
    if err != nil {
        panic(err)
    }
    defer file.Close()
    
    // Pass a string to be loaded by the parser!
    cfg, err := config.Load(file)
    if err != nil {
        panic(err)
    }
    
    // Access values with type conversion.
    host, err := cfg.GetString("database.host")
    port, err := cfg.GetInt("database.port")
    debug, err := cfg.GetBool("debug")
    
    // Use default values for missing keys
    timeout := cfg.GetOr("timeout", 30).(int)

    // Get the entire map to traverse directly (cuts traversal time by 50%!)
    entireMap := cfg.GetData()
    other, err := entireMap["database"]["host"].(string)
}

Type Conversion

The parser automatically converts values to appropriate types:

boolValue, err   := cfg.GetBool("feature.enabled")
intValue, err    := cfg.GetInt("server.port")
floatValue, err  := cfg.GetFloat("threshold")
stringValue, err := cfg.GetString("app.name")
arrayValue, err  := cfg.GetArray("allowed_ips")
mapValue, err    := cfg.GetMap("database")

// Generic getter (returns any)
value, err := cfg.Get("some.key")

Accessing Arrays and Maps

Access array elements and nested map values using dot notation:

// Access the first element in the array
firstIP, err := cfg.GetString("allowed_ips.0")

// Access deeply nested values
username, err := cfg.GetString("database.credentials.username")

Performance

This parser provides competitive performance compared to popular formats like JSON, YAML, and TOML:

Benchmarked on AMD Ryzen 9 7950X 16-Core Processor

Why Choose This Parser?

• Readability: Simple syntax that's easy for humans to read and write
• Flexibility: Supports various data types and nested structures
• Performance: Fast parsing with minimal overhead
• Type Safety: Strong typing with automatic conversion
• Simplicity: No external dependencies required

License

MIT