Skip to content

Read INI

The core reads and writes only YAML. INI comes from a sibling module, config-ini, which adds nothing to your dependency graph — an INI file is read with the standard library.

go get gitlab.com/phpboyscout/go/config-ini

import (
    "gitlab.com/phpboyscout/go/config"
    configini "gitlab.com/phpboyscout/go/config-ini"
)

store, err := config.NewStore(ctx,
    config.WithFiles(fsys, "/etc/app.yaml"),                  // YAML, the default
    config.WithBackend(configini.New(fsys, "/etc/app.ini")),  // outranks it
)

When you do not need this

If you own the format, the core's YAML needs no module.

Reach for INI when the file already exists in that shape and is not yours to change — a tool's own config, or something a user is used to editing. It is read-only, so pair it with a writable layer if your application has to persist anything.

Sections and keys nest on dots

A [section] header prefixes the keys beneath it:

[server]
host = localhost
port = 8080

host := store.View().GetString("server.host") // "localhost"
port := store.View().GetInt("server.port")    // 8080

An INI layer therefore merges into a nested YAML or JSON one by the same paths. A section name or a key may itself contain dots, each a nesting separator — [db.primary] with pool.size = 4 reads as db.primary.pool.size. Keys before any section are top-level. A line is key = value or key : value, split on whichever separator comes first so a colon in a value (a URL) is not mis-split; ; and # begin a comment; and surrounding quotes are stripped.

Read-only

Values are strings; the read path casts. The format is read-only.

What it costs
Modules added none — everything it links comes from the config graph, and an allowlist test in the module fails if that changes

An INI file is parsed with the standard library, so there is no parser module — and no filesystem library either, because you supply the config.FS.