Comments (4)
Yes, there are a number of changes that I want to make to the help formatter. This is definitely going to be added.
from clikt.
Thanks for the suggestion! I added this in 5be9f34, which is part of the 2.0.0 release.
Docs: https://ajalt.github.io/clikt/documenting/#required-options-in-help
from clikt.
That info isn't passed to the help formatter, so it can't be done automatically, but you can replace your usage of required
with something like this:
fun <EachT : Any, ValueT> NullableOption<EachT, ValueT>.requiredWithMessage()
: OptionWithValues<EachT, EachT, ValueT> {
return copy(transformValue, transformEach, { it.lastOrNull() ?: throw MissingParameter(option) },
help = "(required) $help")
}
which you would use like this:
val opt by option(help = "my option").requiredWithMessage()
to get output like this:
Usage: program [OPTIONS]
Options:
--opt TEXT (required) my option
-h, --help Show this message and exit
from clikt.
Did you consider incorporating such feature into the library? It seems quite basic.
That info isn't passed to the help formatter, so it can't be done automatically
As an end user of the library, it looks like some implementation detail that is the actual limitation. Or is the API of the library the limitation? Also, you gave an example of requiredWithMessage
which could be added to the library or replaced with the current required
, it seems generic enough :)
I have a similar issue with options with multiple possibilities - the help message also doesn't display the possible values.
from clikt.
Related Issues (20)
- Add support for TextStyle in the Text Widget. HOT 1
- [Question] Callback to execute some code when the help is shown HOT 4
- Feature request: Command/option/flag information exposed via hook HOT 2
- Init inside `Object` in Kotlin Script HOT 1
- Consider specifying limits on `counted`
- Option to echo "raw" String HOT 4
- Feature request: generation of man pages or AsciiDoc HOT 1
- Feature request: choosing from options using arrow keys or fuzzy find HOT 1
- [QUESTION] Validate input arguments without running the command HOT 1
- Support path arguments for native HOT 3
- Other ways to construct a CliktCommand object HOT 4
- Disable prompt() globally HOT 3
- Cooccuring option group with required options is passed as nullable HOT 3
- Suspending command support HOT 16
- Question: by option().multiple().groupChoice() ? HOT 5
- Question: one single argument for multiple repeating subcommands HOT 1
- clikt 4.X grew in jar size to over 8mb HOT 8
- Mutually exclusive options in OptionGroup HOT 1
- 4.4.0 CHANGELOG correct?
- Control inputInteractive and outputInteractive in CliktTesting
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from clikt.