#compiler #config

bin+lib ucg

A configuration generation grammar

25 releases

✓ Uses Rust 2018 edition

0.3.0 Jan 10, 2019
0.2.7 Dec 13, 2018
0.2.6 Nov 27, 2018
0.1.5 Jul 4, 2018
0.0.4 Mar 29, 2018

#16 in Configuration

Download history 143/week @ 2018-10-19 5/week @ 2018-10-26 77/week @ 2018-11-02 107/week @ 2018-11-09 57/week @ 2018-11-16 38/week @ 2018-11-23 117/week @ 2018-11-30 22/week @ 2018-12-07 41/week @ 2018-12-14 27/week @ 2018-12-21 47/week @ 2018-12-28 25/week @ 2019-01-04 52/week @ 2019-01-11

252 downloads per month

Apache-2.0

259KB
6.5K SLoC

Universal Configuration Grammar.

Build Status

This is an experiment in configuration management. The approach is not to create a "parsable" config file format. We have plenty of those. Instead we try to specify a grammar for describing configuration values that can then target various configuration formats to output to.

In theory this could support anything from command line flags to json to yaml or toml or even xml.

The goal is to allow a global shared configuration repository that can be version controlled, enforce some typesafety, and output configuration for any application regardless of that applications preferred format.

The Usual Warnings

This is still very much an experiment and the language and api can be expected to change and mutate. It also probably has bugs and isn't yet the most user friendly language and compiler to use. You have been warned.

Usage

You can get ucg with cargo cargo install ucg.

Running ucg help will show the following output.

Universal Configuration Grammar compiler.

USAGE:
    ucg [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    build       Build a specific ucg file.
    help        Prints this message or the help of the given subcommand(s)
    inspect     Inspect a specific symbol in a ucg file.
    test        Check a specific ucg file for errors.

Compiling

Build a list of ucg files.

USAGE:
    ucg build [FLAGS] -r [INPUT]...

FLAGS:
    -h, --help       Prints help information
    -r               Whether we should recurse in directories or not.
    -V, --version    Prints version information

ARGS:
    <INPUT>...    Input ucg files or directories to build. If not provided then build the contents of the current directory.

Testing

Check a list of ucg files for errors and run test assertions.

USAGE:
   ucg test [FLAGS] -r [INPUT]...

FLAGS:
   -h, --help       Prints help information
   -r               Whether we should recurse or not.
   -V, --version    Prints version information

ARGS:
   <INPUT>...    Input ucg files or directories to run test assertions for. If not provided it will scan the current directory for files with _test.ucg

Language Reference

https://ucg.marzhillstudios.com/reference

Dependencies

~5.5MB
~92K SLoC