Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gianlucaguarini/fortytwo
List of interactive prompt helpers to pimp the UIs of your haskell programs
https://github.com/gianlucaguarini/fortytwo
Last synced: 2 days ago
JSON representation
List of interactive prompt helpers to pimp the UIs of your haskell programs
- Host: GitHub
- URL: https://github.com/gianlucaguarini/fortytwo
- Owner: GianlucaGuarini
- License: mit
- Created: 2017-10-18T21:27:25.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2023-08-26T21:36:41.000Z (about 1 year ago)
- Last Synced: 2024-04-29T02:04:04.885Z (5 months ago)
- Language: Haskell
- Homepage:
- Size: 774 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fortytwo
_Interactive terminal prompt_
[![Build Status][ci-image]][ci-url]
[![MIT License][license-image]][license-url]
## Installation
```sh
cabal install fortytwo
```
## Demo
## API
### Prompts
#### Input
Ask a simple question requiring the user to type any string. It returns always a `String`
```hs
import FortyTwo (input)
main :: IO String
main = input "What's your name?"
```
`inputWithDefault` will let you define a fallback answer if no answer will be provided
```hs
import FortyTwo (inputWithDefault)
main :: IO String
main = inputWithDefault "What's your name?" "Undefined"
```
#### Confirm
Confirm prompt returning a boolean either `True` or `False`. If no answer will be provided it will return `False`
```hs
import FortyTwo (confirm)
main :: IO Bool
main = confirm "Are you old enough to see this?"
```
`confirmWithDefault` will let you define a fallback answer if no answer will be provided
```hs
import FortyTwo (confirmWithDefault)
main :: IO Bool
main = confirmWithDefault "Are you old enough to see this?" True
```
#### Password
Password prompt hiding the values typed by the user. It will always return a `String`
```hs
import FortyTwo (password)
main :: IO String
main = password "What's your secret password?"
```
#### Select
Select prompt letting users decide between one of many possible answers. It will always return a `String`
```hs
import FortyTwo (select)
main :: IO String
main = select
"What's your favourite color?"
["Red", "Yellow", "Blue"]
```
`selectWithDefault` will let you define a fallback answer if no answer will be provided
```hs
import FortyTwo (selectWithDefault)
main :: IO String
main = selectWithDefault
"What's your favourite color?"
["Red", "Yellow", "Blue"]
"Red"
```
#### Multiselect
Multiselect prompt letting users decide between multiple possible choices. It will always return a collection `[String]`
```hs
import FortyTwo (multiselect)
main :: IO [String]
main = multiselect
"What are your favourite films?"
["Titanic", "Matrix", "The Gladiator"]
```
`multiselectWithDefault` will let you define a fallback answer if no answer will be provided
```hs
import FortyTwo (multiselectWithDefault)
main :: IO [String]
main = multiselectWithDefault
"What are your favourite films?"
["Titanic", "Matrix", "The Gladiator"]
["The Gladiator"]
```
# Inspiration
This script is heavily inspired by [survey (golang)](https://github.com/AlecAivazis/survey)
[ci-image]: https://img.shields.io/github/actions/workflow/status/GianlucaGuarini/fortytwo/ci.yml?style=flat-square
[ci-url]: https://github.com/GianlucaGuarini/fortytwo/actions
[license-image]:http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
[license-url]:LICENSE