package scfg

  1. Overview
  2. Docs
OCaml library and executable to work with the scfg configuration file format

Install

Dune Dependency

Authors

Maintainers

Sources

0.1.tar.gz
sha256=faaafdd2cbb36e61c074aad2a28e0a63d00ef5060f436172edaf345f34071e7f
sha512=b35fb0989f1becf23c52b2c832d30c41ac705f0da2214e5535869251dcda7cb4368daae28857369273e55503344da69d404b70156f9a827db733dd8ae1b18f7f

Description

scfg is an OCaml library and executable to work with the scfg configuration file format. It provides a parser, a pretty printer and a module to perform queries.

README

scfg

scfg is an OCaml executable and library to work with the scfg configuration file format.

Installation

scfg can be installed with opam:

opam install scfg

If you don't have opam, you can install it following the how to install opam guide.

If you can't or don't want to use opam, consult the opam file for build instructions.

Quickstart

Using the library to parse a scfg file and reprint nicely:

open Scfg

let config =
  match Parse.from_file "config.scfg" with
  | Ok config -> config
  | Error e -> begin
    Format.eprintf "error: %s@." e;
    exit 1
  end

let () =
  Format.printf "%a@." Pp.config config

The provided binary does exactly this. If you have the following config.scfg file:

   name "a"        "b b b" 'c' {


       child1       ""    "I'm léo"

                child2 'nono'
     }

Running the binary on it will reprint it trying to make the output pretty:

$ scfg config.scfg
name a "b b b" c {
  child1 "" "I'm léo"
  child2 nono
}

For more, have a look at the example folder, at the documentation or at the test suite.

About

Dependencies (4)

  1. sedlex
  2. menhir >= "20211230"
  3. ocaml >= "4.13"
  4. dune >= "2.8"

Dev Dependencies (1)

  1. odoc with-doc

Used by (2)

  1. gotd
  2. sun

Conflicts

None