jbang icon indicating copy to clipboard operation
jbang copied to clipboard

review command / flags for consistency

Open maxandersen opened this issue 4 years ago • 1 comments
trafficstars

I think we are pretty good but would be good to review all commands/flags for consistent naming/requirements before 1.0

maxandersen avatar Dec 28 '20 08:12 maxandersen

Just noticed:

jbang cache clear --help
Unknown option: '--help'
Usage: jbang cache clear -o [--all] [--[no-]deps] [--fresh] [--[no-]jar] [--
                         [no-]jdk] [--[no-]kotlinc] [--[no-]project] --quiet [--
                         [no-]script] [--[no-]stdin] [--[no-]url] --verbose
Clear the various caches used by jbang. By default this will clear the JAR,
script, stdin and URL caches. To clear other caches list them explicitly i.e.
'--project' for temporary projects.
      --all            clear all caches
      --[no-]deps      clear dependency cache only
      --fresh          Make sure we use fresh (i.e. non-cached) resources.
      --[no-]jar       clear JAR cache only
      --[no-]jdk       clear JDK cache only
      --[no-]kotlinc   clear kotlinc cache only
  -o, --offline        Work offline. Fail-fast if dependencies are missing. No
                         connections will be attempted
      --[no-]project   clear temporary projects cache only
      --quiet          jbang will be quiet, only print when error occurs.
      --[no-]script    clear script cache only
      --[no-]stdin     clear stdin cache only
      --[no-]url       clear URL cache only
      --verbose        jbang will be verbose on what it does.

There's 2 issues here:

  • Why doesn't it support the flag --help?
  • Most flags here are singular, except for --deps which is plural

quintesse avatar Nov 12 '21 10:11 quintesse