Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/norfairking/template-cli
Template Command-Line Interface
https://github.com/norfairking/template-cli
cli haskell template
Last synced: 2 days ago
JSON representation
Template Command-Line Interface
- Host: GitHub
- URL: https://github.com/norfairking/template-cli
- Owner: NorfairKing
- License: other
- Created: 2020-10-17T12:45:09.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-13T12:43:30.000Z (6 months ago)
- Last Synced: 2024-05-13T14:02:17.378Z (6 months ago)
- Topics: cli, haskell, template
- Language: Haskell
- Homepage: https://template.cs-syd.eu/template/NorfairKing/template-cli
- Size: 82 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CLI Template
This is a template implementation of a command-line tool.
It features complete option parsing, like in [template-optparse](https://github.com/NorfairKing/template-optparse) as well as command handlers, testing and best-practices.
* Haskell code for a multi-command CLI tool
* Per-command integration test
* End-to-end test
* Option parsing & Option parsing tests
* Cabal build
* Stack build
* Nix build
* Statically-linked nix build
* Coverage report
* Weeder check
* Flake-based CI
* Pre-commit hooks
## License
This template is **not** free to use.
See https://template.cs-syd.eu/template/NorfairKing/template-cli for more information.
Copyright (c) 2020-2024 Tom Sydney Kerckhove.
All Rights Reserved.
## Instructions
To use this template in a new project, choose the name for your project, for example `homeless-shelter`.
Then use [template-filler](https://github.com/NorfairKing/template-filler) to use the template, like this:
```
template-filler --source /path/to/this/template-cli --destination /path/to/your/homeless-shelter --find FooBar --replace HomelessShelter
```
### Template overview
There is a single haskell package in `fooBar-cli`.
It contains the following structure:
- The entry point in `Foo.Bar.Cli`
- Option parsing in `Foo.Bar.Cli.OptParse`
- The (read-only) environment and related functions in `Foo.Bar.Cli.Env`
- Individual commands in `Foo.Bar.Cli.`. There is an example in `Foo.Bar.Cli.Commands.Greet`
### OptParse
The option parsing is based on [the option parsing template](https://github.com/NorfairKing/template-optparse).
It is included in this template so you will not need to also buy the option parsing template.
For more information about how to use the option parsing, follow the instructions in `template-cli/src/Foo/Bar/Cli/OptParse.hs`.
### Nix build
If you don't need a nix build, remove these files:
```
rm -rf *.nix nix .github/workflows/nix.yaml
```
In `nix/nixpkgs-version.nix`, we pin a `nixpkgs` commit.
In `nix/pkgs.nix` we define our own 'version' of the `nixpkgs` by adding our own overlays.
The project overlay is defined in `nix/overlay.nix`.
See the instructions in `nix/overlay.nix` for more details.
### CI
CI is set up for both a stack build and a nix build.
See `.github/workflows` for more details.
The stack build should "just work".
For the nix build to work, there is a manual step that you need to go through:
First, make a cachix cache at cachix.org.
Put its name in the right places within `.github/workflows/nix.yaml`.
Then put its signing key in the 'Secrets' part of your repository on github.
### Workflow examples
#### Adding a command
1. Add the new command's option parsing in the `Foo.Bar.Cli.OptParse` module according to the instructions within.
2. Add a `Foo.Bar.Cli.Command.` module with a function as follows:
```
commandName :: CommandNameSettings -> C ()
```
3. Add a case to the `dispatch` function in `Foo.Bar.Cli`.
4. Add tests in `Foo.Bar.Cli.Command.Spec`.