Improve command line experience

clj-holmes / clj-watson

clojure deps SCA

Eclipse Public License 2.0

83 stars 9 forks source link

Improve command line experience #80

Closed lread closed 3 months ago

lread commented 3 months ago

When running via -X or -T:

args are now validated
benefits from rich bb cli coercion support
usage help shows using keyword :arg syntax

When running via -M:

preserved existing behaviour
support more coercions
usage help shows using cli -arg syntax

General:

Narrower, easier to read usage help
Options relating only to dependency-check strategy are now grouped under their own heading
Some rewording/rewriting of descriptions for clarity
Command line error styled in red for visibility
Support for aligning multi-line argument descriptions
File options fail fast if file does not exist
More coercions to keywords happen at command parse time instead of within code. Code adjusted appropriately.

Closes #77

lread commented 3 months ago

Hmm... I'll look into suppressing that clj-holmes false positive. Not familiar with clj-holmes yet.

seancorfield commented 3 months ago

Try renaming spec-scan-args to something that doesn't have spec in its name?

lread commented 3 months ago

Good guess, but no dice, it still reports the same finding! I'll keep poking around.

lread commented 3 months ago

Hmmm... it is making some pretty bold assumptions about specs, this triggers the finding as well:

(def foo {:bingo
          {:require true}})

Tried copying it to other namespaces just in case ns-name was involved in decision. Does not seem to be!

seancorfield commented 3 months ago

It's from the clj-holmes-rules repo and there are only two rule tags: correctness (with just this one bad rule) and security -- so you should be able to specify -T security to the invocation and it will only run the security rules.

seancorfield commented 3 months ago

Specifically: add tags: 'security' to the with: clause for the clj-holmes action should do it.

lread commented 3 months ago

Oh. Pushed a week hack while you were writing that. Ok, will try.

seancorfield commented 3 months ago

Good grief! 😞 I've logged bugs against clj-holmes-rules (for the bad correctness rule) and against clj-holmes-action (for not accepting tags:).

Looks like it will have to be your workaround for now.

lread commented 3 months ago

Oh bother! Hack it is! I'll raise a separate issue here about clj-holmes so we actually remember to undo the little hack.