https://github.com/ocamlpro/ez_toml
A library to parse and print TOML files
https://github.com/ocamlpro/ez_toml
Last synced: about 1 year ago
JSON representation
A library to parse and print TOML files
- Host: GitHub
- URL: https://github.com/ocamlpro/ez_toml
- Owner: OCamlPro
- License: other
- Created: 2023-09-03T22:54:19.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-05T14:12:58.000Z (over 2 years ago)
- Last Synced: 2024-03-05T15:30:49.571Z (over 2 years ago)
- Language: OCaml
- Homepage: https://ocamlpro.github.io/ez_toml/
- Size: 3.69 MB
- Stars: 6
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/ocamlpro/ez_toml/actions)
[](https://github.com/ocamlpro/ez_toml/releases)
# ez_toml
This ez_toml library is a small library to read and write files in TOML
format. Compared to the toml library, it supports more features (mixed
arrays for example), fixes a few bugs in the printer, and keeps better
track of options order and comments in file.
* Website: https://ocamlpro.github.io/ez_toml
* General Documentation: https://ocamlpro.github.io/ez_toml/sphinx
* API Documentation: https://ocamlpro.github.io/ez_toml/doc
* Sources: https://github.com/ocamlpro/ez_toml
## Basic Example
You will need to open `Ez_toml.V1`, then you have access to:
* `TOML` submodule: contains all the interesting functions
* `TOML.Types` submodule: contains all the type declarations
Usually, you should open `TOML.Types` and use qualified names to access
functions in `TOML`.
To use the following script, just rename it as `top.ml` in the source
directory of `ez_toml`, start `ocaml` and type `#use "top.ml";;`:
```ocaml
#directory "_opam/lib/ocplib_stuff";;
#directory "_opam/lib/ISO8601";;
#directory "_opam/lib/re";;
#directory "_opam/lib/re/glob";;
#directory "_opam/lib/ez_file";;
#directory "_build/install/default/lib/ez_toml";;
(* #directory "_build/default/src/ez_toml";; *)
#load "unix.cma";;
#load "ocplib_stuff.cma";;
#load "ISO8601.cma";;
#load "re.cma";;
#load "re_glob.cma";;
#load "ez_file.cma";;
#load "ez_toml.cma";;
open Ez_toml.V1
open TOML.Types
(* Look up a deeply nested value with a known type. *)
let t = TOML.of_string "
[settings]
[settings.basic]
crash_randomly = true
" ;;
(*
val t : Ez_toml.V1.TOML.Types.node =
{node_comment_before = []; node_comment_after = None;
node_loc =
{file = ""; line_begin = 2; line_end = 5; char_begin = 0; char_end = 0};
node_format = Any; node_pos = 1; node_value = Table ;
node_name = ["???"]}
*)
(* Look up a deeply nested value with a known type. *)
let crash_randomly =
TOML.get t ["settings"; "basic"; "crash_randomly"]
|> TOML.extract_bool
(* val crash_randomly : bool = true *)
(* Update a deeply nested value. *)
(* This would fail because the key already exists:
let () =
TOML.set t ["settings"; "basic"; "crash_randomly"] (TOML.int 0)
;;
raises exception 4, Ez_toml.Types.Key_already_exists ["crash_randomly"] *)
(* so, We need to silent overriding errors *)
let config = { TOML.default_config with
silent_errors =
EzCompat.IntSet.add 4 TOML.default_config.silent_errors }
;;
let () =
TOML.set ~config t ["settings"; "basic"; "crash_randomly"]
~value:(TOML.int 0)
;;
(* Print it back to a string *)
let s = TOML.to_string t
;;
(* val s : string = "\n[settings.basic]\ncrash_randomly = 0\n" *)
```
## Tests example
Check file `src/toml-check/tests.ml` for another example of simple
accesses and modifications of the TOML datastructure.