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.5.tar.gz
sha256=930e04c7b16fcc81e203725324ea6ace6586080f53fb87ea24c0e163588c7614
sha512=753645f5c904d48dd67dceeca12408d8bb3d9ca80ae57e9600573cf2600031c2b661cfcd70331d48cb171ce445e4826e31304ec9796ba424932bba453096c6bb

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 (9)

  1. sedlex
  2. prelude >= "0.5"
  3. ocaml >= "4.13"
  4. menhir >= "20211230"
  5. fpath
  6. fmt
  7. cmdliner >= "1.3.0"
  8. bos >= "0.2.1"
  9. dune >= "2.9"

Dev Dependencies (1)

  1. odoc with-doc

Used by (1)

  1. smtml >= "0.4.0"

Conflicts

None

OCaml

Innovation. Community. Security.