Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the simple-config Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:46:51 2021 GMT+0.
• Introduction | What simple-config is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
a library to load and parse simple config files of the format KEY = VALUE
attempts to parse each value into its proper lisp data type.
config example:
env = development
program-version=2
aws_bucket = config-bucket
(ql:quickload :simple-config)
load-config
- file-path &key parse-lists list-separator
Loads a config file from FILE-PATH
if PARSE-LISTS is non-nil VALUES are checked for LIST-SEPARATOR and split by it.
PARSE-LISTS defaults to t
LIST-SEPARATOR defaults to #\,
Returns t if successfully loaded, otherwise nil
config
- key &optional default
Checks loaded config for KEY, returning nil if not found
If DEFAULT is given, returns it instead of nil if KEY isn't found
save-config
- file-path
writes the currently loaded config to FILE-PATH, overwriting it if it already exists
BSD 3-Clause
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The simple-config system |
ava fox <dev@computerfox.xyz>
BSD 3-Clause
loads and parses a KEY=VALUE style config file
1.0
simple-config.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The simple-config.asd file | ||
• The simple-config/package.lisp file | ||
• The simple-config/simple-config.lisp file |
Next: The simple-config/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
simple-config.asd
simple-config (system)
Next: The simple-config/simple-config․lisp file, Previous: The simple-config․asd file, Up: Lisp files [Contents][Index]
simple-config (system)
package.lisp
Previous: The simple-config/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
simple-config (system)
simple-config.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The simple-config package |
package.lisp (file)
conf
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported functions | ||
• Exported generic functions |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
retrieve the value from config using KEY, returns nil if not found
if DEFAULT is given returns it instead of nil when KEY is not found
simple-config.lisp (file)
(setf config) (generic function)
loads config at FILE-PATH
PARSE-LISTS defaults to t
LIST-SEPARATOR defaults to #,
if PARSE-LISTS is non-nil we check any value for character LIST-SEPARATOR and split it by that
returns T on success, NIL otherwise
simple-config.lisp (file)
saves currently loaded config to FILEPATH
simple-config.lisp (file)
Previous: Exported functions, Up: Exported definitions [Contents][Index]
config (function)
allows us to do setf on (config) calls
simple-config.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal functions |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
our loaded config
simple-config.lisp (file)
simple-config.lisp (file)
simple-config.lisp (file)
Previous: Internal special variables, Up: Internal definitions [Contents][Index]
checks if LINE is a full line comments
simple-config.lisp (file)
determines what kind of data VALUE is, and parses it correctly
simple-config.lisp (file)
custom format function that prints out config
simple-config.lisp (file)
converts STR into a keyword
replaces all underscores with hyphens
simple-config.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L S |
---|
Jump to: | F L S |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
C F G L M P S |
---|
Jump to: | (
C F G L M P S |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | P S |
---|
Jump to: | P S |
---|