Source   Edit  

niprefs is a simple way to manage your application preferences (or configuration) using TOML.

TOML Syntax

A config file format for humans.

# This is a TOML document

title = "TOML Example"

[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00-08:00

[database]
enabled = true
ports = [ 8000, 8001, 8002 ]
data = [ ["delta", "phi"], [3.14] ]
temp_targets = { cpu = 79.5, case = 72.0 }

[servers]

[servers.alpha]
ip = "10.0.0.1"
role = "frontend"

[servers.beta]
ip = "10.0.0.2"
role = "backend"

Basic usage

A Prefs object requires a path and a default preferences. A TOML file is created at path with default whenever it's not found, if it exists it will read it. To access the actual preferences (not the default) you may want to use Prefs.content and at the end of your program call Prefs.save() to update the preferences file.

toToml is a helpful macro to define your default preferences. Instead of having to write:

{"a": [1.newTInt(), 2.newTInt()].newTArray()}.newTTable()

Using the toToml it's just as easy as writing:

toToml {a: [1, 2]}

Example:

import src/niprefs
let prefs = initPrefs(
  path = "prefs.toml", 
  default = toToml {
    "lang": "en", # Keys do not require quotes when using toToml macro.
    dark: true,
    keybindings: {:},
    scheme: {
      background: "#000000",
      font: {
        size: 15,
        family: "UbuntuMono",
        color: "#73D216"
      }
    }
  }
)

After the above example, a new prefs.toml file should be created:

  lang="en"
  dark=true
  scheme.background="#000000"
  scheme.font.color="#73D216"
  scheme.font.family="UbuntuMono"
  scheme.font.size=15
[keybindings]

Reading

You can access prefs.content

assert prefs.content["lang"] == "en"

But Prefs has some helper procedures to access content so you don't need to write prefs.content[] you can just prefs[]:

assert prefs["lang"] == "en"

To read a nested key you can use the {} operator:

assert prefs{"scheme", "font", "family"} == "UbuntuMono" # This acceses prefs.content
assert prefs["scheme"]["font"]["family"] == "UbuntuMono" # This acceses prefs.content

Writing

prefs["lang"] = "es" # Same as prefs.content["lang"] = "es"
assert prefs["lang"] == "es"

Same with nested keys:

prefs{"scheme", "font", "size"} = 20
assert prefs{"scheme", "font", "size"} == 20

prefs["scheme"]["font"]["size"] = 10
assert prefs["scheme"]["font"]["size"] == 10

Removing

assert "lang" in prefs

prefs.delete("lang")

assert "lang" notin prefs

## Overwriting To reset a key to its default value or reset the whole preferences use Prefs.overwrite():

assert prefs["lang"] == "en"
prefs["lang"] = "es"
prefs.overwrite("lang")
assert prefs["lang"] == "en"

Nested key:

assert prefs{"scheme", "font", "size"} == 15
prefs{"scheme", "font", "size"} = 20
prefs.overwrite(["scheme", "font", "size"])
assert prefs{"scheme", "font", "size"} == 15

Whole file:

prefs["lang"] = "es"
prefs["dark"] = false

prefs.overwrite()

assert prefs["lang"] == "en"
assert prefs["dark"] == true