From 2901a4edd43b5778c05c1a773f1b32758ac6f0fb Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Sun, 11 Nov 2018 19:10:11 +0100 Subject: [PATCH] add readme status about config formats --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 549c1e0..6952256 100644 --- a/README.md +++ b/README.md @@ -109,12 +109,19 @@ The syntax is pretty fast-forward, it uses 2 levels (file, fields) to find your Configuration files can be written according to some standards or application-specific syntax. This tool uses standard and third-party to parse the following formats : - [xml](https://fr.wikipedia.org/wiki/Extensible_Markup_Language) and [json](https://json.org/) are read/written using the go standard library (_cf. [json](https://golang.org/pkg/encoding/json/), [xml](https://golang.org/pkg/encoding/xml/)_). -- [yaml](https://en.wikipedia.org/wiki/YAML) with [go-yaml/yaml](https://github.com/go-yaml/yaml). +> xml to do ; complex structure the library outputs (attributes vs. content) to understand better + +- [yaml](https://en.wikipedia.org/wiki/YAML) with [go-yaml/yaml](https://github.com/go-yaml/yaml). - [ini](https://en.wikipedia.org/wiki/INI_file) with [go-ini/ini](https://github.com/go-ini/ini). - [toml](https://en.wikipedia.org/wiki/TOML) with [BurntSushi/toml](https://github.com/BurntSushi/toml). - > not consistent ; overriding a toml file with this can mess with comments and duplicate sections. Also there is type inference to do (strings are surrounded with `"`, there is `true`, `false`, etc) + +> not consistent ; overriding a toml file with this can mess with comments and duplicate sections. Also there is type inference to do (strings are surrounded with `"`, there is `true`, `false`, etc) + - [nginx configurations](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) with [lytics/confl](https://github.com/lytics/confl). + +> for now it does not work with real nginx configuration files ; must create my own driver to keep syntax and comments in place + - _and more to come..._