Skip to content

fix: do not prompt on non-interactive terminals #622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: do not prompt on non-interactive terminals #622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ...-mordant/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/options/PromptOptions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.github.ajalt.clikt.parameters.options

import com.github.ajalt.clikt.core.Abort
import com.github.ajalt.clikt.core.MissingOption
import com.github.ajalt.clikt.core.UsageError
import com.github.ajalt.clikt.core.terminal
import com.github.ajalt.clikt.output.ParameterFormatter
Expand All @@ -17,6 +18,8 @@ import com.github.ajalt.mordant.terminal.YesNoPrompt
* time the user enters a value. This means that, unlike normal options, the validation for prompt
* options cannot reference other parameters.
*
* Note that if the terminal's input is non-interactive, this function is effectively identical to [required].
*
* @param text The text to prompt the user with
* @param default The default value to use if no input is given. If null, the prompt will be repeated until
* input is given.
Expand All @@ -40,6 +43,7 @@ fun <T : Any> NullableOption<T, T>.prompt(
?.replace(Regex("\\W"), " ")?.capitalize2() ?: "Value"
val provided = invocations.lastOrNull()
if (provided != null) return@transformAll provided
if (!terminal.terminalInfo.inputInteractive) throw MissingOption(option)
if (context.errorEncountered) throw Abort()

val builder: (String) -> Prompt<T> = {
Expand Down Expand Up @@ -89,6 +93,8 @@ fun <T : Any> NullableOption<T, T>.prompt(
/**
* If the option isn't given on the command line, prompt the user for manual input.
*
* Note that if the terminal's input is non-interactive, this function is effectively identical to [required].
*
* @param text The message asking for input to show the user
* @param default The value to return if the user enters an empty line, or `null` to require a value
* @param uppercaseDefault If true and [default] is not `null`, the default choice will be shown in uppercase.
Expand All @@ -112,6 +118,7 @@ fun OptionWithValues<Boolean, Boolean, Boolean>.prompt(
transformAll = { invocations ->
when (val provided = invocations.lastOrNull()) {
null -> {
if (!terminal.terminalInfo.inputInteractive) throw MissingOption(option)
YesNoPrompt(
prompt = text,
terminal = context.terminal,
Expand Down
71 changes: 59 additions & 12 deletions test/src/commonTest/kotlin/com/github/ajalt/clikt/parameters/PromptOptionsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package com.github.ajalt.clikt.parameters
import com.github.ajalt.clikt.core.subcommands
import com.github.ajalt.clikt.core.terminal
import com.github.ajalt.clikt.parameters.options.check
import com.github.ajalt.clikt.parameters.options.flag
import com.github.ajalt.clikt.parameters.options.nullableFlag
import com.github.ajalt.clikt.parameters.options.option
import com.github.ajalt.clikt.parameters.options.prompt
Expand All @@ -12,6 +13,8 @@ import com.github.ajalt.clikt.testing.test
import com.github.ajalt.mordant.terminal.ConversionResult
import com.github.ajalt.mordant.terminal.YesNoPrompt
import com.github.ajalt.mordant.terminal.prompt
import io.kotest.matchers.booleans.shouldBeTrue
import io.kotest.matchers.should
import io.kotest.matchers.shouldBe
import io.kotest.matchers.string.shouldContain
import kotlin.js.JsName
Expand All @@ -27,7 +30,7 @@ class PromptOptionsTest {
terminal.prompt("Baz") { ConversionResult.Valid(it.toInt()) } shouldBe 1
}
}
C().test("", stdin = "bar\n1").output shouldBe "Foo: Baz: "
C().test("", stdin = "bar\n1", inputInteractive = true).output shouldBe "Foo: Baz: "
}

@[Test JsName("command_confirm")]
Expand All @@ -37,7 +40,7 @@ class PromptOptionsTest {
YesNoPrompt("Foo", terminal, default = false).ask() shouldBe true
}
}
C().test("", stdin = "y").output shouldBe "Foo [y/N]: "
C().test("", stdin = "y", inputInteractive = true).output shouldBe "Foo [y/N]: "
}

@[Test JsName("prompt_option")]
Expand All @@ -50,7 +53,7 @@ class PromptOptionsTest {
bar shouldBe "bar"
}
}
C().test("", stdin = "foo\nbar").output shouldBe "Foo: Bar: "
C().test("", stdin = "foo\nbar", inputInteractive = true).output shouldBe "Foo: Bar: "
}

@[Test JsName("prompt_option_after_error")]
Expand All @@ -60,7 +63,7 @@ class PromptOptionsTest {
val bar by option().prompt()
}

val result = C().test("--foo=x")
val result = C().test("--foo=x", inputInteractive = true)
result.stdout shouldBe ""
result.stderr shouldContain "invalid value for --foo: x is not a valid integer"
}
Expand All @@ -73,7 +76,7 @@ class PromptOptionsTest {
foo shouldBe "foo"
}
}
C().test("", stdin = "foo\nfoo").output shouldBe "Foo: Repeat for confirmation: "
C().test("", stdin = "foo\nfoo", inputInteractive = true).output shouldBe "Foo: Repeat for confirmation: "
}

@[Test JsName("prompt_flag")]
Expand All @@ -88,7 +91,7 @@ class PromptOptionsTest {
baz shouldBe null
}
}
C().test("", stdin = "yes\nf").output shouldBe "Foo: Bar: "
C().test("", stdin = "yes\nf", inputInteractive = true).output shouldBe "Foo: Bar: "
}

@[Test JsName("prompt_option_validate")]
Expand All @@ -99,7 +102,7 @@ class PromptOptionsTest {
foo shouldBe "foo"
}
}
C().test("", stdin = "f\nfoo").output shouldBe "Foo: invalid value for --foo: f\nFoo: "
C().test("", stdin = "f\nfoo", inputInteractive = true).output shouldBe "Foo: invalid value for --foo: f\nFoo: "
}

@[Test JsName("custom_console_inherited_by_subcommand")]
Expand All @@ -111,7 +114,7 @@ class PromptOptionsTest {
}
}

val r = TestCommand().subcommands(C()).test("c", stdin = "bar")
val r = TestCommand().subcommands(C()).test("c", stdin = "bar", inputInteractive = true)
r.output shouldBe "Foo: "
}

Expand All @@ -123,7 +126,7 @@ class PromptOptionsTest {
foo shouldBe "foo"
}
}
C().test("", stdin = "foo").output shouldBe "INPUT: "
C().test("", stdin = "foo", inputInteractive = true).output shouldBe "INPUT: "
}

@[Test JsName("inferred_names")]
Expand All @@ -138,7 +141,7 @@ class PromptOptionsTest {
baz shouldBe "baz"
}
}
C().test("", stdin = "foo\nbar\nbaz").output shouldBe "Foo: Bar: Some thing: "
C().test("", stdin = "foo\nbar\nbaz", inputInteractive = true).output shouldBe "Foo: Bar: Some thing: "
}

@[Test JsName("prompt_default")]
Expand All @@ -150,7 +153,7 @@ class PromptOptionsTest {
}
}

C().test("", stdin = "bar").output shouldBe "Foo (baz): "
C().test("", stdin = "bar", inputInteractive = true).output shouldBe "Foo (baz): "
}

@[Test JsName("prompt_default_no_stdin")]
Expand All @@ -162,6 +165,50 @@ class PromptOptionsTest {
}
}

C().test("").output shouldBe "Foo (baz): "
C().test("", inputInteractive = true).output shouldBe "Foo (baz): "
}

@[Test JsName("prompt_non_interactive_terminal")]
fun `prompt non-interactive terminal`() {
class C : TestCommand() {
val foo by option().prompt()
override fun run_() {
foo shouldBe "baz"
}
}

C().test("", stdin = "baz", inputInteractive = true, outputInteractive = true).output shouldBe "Foo: "

C().test("", stdin = "baz", inputInteractive = false, outputInteractive = true) should { result ->
result.output shouldBe """
Usage: c [<options>]

Error: missing option --foo

""".trimIndent()
result.statusCode shouldBe 1
}
}

@[Test JsName("flag_prompt_non_interactive_terminal")]
fun `flag prompt non-interactive terminal`() {
class C : TestCommand() {
val foo by option().flag().prompt("Want to foo?")
override fun run_() {
foo.shouldBeTrue()
}
}

C().test("", stdin = "y", inputInteractive = true, outputInteractive = true).output shouldBe "Want to foo? [y/n]: "

C().test("", stdin = "y", inputInteractive = false, outputInteractive = true) should { result ->
result.output shouldBe """
Usage: c [<options>]

Error: missing option --foo

""".trimIndent()
result.statusCode shouldBe 1
}
}
}
2 changes: 1 addition & 1 deletion test/src/commonTest/kotlin/com/github/ajalt/clikt/testing/TestingUtilsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class TestingUtilsTest {
}
}

val result = C().test("", stdin = "foo\nbar")
val result = C().test("", stdin = "foo\nbar", inputInteractive = true)
result.stdout shouldBe "O1: O2: "
result.stderr shouldBe "err\n"
result.output shouldBe "O1: O2: err\n"
Expand Down