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.2.tar.gz
sha256=75bddc93dd19c2d7da6583f959b0d0a4a44aa41e9173a66d6193275f5cc1917c
sha512=92e6fa84f8ff73efd29e62babe4ca3ffbd86743443e80c743d6dd49a01597b831d832ca5bff85a2ca4ad16f99b24b717692f34e84820413c9fcc918bb96f53da

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

Conflicts

None