Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/norfairking/opt-env-conf
https://github.com/norfairking/opt-env-conf
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/norfairking/opt-env-conf
- Owner: NorfairKing
- Created: 2024-05-26T01:02:05.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-11-05T23:07:20.000Z (about 2 months ago)
- Last Synced: 2024-12-13T18:09:19.827Z (11 days ago)
- Language: Haskell
- Size: 780 KB
- Stars: 23
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OptEnvConf
## Status
Used in production in all my products and some companies.
## Goals
* Parse command-line arguments, environment variables, and configuration values all together.
* Self-documenting parsers for correct-by-construction documentation
* Best-in-class command-line autocompletion
* Best-in-class errors
* Formatter-friendly API
## Features
- [x] Parsing
- [x] Argument: `progname hello`
- [x] Option: `progname --file foo.txt`
- [x] Long Option: `progname --file foo.txt`
- [x] Short Option: `progname --file foo.txt`
- [x] Equals-version of long option: `progname --file=foo.txt`
- [x] Shorthand-version of short option: `progname -ffoo.txt`
- [x] Switch: `progname --verbose`
- [x] Long switch: `progname --verbose`
- [x] Short switch: `progname -v`
- [x] Documentation
- [x] `--help`
- [x] Global `--help` page
- [x] Per-command `--help` page
- [x] Generated `--version` command
- [x] Generated manpage
- [ ] Completion
- [x] Bash completion
- [x] Zsh completion
- [x] Fish completion
- [x] Static settings check
## Comparison to similar projects
| | `opt-env-conf` | `optparse-applicative` | `envparse` | `autodocodec` |
|--------------------------------------|----------------|------------------------|------------|---------------|
| Applicative parsing | ✔️ | ✔️ | ✔️ | ✔️ |
| Parsing arguments | ✔️ | ✔️ | ✖️ | ✖️ |
| Parsing long options | ✔️ | ✔️ | ✖️ | ✖️ |
| Parsing short options | ✔️ | ✔️ | ✖️ | ✖️ |
| Parsing short-hand short options | ✔️ | ✔️ | ✖️ | ✖️ |
| Parsing short-hand long options | ✔️ | ✔️ | ✖️ | ✖️ |
| Parsing long switches | ✔️ | ✔️ | ✖️ | ✖️ |
| Parsing short switches | ✔️ | ✔️ | ✖️ | ✖️ |
| Parsing environment variables | ✔️ | ✖️ | ✔️ | ✖️ |
| Parsing configuration values | ✔️ | ✖️ | ✖️ | ✔️ |
| Generated global `--help` page | ✔️ | ✔️ | ✖️ | ✖️ |
| Coloured global `--help` page | ✔️ | ✖️ | ✖️ | ✖️ |
| Generated per-command `--help` page | ✔️ | ✔️ | ✖️ | ✖️ |
| Coloured per-command `--help` page | ✔️ | ✖️ | ✖️ | ✖️ |
| Generated `--version` command | ✔️ | ✖️ | ✖️ | ✖️ |
| Generated manpage | ✔️ | ✖️ | ✖️ | ✖️ |
| Helpful parse errors | ✔️ | ✔️ | ✔️ | ✔️ |
| Coloured parse errors | ✔️ | ✖️ | ✖️ | ✖️ |
| Generated manpage | ✔️ | ✖️ | ✖️ | ✖️ |
| Typo suggestions | 🚧 | ✖️ | ✖️ | ✖️ |
| Bash completion | 🚧 | ✔️ | ✖️ | ✖️ |
| Zsh completion | 🚧 | ✔️ | ✖️ | ✖️ |
| Fish completion | 🚧 | ✔️ | ✖️ | ✖️ |
| Static settings check | ✔️ | ✖️ | ✖️ | ✖️ |
## Example
The [example application](./opt-env-conf-example) contains a fully worked example.
This example is part of the build in CI so you can rely on it being up-to-date.