interakt
Interactive prompts made easy!
Install
Gradle - Kotlin DSL
repositories {
mavenCentral()
}
dependencies {
implementation("xyz.davidsimon:interakt:0.1.0")
}
Maven
<dependency>
<groupId>xyz.davidsimongroupId>
<artifactId>interaktartifactId>
<version>0.1.0version>
dependency>
Usage
To construct and run an interactive prompt, you need to:
- Obtain a
Promptinstance - Add
PromptFields to the prompt - Execute the prompt
Using a few convenience methods, we can achieve all this in just a few lines of code:
prompt {
text("foo:", default = "default value")
integer("bar:", default = 42)
list("baz:", listOf("1", "2", "3"), true)
println("Result:")
for((key, value) in execute()) {
println("${key.promptMessage} $value")
}
}
Fields
PromptField
Base class for all other fields
Options:
| Parameter | Type | Description |
|---|---|---|
| promptMessage | String |
Message to display before user input |
| shouldPrompt | (PromptResult, PromptField
|
Controls whether the field should be prompted. Receives the answers entered so far and the current field's instance |
| default | (PromptResult, PromptField
|
Provides a default value that will be pre-filled |
TextField
Prompts user for simple text input
IntegerField
Prompts user for integer input
ListField
Prompts the user to choose from a list of items. The displayed name and the actual value of the items may differ.
Options:
| Parameter | Type | Description |
|---|---|---|
| choices | (PromptResult) -> List
|
Returns the available choices |
TextListField
Prompts the user to choose from a list of text items. Optionally the user may enter a custom value.
Options:
| Parameter | Type | Description |
|---|---|---|
| choices | (tr: PromptResult) -> List
|
Returns the available choices |
| allowCustom | Boolean |
Allow the user to enter a custom value. If true an additional choice will be added with an empty string value |
| customPromptMessage | String |
Message to display when user enter custom value |
Acknowledgement
interakt is built using JLine
2k Jan 4, 2023
121 Sep 10, 2022
2.2k Jan 4, 2023
1.2k Dec 17, 2022
2.3k Dec 23, 2022
247 Dec 27, 2022
0 Nov 23, 2021
0 Jan 14, 2022
34 Jan 4, 2023
1 Oct 30, 2021
5 Dec 2, 2022
4 Apr 24, 2022
3.6k Dec 27, 2022
1.4k Dec 23, 2022
171 Nov 15, 2022
97 Nov 24, 2022
2.5k Jan 9, 2023
1 Jul 7, 2022
988 Dec 22, 2022
507 Nov 12, 2022
269 Dec 1, 2022
184 Nov 25, 2022
56 Oct 3, 2022
35 Dec 10, 2022
19 Nov 9, 2021
277 Jan 7, 2023
24 Jul 18, 2022
1 Apr 25, 2022