Skip to content
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.

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

Use picocli for parsing action parameters #602

Open
rsenden opened this issue Sep 19, 2024 · 0 comments
Open

Use picocli for parsing action parameters #602

rsenden opened this issue Sep 19, 2024 · 0 comments
Labels
effort:medium Medium effort needed to implement/fix enhancement New feature or request fcli-actions prio:medium Medium priority

Comments

@rsenden
Copy link
Contributor

rsenden commented Sep 19, 2024

Enhancement Request

Fcli actions currently use a custom mechanism for parsing action command-line arguments, handling parameter errors, and generating usage help. It would be great if we can re-use picocli functionality to handle these things, providing much better consistency with regular fcli commands:

  • Ability to use the same default values provider, supporting FCLI_DEFAULT_* environment variables for action parameters
  • Have picocli generate action usage help
  • Have picocli generate synopsis and other information for use in the fcli * action asciidoc commands
  • Have picocli handle invalid options (required option missing, unknown options, incorrect values, ...)

More research is needed to see whether this is viable and how to best implement this, but a partial implementation is readily available at https://github.com/fortify/fcli/tree/actions-picocli

@rsenden rsenden added enhancement New feature or request fcli-actions prio:medium Medium priority effort:medium Medium effort needed to implement/fix labels Sep 19, 2024
rsenden added a commit that referenced this issue Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort:medium Medium effort needed to implement/fix enhancement New feature or request fcli-actions prio:medium Medium priority
Projects
None yet
Development

No branches or pull requests

1 participant