search

krieselreihe / litr

Litr (Language Independent Task Runner) lets you configure and then run any tasks you want for any language.
MIT License
8 stars 0 forks source link

Handle "help" #3

Closed MartinHelmut closed 3 years ago

MartinHelmut commented 3 years ago

Goal

The only not user defined Litr call should be litr --help to show the help text. The help text should be as user friendly as possible and give some meaningful information even on a minimal example.

Open questions

MartinHelmut commented 3 years ago

One possible solution could be to restrict usage of the help parameter in general, giving an error message to the user that "help is not allowed to specify" if it is used. This error message should give context where it is, why it is not allowed and how users can influence the generate help text (e.g. using the example property on commands).

MartinHelmut commented 3 years ago

Went for the "restrict certain parameter names" and documented here: https://github.com/krieselreihe/litr/wiki/Setup#restricted-parameters