emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

feat(cli): allow multiple implicit types for options

Browse source 
Now you can specify more than one allowed (implicit) for a CLI option:

  (defcli! (doom somecommand) ((foo ("--foo" (file int)))))

This will test FOO to ensure it is either an existing file path or an
integer. If neither is true, you'll see this helpful error:

  Error: -o/--file received invalid value "FOO"

  Validation errors:
  - Not an integer.
  - Not a valid path to an existing file.
This commit is contained in:
Henrik Lissner 2022-08-07 17:26:07 +02:00
parent 057e6c531c
commit 26bc4ea150
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
lisp/doom-cli-lib.el
View file

@ -537,9 +537,9 @@ Throws `doom-cli-invalid-option-error' for illegal values."
nil (cl-loop for spec in argspec nil (cl-loop for spec in argspec
if (or (and (stringp spec) if (or (and (stringp spec)
(not (string-match-p "^-\\(?:-[a-zA-Z0-9]\\|[^-]$\\)" spec))) (not (string-match-p "^-\\(?:-[a-zA-Z0-9]\\|[^-]$\\)" spec)))
(keywordp spec)) (keywordp spec)
collect spec (symbolp spec)
else if (symbolp spec) (listp spec))
collect spec))) collect spec)))
(defun doom-cli--make-option-generic (symbol spec &optional docs) (defun doom-cli--make-option-generic (symbol spec &optional docs)
@ -1408,14 +1408,16 @@ formats:
If a string, they are used verbatim as the argument's documentation. Use If a string, they are used verbatim as the argument's documentation. Use
this to document more complex specifications, like \"[user@]host[:port]\". this to document more complex specifications, like \"[user@]host[:port]\".
Use reference `quotes' to highlight arguments appropriately. Use reference `quotes' to highlight arguments appropriately. No input
validation is performed on these arguments.
If a symbol, this is equivalent to (upcase (format \"`%s'\" SYMBOL)), but If a symbol, this is equivalent to (upcase (format \"`%s'\" SYMBOL)), but
its arguments will also be implicitly validated against its arguments will also be implicitly validated against
`doom-cli-option-arg-types'. `doom-cli-option-arg-types'.
A nested list indicates that an argument accepts multiple types, and are A nested list indicates that an argument accepts multiple types, and are
implicitly joined into \"`ARG1'|`ARG2'|...\". implicitly joined into \"`ARG1'|`ARG2'|...\". Input validation is performed
on symbols only.
WARNING: If this option is a &flag, the option must not accept arguments. WARNING: If this option is a &flag, the option must not accept arguments.
Instead, use ARGSPEC to specify a single, default value (one of `:yes' or Instead, use ARGSPEC to specify a single, default value (one of `:yes' or