LiteConfig 1.0.4

LiteConfig (.lc) Library

LiteConfig (.lc) is a lightweight configuration file format designed for ease of use primacy.

Features

• Types: Read values in standard types int, float, double, bool, and string with dedicated methods - Other types will attempt to be dynamically understood
• Dictionary: Optionally cache your config file using the included Data property for dictionary access
• Fidelity: Writes update a key where it stands. Comments, blank lines, ordering, indentation, encoding and line endings all survive
• Portability: All parsing and formatting is culture invariant, so a file reads the same on every machine
• Simplicity: LC is designed to be a very barebones format, and as such very few "extras" are included

The exact grammar is in SPEC.md.

Installation

Using NuGet:

Install-Package LiteConfig

Example File

# Single line comments
title: Example
shortForm: single-line strings do not require double quotes
longForm: "strings of text with multiple lines,
can be written by enclosing the whole block of text in double quotes."
firstToggle: True
secondToggle: false
whatDayIsIt: 01/01/1970
lines: 11
collection: item1, item2
collectionSize: 2.0
servers:
  - alpha
  - beta

Usage

using LiteConfig;

public class App
{
	public App()
	{
		LC lc = new();
		lc.LoadFromFile("config.lc");
		string name = lc.Data["name"];

		// OR
		name = LC.ReadString("config.lc", "name");

		// OR
		name = LC.ReadValue<string>("config.lc", "name");

		string item1 = LC.ReadList<string>("config.lc", "collection").ToArray()[0];
	}
}

Writing updates the key in place and leaves the rest of the file alone:

LC.WriteValue("config.lc", "lines", 12);   // Rewrites only that line
LC.WriteValue("config.lc", "newKey", 1);   // Appended at the end

// Or change several values and save once
LC lc = new();
lc.LoadFromFile("config.lc");
lc.Data["lines"] = 12;
lc.Data["servers"] = new List<string> { "alpha", "gamma" };
lc.WriteToFile("config.lc");

Changes in 1.0.4

Parsing and writing were rebuilt on a shared scanner. Previously:

• A single-line quoted value such as title: "Example" swallowed the rest of the file and produced no keys at all
• WriteValue on a key already present in the file did nothing, silently
• Values in Data that were not strings were dropped on write, silently
• Number and date parsing followed the current culture, so a file that read correctly in one locale threw in another
• A comment line with leading whitespace threw; a comment line inside a quoted value was deleted from the value
• LoadFromFile merged into whatever was already loaded instead of replacing it
• ReadString and ReadList returned null or threw NullReferenceException on block-form lists
• A missing key produced KeyNotFoundException from inside the error handler, discarding the intended message

All of the above are fixed. WriteToFile is now public, error messages carry line numbers, saves are atomic, and ReadValue<T> also accepts enums and the boolean spellings yes, no, on, off, 1, 0. An unterminated quoted value now raises an error rather than silently discarding the value.

Distribution and Usage Rights

You are granted full freedom and permission to:

• Distribute this library as you see fit, whether in its original form or in a modified version.
• Decompile and use any part of the code directly in your projects.
• Copy code from the repository, and use any part of the code directly in your projects.
• Bundle it within an executable or any other software structure.
• Re-purpose and use this library in any other manner you deem necessary.

In essence, you have carte blanche to utilize this library in any manner you choose. Please remember to respect the licensing agreement for any other third-party libraries or resources that LiteConfig may depend on.

License

This library is licensed under the GPL License.