cl-inix is a flexible library for .INI/.conf file parsing

cl-inix

* cl-inix

*cl-inix is a flexible .ini/.conf file parser with sane defaults.*

~cl-inix~ is an attempt at making an .ini parser that'd work for me.
Meaning:
- Configurable key format.
- Support for arbitrary section and key names.
- Flexible output format.
- Defaults that don't break anything.

This library is partially inspired by [[https://github.com/compufox/cl-ini][cl-ini]].
Which is a reasonable library, actually.
Just not as configurable/flexible as I prefer.

** Getting Started
Clone the Git repository:
#+begin_src sh
  git clone --recursive https://github.com/aartaka/cl-inix ~/.local/share/common-lisp/source/
#+end_src

And then load ~:cl-inix~ in the REPL:
#+begin_src lisp
  (asdf:load-system :cl-inix)
  ;; or, if you use Quicklisp
  (ql:quickload :cl-inix)
#+end_src

** API
The main entry point is, of course, .ini parsing, available with ~read~:
#+begin_src lisp
  (cl-inix:read "a = b")
  ;; ((T ("a" . "b")))
  (cl-inix:read #p"~/.gitconfig")
  ;; (("user" ("name" . "Artyom Bologov"))
  ;;  ("init" ("defaultBranch" . "main"))
  ;;  ("core" ("editor" . "aed")))
#+end_src

There are multiple key conversion helpers for ~read~, including ~keyword~, ~string~ (essentially ~cl:identity~), ~symbol~:
#+begin_src lisp
  (cl-inix:read "a = b" :key :keyword)
  ;; ((T (:a . "b")))
  (cl-inix:read "a = b" :key :string)
  ;; ((T ("a" . "b")))
  (cl-inix:read "a = b" :key :symbol :package :cl-inix)
  ;; ((T (cl-inix::a . "b")))
  (cl-inix:read "a = b" :key #'(lambda (key &rest args) (uiop:strcat "---" key)))
  ;; ((T ("---a" . "b")))
#+end_src

Output format is also configurable, being either of ~alist~ (default) or ~hash-table~:
#+begin_src lisp
  (cl-inix:read #p"~/.gitconfig" :format :hash-table)
  ;; #<HASH-TABLE :TEST EQUAL :COUNT 6 {12038D18C3}>
#+end_src

Values can also be fetched with ~get~, whatever the format of the parsed .ini:
#+begin_src lisp
  (cl-inix:get "name" (cl-inix:read #p"~/.gitconfig" :format :hash-table) :section "user")
  ;; => "Artyom Bologov", T
  (cl-inix:get "name" (cl-inix:read #p"~/.gitconfig") :section "user")
  ;; => "Artyom Bologov"
#+end_src

There are typed helpers for ~get~:
- ~get-string~ as a no-op to get the value under the key
- ~get-integer~ to get integer from under the key
- ~get-boolean~ to get a (configurable format) boolean
- ~get-array~ to parse (with delimiters) an array
- ~get-read~ to ~cl:read~ any value from under the key

Finally, values can be ~write~-n as .ini text:
#+begin_src lisp
  (cl-inix:write (cl-inix:read #p"~/.gitconfig" :key :symbol) #p"~/.gitconfig2"
                 :delimiter ": "
                 :key-case :upcase)
#+end_src


cl-inix

Upstream URL

Author

License

cl-inix

Version:

License:

Authors:

Dependencies:

cl-inix/tests

Dependencies:

Dependencies (1)

Dependents (0)