2022-09-06 21:57:27 +02:00
|
|
|
;;; lisp/doom-cli.el --- API+DSL for Doom's CLI framework -*- lexical-binding: t; -*-
|
refactor!(cli): rewrite CLI framework libraries
BREAKING CHANGE: this changes Doom's CLI framework in subtle ways, which
is listed in greater detail below. If you've never extended Doom's CLI,
then this won't affect you, but otherwise it'd be recommended you read
on below.
This commit focuses on the CLI framework itself and backports some
foundational changes to its DSL and how it resolves command line
arguments to CLIs, validates input, displays documentation, and persists
state across sessions -- and more. This is done in preparation for the
final stretch towarding completing the CLI rewrite (see #4273).
This is also an effort to generalize Doom's CLI (both its framework and
bin/doom), to increase it versatility and make it a viable dev tool for
other Doom projects (on our Github org) and beyond.
However, there is a *lot* to cover so I'll try to be brief:
- Refactor: generalize Doom's CLI framework by moving all bin/doom
specific configuration/commands out of core-cli into bin/doom. This
makes it easier to use bin/doom as a project-agnostic development
tool (or for users to write their own).
- Refactor: change the namespace for CLI variables/functions from
doom-cli-X to doom-X.
- Fix: subcommands being mistaken as arguments. "doom make index" will
resolve to (defcli! (doom make index)) if it exists,
otherwise (defcli! (doom make)) with "index" as an argument. Before
this, it would resolve to the latter no matter what. &rest can
override this; with (defcli! (doom make) (&rest args)), (defcli! (doom
make index)) will never be invoked.
- Refactor!: redesign our output library (was core/autoload/output.el,
is now core/autoload/print.el), and how our CLI framework buffers and
logs output, and now merges logs across (exit! ...) restarts.
- Feat: add support for :before and :after pseudo commands. E.g.
(defcli! (:before doom help) () ...)
(defcli! (:after doom sync) () ...)
Caveat: unlike advice, only one of each can be defined per-command.
- Feat: option arguments now have rudimentary type validation (see
`doom-cli-option-arg-types`). E.g.
(defcli! (doom foo) ((foo ("--foo" num))) ...)
If NUM is not a numeric, it will throw a validation error.
Any type that isn't in `doom-cli-option-arg-types` will be treated as a
wildcard string type. `num` can also be replaced with a specification,
e.g. "HOST[:PORT]", and can be formatted by using symbol quotes:
"`HOST'[:`PORT']".
- Feat: it is no longer required that options *immediately* follow the command
that defines them (but it must be somewhere after it, not before). E.g.
With:
(defcli! (:before doom foo) ((foo ("--foo"))) ...)
(defcli! (doom foo baz) () ...)
Before:
FAIL: doom --foo foo baz
GOOD: doom foo --foo baz
FAIL: doom foo baz --foo
After:
FAIL: doom --foo foo baz
GOOD: doom foo --foo baz
GOOD: doom foo baz --foo
- Refactor: CLI session state is now kept in a doom-cli-context struct (which
can be bound to a CLI-local variable with &context in the arglist):
(defcli! (doom sync) (&context context)
(print! "Command: " (doom-cli-context-command context)))
These contexts are persisted across sessions (when restarted). This is
necessary to support seamless script restarting (i.e. execve
emulation) in post-3.0.
- Feat: Doom's CLI framework now understands "--". Everything after it will be
treated as regular arguments, instead of sub-commands or options.
- Refactor!: the semantics of &rest for CLIs has changed. It used to be "all
extra literal, non-option arguments". It now means *all* unprocessed
arguments, and its use will suppress "unrecognized option" errors, and
tells the framework not to process any further subcommands. Use &args
if you just want "all literal arguments following this command".
- Feat: add new auxiliary keywords for CLI arglists: &context, &multiple,
&flags, &args, &stdin, &whole, and &cli.
- &context SYM: binds the currently running context to SYM (a
`doom-cli-context` struct). Helpful for introspection or passing
along state when calling subcommands by hand (with `call!`).
- &stdin SYM: SYM will be bound to a string containing any input piped
into the running script, or nil if none. Use
`doom-cli-context-pipe-p` to detect whether the script has been
piped into or out of.
- &multiple OPTIONS...: allows all following OPTIONS to be repeated. E.g. "foo
-x a -x b -x c" will pass (list ("-x" . "a") ("-x" . "b") ("-x" .
"c")) as -x's value.
- &flags OPTIONS...: All options after "&flags" get an implicit --no-* switch
and cannot accept arguments. Will be set to :yes or :no depending on which flag is
provided, and nil if the flag isn't provided. Otherwise, a default
value can be specified in that options' arglist. E.g.
(defcli! (doom foo) (&flags (foo ("--foo" :no))) ...)
When called, this command sets FOO to :yes if --foo, :no if --no-foo, and
defaults to :no otherwise.
- &args SYM: this replaces what &rest used to be; it binds to SYM a
list of all unprocessed (non-option) arguments.
- &rest SYM: now binds SYM to a list of all unprocessed arguments, including
options. This also suppresses "unrecognized option" errors, but will render
any sub-commands inaccessible. E.g.
(defcli! (doom make) (&rest rest) ...)
;; These are now inaccessible!
(defcli! (doom make foo) (&rest rest) ...)
(defcli! (doom make bar) (&rest rest) ...)
- &cli SYM: binds SYM to the currently running `doom-cli` struct. Can also be
obtained via `(doom-cli-get (doom-cli-context-command context))`. Possibly
useful for introspection.
- feat: add defobsolete! macro for quickly defining obsolete commands.
- feat: add defalias! macro for quickly defining alias commands.
- feat: add defautoload! macro for defining an autoloaded command (won't
be loaded until it is called for).
- refactor!: rename defcligroup! to defgroup! for consistency.
- fix: CLIs will now recursively inherit plist properties from parent
defcli-group!'s (but will stack :prefix).
- refactor!: remove obsolete 'doom update':
- refactor!: further generalize 'doom ci'
- In an effort to generalize 'doom ci' (so other Doom--or
non-doom--projects can use it), all its subcommands have been
changed to operate on the current working directory's repo instead
of $EMACSDIR.
- Doom-specific CI configuration was moved to .github/ci.el.
- All 'doom ci' commands will now preload one of \$CURRENT_REPO_ROOT/ci.el or
\$DOOMDIR/ci.el before executing.
- refactor!: changed 'doom env'
- 'doom env {-c,--clear}' is now 'doom env {clear,c}'
- -r/--reject and -a/--allow may now be specified multiple times
- refactor!: rewrote CLI help framework and error handling to be more
sophisticated and detailed.
- feat: can now initiate $PAGER on output with (exit! :pager) (or use
:pager? to only invoke pager is output is longer than the terminal is
tall).
- refactor!: changed semantics+conventions for global bin/doom options
- Single-character global options are now uppercased, to distinguish them from
local options:
- -d (for debug mode) is now -D
- -y (to suppress prompts) is now -!
- -l (to load elisp) is now -L
- -h (short for --help) is now -?
- Replace --yes/-y switches with --force/-!
- -L/--load FILE: now silently ignores file errors.
- Add --strict-load FILE: does the same as -L/--load, but throws an error if
FILE does not exist/is unreadable.
- Add -E/--eval FORM: evaluates arbitrary lisp before commands are processed.
- -L/--load, --strict-load, and -E/--eval can now be used multiple times in
one command.
- Add --pager COMMAND to specify an explicit pager. Will also obey
$DOOMPAGER envvar. Does not obey $PAGER.
- Fix #3746: which was likely caused by the generated post-script overwriting
the old mid-execution. By salting the postscript filenames (with both an
overarching session ID and a step counter).
- Docs: document websites, environment variables, and exit codes in
'doom --help'
- Feat: add imenu support for def{cli,alias,obsolete}!
Ref: #4273
Fix: #3746
Fix: #3844
2022-06-18 19:16:06 +02:00
|
|
|
;;; Commentary:
|
|
|
|
|
;;
|
2022-09-06 21:57:27 +02:00
|
|
|
;; The heart of Doom's CLI framework. This is safe to load in interactive
|
|
|
|
|
;; sessions (for API access and syntax highlighting), but much of the API
|
|
|
|
|
;; expects a noninteractive session, so take care when testing code!
|
refactor!(cli): rewrite CLI framework libraries
BREAKING CHANGE: this changes Doom's CLI framework in subtle ways, which
is listed in greater detail below. If you've never extended Doom's CLI,
then this won't affect you, but otherwise it'd be recommended you read
on below.
This commit focuses on the CLI framework itself and backports some
foundational changes to its DSL and how it resolves command line
arguments to CLIs, validates input, displays documentation, and persists
state across sessions -- and more. This is done in preparation for the
final stretch towarding completing the CLI rewrite (see #4273).
This is also an effort to generalize Doom's CLI (both its framework and
bin/doom), to increase it versatility and make it a viable dev tool for
other Doom projects (on our Github org) and beyond.
However, there is a *lot* to cover so I'll try to be brief:
- Refactor: generalize Doom's CLI framework by moving all bin/doom
specific configuration/commands out of core-cli into bin/doom. This
makes it easier to use bin/doom as a project-agnostic development
tool (or for users to write their own).
- Refactor: change the namespace for CLI variables/functions from
doom-cli-X to doom-X.
- Fix: subcommands being mistaken as arguments. "doom make index" will
resolve to (defcli! (doom make index)) if it exists,
otherwise (defcli! (doom make)) with "index" as an argument. Before
this, it would resolve to the latter no matter what. &rest can
override this; with (defcli! (doom make) (&rest args)), (defcli! (doom
make index)) will never be invoked.
- Refactor!: redesign our output library (was core/autoload/output.el,
is now core/autoload/print.el), and how our CLI framework buffers and
logs output, and now merges logs across (exit! ...) restarts.
- Feat: add support for :before and :after pseudo commands. E.g.
(defcli! (:before doom help) () ...)
(defcli! (:after doom sync) () ...)
Caveat: unlike advice, only one of each can be defined per-command.
- Feat: option arguments now have rudimentary type validation (see
`doom-cli-option-arg-types`). E.g.
(defcli! (doom foo) ((foo ("--foo" num))) ...)
If NUM is not a numeric, it will throw a validation error.
Any type that isn't in `doom-cli-option-arg-types` will be treated as a
wildcard string type. `num` can also be replaced with a specification,
e.g. "HOST[:PORT]", and can be formatted by using symbol quotes:
"`HOST'[:`PORT']".
- Feat: it is no longer required that options *immediately* follow the command
that defines them (but it must be somewhere after it, not before). E.g.
With:
(defcli! (:before doom foo) ((foo ("--foo"))) ...)
(defcli! (doom foo baz) () ...)
Before:
FAIL: doom --foo foo baz
GOOD: doom foo --foo baz
FAIL: doom foo baz --foo
After:
FAIL: doom --foo foo baz
GOOD: doom foo --foo baz
GOOD: doom foo baz --foo
- Refactor: CLI session state is now kept in a doom-cli-context struct (which
can be bound to a CLI-local variable with &context in the arglist):
(defcli! (doom sync) (&context context)
(print! "Command: " (doom-cli-context-command context)))
These contexts are persisted across sessions (when restarted). This is
necessary to support seamless script restarting (i.e. execve
emulation) in post-3.0.
- Feat: Doom's CLI framework now understands "--". Everything after it will be
treated as regular arguments, instead of sub-commands or options.
- Refactor!: the semantics of &rest for CLIs has changed. It used to be "all
extra literal, non-option arguments". It now means *all* unprocessed
arguments, and its use will suppress "unrecognized option" errors, and
tells the framework not to process any further subcommands. Use &args
if you just want "all literal arguments following this command".
- Feat: add new auxiliary keywords for CLI arglists: &context, &multiple,
&flags, &args, &stdin, &whole, and &cli.
- &context SYM: binds the currently running context to SYM (a
`doom-cli-context` struct). Helpful for introspection or passing
along state when calling subcommands by hand (with `call!`).
- &stdin SYM: SYM will be bound to a string containing any input piped
into the running script, or nil if none. Use
`doom-cli-context-pipe-p` to detect whether the script has been
piped into or out of.
- &multiple OPTIONS...: allows all following OPTIONS to be repeated. E.g. "foo
-x a -x b -x c" will pass (list ("-x" . "a") ("-x" . "b") ("-x" .
"c")) as -x's value.
- &flags OPTIONS...: All options after "&flags" get an implicit --no-* switch
and cannot accept arguments. Will be set to :yes or :no depending on which flag is
provided, and nil if the flag isn't provided. Otherwise, a default
value can be specified in that options' arglist. E.g.
(defcli! (doom foo) (&flags (foo ("--foo" :no))) ...)
When called, this command sets FOO to :yes if --foo, :no if --no-foo, and
defaults to :no otherwise.
- &args SYM: this replaces what &rest used to be; it binds to SYM a
list of all unprocessed (non-option) arguments.
- &rest SYM: now binds SYM to a list of all unprocessed arguments, including
options. This also suppresses "unrecognized option" errors, but will render
any sub-commands inaccessible. E.g.
(defcli! (doom make) (&rest rest) ...)
;; These are now inaccessible!
(defcli! (doom make foo) (&rest rest) ...)
(defcli! (doom make bar) (&rest rest) ...)
- &cli SYM: binds SYM to the currently running `doom-cli` struct. Can also be
obtained via `(doom-cli-get (doom-cli-context-command context))`. Possibly
useful for introspection.
- feat: add defobsolete! macro for quickly defining obsolete commands.
- feat: add defalias! macro for quickly defining alias commands.
- feat: add defautoload! macro for defining an autoloaded command (won't
be loaded until it is called for).
- refactor!: rename defcligroup! to defgroup! for consistency.
- fix: CLIs will now recursively inherit plist properties from parent
defcli-group!'s (but will stack :prefix).
- refactor!: remove obsolete 'doom update':
- refactor!: further generalize 'doom ci'
- In an effort to generalize 'doom ci' (so other Doom--or
non-doom--projects can use it), all its subcommands have been
changed to operate on the current working directory's repo instead
of $EMACSDIR.
- Doom-specific CI configuration was moved to .github/ci.el.
- All 'doom ci' commands will now preload one of \$CURRENT_REPO_ROOT/ci.el or
\$DOOMDIR/ci.el before executing.
- refactor!: changed 'doom env'
- 'doom env {-c,--clear}' is now 'doom env {clear,c}'
- -r/--reject and -a/--allow may now be specified multiple times
- refactor!: rewrote CLI help framework and error handling to be more
sophisticated and detailed.
- feat: can now initiate $PAGER on output with (exit! :pager) (or use
:pager? to only invoke pager is output is longer than the terminal is
tall).
- refactor!: changed semantics+conventions for global bin/doom options
- Single-character global options are now uppercased, to distinguish them from
local options:
- -d (for debug mode) is now -D
- -y (to suppress prompts) is now -!
- -l (to load elisp) is now -L
- -h (short for --help) is now -?
- Replace --yes/-y switches with --force/-!
- -L/--load FILE: now silently ignores file errors.
- Add --strict-load FILE: does the same as -L/--load, but throws an error if
FILE does not exist/is unreadable.
- Add -E/--eval FORM: evaluates arbitrary lisp before commands are processed.
- -L/--load, --strict-load, and -E/--eval can now be used multiple times in
one command.
- Add --pager COMMAND to specify an explicit pager. Will also obey
$DOOMPAGER envvar. Does not obey $PAGER.
- Fix #3746: which was likely caused by the generated post-script overwriting
the old mid-execution. By salting the postscript filenames (with both an
overarching session ID and a step counter).
- Docs: document websites, environment variables, and exit codes in
'doom --help'
- Feat: add imenu support for def{cli,alias,obsolete}!
Ref: #4273
Fix: #3746
Fix: #3844
2022-06-18 19:16:06 +02:00
|
|
|
;;
|
|
|
|
|
;;; Code:
|
2022-09-25 16:42:26 +02:00
|
|
|
|
2024-09-01 13:08:17 -04:00
|
|
|
(unless noninteractive
|
|
|
|
|
(error "Don't load doom-cli in an interactive session!"))
|
|
|
|
|
|
|
|
|
|
;; PERF: Deferring the GC in non-interactive sessions isn't as important, but
|
|
|
|
|
;; still yields a notable benefit. Still, avoid setting it to high here, as
|
|
|
|
|
;; runaway memory usage is a real risk in longer sessions.
|
|
|
|
|
(setq gc-cons-threshold 134217728 ; 128mb
|
|
|
|
|
;; Backported from 29 (see emacs-mirror/emacs@73a384a98698)
|
|
|
|
|
gc-cons-percentage 1.0)
|
|
|
|
|
|
|
|
|
|
;; REVIEW: Remove these later. The endpoints should be responsibile for
|
|
|
|
|
;; ensuring they exist. For now, they exist to quell file errors.
|
|
|
|
|
(mapc (doom-rpartial #'make-directory 'parents)
|
|
|
|
|
(list doom-local-dir
|
|
|
|
|
doom-data-dir
|
|
|
|
|
doom-cache-dir
|
|
|
|
|
doom-state-dir))
|
|
|
|
|
|
|
|
|
|
;; HACK: bin/doom suppresses loading of site files so they can be loaded
|
|
|
|
|
;; manually, here. Why? To suppress the otherwise unavoidable output they
|
|
|
|
|
;; commonly produce (like deprecation notices, file-loaded messages, and
|
|
|
|
|
;; linter warnings). This output pollutes the output of doom's CLI (or
|
|
|
|
|
;; scripts derived from it) with potentially confusing or alarming -- but
|
|
|
|
|
;; always unimportant -- information to the user.
|
|
|
|
|
(quiet!
|
|
|
|
|
(require 'cl nil t) ; "Package cl is deprecated"
|
|
|
|
|
(unless site-run-file ; unset in doom.el
|
|
|
|
|
(when-let ((site-run-file (get 'site-run-file 'initial-value)))
|
|
|
|
|
(load site-run-file t inhibit-message))))
|
|
|
|
|
|
|
|
|
|
(setq-default
|
|
|
|
|
;; PERF: Don't generate superfluous files when writing temp buffers.
|
|
|
|
|
make-backup-files nil
|
|
|
|
|
;; COMPAT: Stop user configuration from interfering with package management.
|
|
|
|
|
enable-dir-local-variables nil
|
|
|
|
|
;; PERF: Reduce ambiguity, embrace specificity, enjoy predictability.
|
|
|
|
|
case-fold-search nil
|
|
|
|
|
;; UX: Don't clog the user's trash with our CLI refuse.
|
|
|
|
|
delete-by-moving-to-trash nil)
|
|
|
|
|
|
|
|
|
|
;; Load just the... bear necessities~
|
|
|
|
|
(require 'seq)
|
|
|
|
|
(require 'map)
|
|
|
|
|
|
|
|
|
|
;; Suppress any possible coding system prompts during CLI sessions.
|
|
|
|
|
(set-language-environment "UTF-8")
|
|
|
|
|
|
|
|
|
|
;; Load and set up our debugger first, so backtraces can be made more
|
|
|
|
|
;; presentable and logged to file.
|
|
|
|
|
(doom-require 'doom-lib 'debug)
|
|
|
|
|
(if init-file-debug (doom-debug-mode +1))
|
|
|
|
|
|
|
|
|
|
;; Then load the rest of Doom's libs eagerly, since autoloads may not be
|
|
|
|
|
;; generated/loaded yet.
|
|
|
|
|
(doom-require 'doom-lib 'process)
|
|
|
|
|
(doom-require 'doom-lib 'system)
|
|
|
|
|
(doom-require 'doom-lib 'git)
|
|
|
|
|
(doom-require 'doom-lib 'plist)
|
|
|
|
|
(doom-require 'doom-lib 'files)
|
|
|
|
|
(doom-require 'doom-lib 'print)
|
|
|
|
|
(doom-require 'doom-lib 'autoloads)
|
|
|
|
|
|
|
|
|
|
;; Ensure straight and core packages are ready to go for CLI commands.
|
|
|
|
|
(require 'doom-cli-lib)
|
|
|
|
|
;; Last minute initialization at the end of loading this file.
|
|
|
|
|
(with-eval-after-load 'doom-cli
|
|
|
|
|
(doom-run-hooks 'doom-before-init-hook))
|
2022-09-06 21:57:27 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
;;
|
2024-09-01 13:08:17 -04:00
|
|
|
;;; Predefined CLIs (:help, :version, and :dump)
|
|
|
|
|
|
|
|
|
|
(defvar doom-help-commands '("%p %c {-?,--help}")
|
|
|
|
|
"A list of help commands recognized for the running script.
|
|
|
|
|
|
|
|
|
|
Recognizes %p (for the prefix) and %c (for the active command).")
|
|
|
|
|
|
|
|
|
|
;; When __DOOMDUMP is set, doomscripts trigger this special handler.
|
|
|
|
|
(defcli! (:root :dump)
|
|
|
|
|
((pretty? ("--pretty") "Pretty print output")
|
|
|
|
|
&context context
|
|
|
|
|
&args commands)
|
|
|
|
|
"Dump metadata to stdout for other commands to read."
|
|
|
|
|
(let* ((prefix (doom-cli-context-prefix context))
|
|
|
|
|
(command (cons prefix commands)))
|
|
|
|
|
(funcall (if pretty? #'pp #'prin1)
|
|
|
|
|
(cond ((equal commands '("-")) (hash-table-values doom-cli--table))
|
|
|
|
|
(commands (doom-cli-find command))
|
|
|
|
|
((doom-cli-find (list prefix)))))
|
|
|
|
|
(terpri)
|
|
|
|
|
;; Kill manually so we don't save output to logs.
|
|
|
|
|
(let (kill-emacs) (kill-emacs 0))))
|
|
|
|
|
|
|
|
|
|
(defcli! (:root :help)
|
|
|
|
|
((localonly? ("-g" "--no-global") "Hide global options")
|
|
|
|
|
(manpage? ("--manpage") "Generate in manpage format")
|
|
|
|
|
(commands? ("--commands") "List all known commands")
|
|
|
|
|
&multiple
|
|
|
|
|
(sections ("--synopsis" "--subcommands" "--similar" "--envvars"
|
|
|
|
|
"--postamble")
|
|
|
|
|
"Show only the specified sections.")
|
|
|
|
|
&context context
|
|
|
|
|
&args command)
|
|
|
|
|
"Show documentation for a Doom CLI command.
|
|
|
|
|
|
|
|
|
|
OPTIONS:
|
|
|
|
|
--synopsis, --subcommands, --similar, --envvars, --postamble
|
2022-09-06 21:57:27 +02:00
|
|
|
TODO"
|
2024-09-01 13:08:17 -04:00
|
|
|
(doom-cli-load-all)
|
|
|
|
|
(when (doom-cli-context-error context)
|
|
|
|
|
(terpri))
|
|
|
|
|
(let* ((command (cons (doom-cli-context-prefix context) command))
|
|
|
|
|
(cli (doom-cli-get command t))
|
|
|
|
|
(rcli (doom-cli-get cli))
|
|
|
|
|
(fallbackcli (cl-loop with targets = (doom-cli--command-expand (butlast command) t)
|
|
|
|
|
for cmd in (cons command targets)
|
|
|
|
|
if (doom-cli-get cmd t)
|
|
|
|
|
return it)))
|
|
|
|
|
(cond (commands?
|
|
|
|
|
(let ((cli (or cli (doom-cli-get (doom-cli-context-prefix context)))))
|
|
|
|
|
(print! "Commands under '%s':\n%s"
|
|
|
|
|
(doom-cli-command-string cli)
|
|
|
|
|
(indent (doom-cli-help--render-commands
|
|
|
|
|
(or (doom-cli-subcommands cli)
|
|
|
|
|
(user-error "No commands found"))
|
|
|
|
|
:prefix (doom-cli-command cli)
|
|
|
|
|
:inline? t
|
|
|
|
|
:docs? t)))))
|
|
|
|
|
((null sections)
|
|
|
|
|
(if (null cli)
|
|
|
|
|
(signal 'doom-cli-command-not-found-error command)
|
|
|
|
|
(doom-cli-help--print cli context manpage? localonly?)
|
|
|
|
|
(exit! :pager?)))
|
|
|
|
|
((dolist (section sections)
|
|
|
|
|
(unless (equal section (car sections)) (terpri))
|
|
|
|
|
(pcase section
|
|
|
|
|
("--synopsis"
|
|
|
|
|
(print! "%s" (doom-cli-help--render-synopsis
|
|
|
|
|
(doom-cli-help--synopsis cli)
|
|
|
|
|
"Usage: ")))
|
|
|
|
|
("--subcommands"
|
|
|
|
|
(print! "%s\n%s" (bold "Available commands:")
|
|
|
|
|
(indent (doom-cli-help--render-commands
|
|
|
|
|
(doom-cli-subcommands rcli 1)
|
|
|
|
|
:prefix command
|
|
|
|
|
:grouped? t
|
|
|
|
|
:docs? t)
|
|
|
|
|
doom-print-indent-increment)))
|
|
|
|
|
("--similar"
|
|
|
|
|
(unless command
|
|
|
|
|
(user-error "No command specified"))
|
|
|
|
|
(let ((similar (doom-cli-help-similar-commands command 0.4)))
|
|
|
|
|
(print! "Similar commands:")
|
|
|
|
|
(if (not similar)
|
|
|
|
|
(print! (indent (warn "Can't find any!")))
|
|
|
|
|
(dolist (command (seq-take similar 10))
|
|
|
|
|
(print! (indent (item "(%d%%) %s"))
|
|
|
|
|
(* (car command) 100)
|
|
|
|
|
(doom-cli-command-string (cdr command)))))))
|
|
|
|
|
("--envvars"
|
|
|
|
|
(let* ((key "ENVIRONMENT VARIABLES")
|
|
|
|
|
(clis (if command (doom-cli-find command) (hash-table-values doom-cli--table)))
|
|
|
|
|
(clis (seq-remove #'doom-cli-alias clis))
|
|
|
|
|
(clis (seq-filter (fn! (cdr (assoc key (doom-cli-docs %)))) clis))
|
|
|
|
|
(clis (seq-group-by #'doom-cli-command clis)))
|
|
|
|
|
(print! "List of environment variables for %s:\n" command)
|
|
|
|
|
(if (null clis)
|
|
|
|
|
(print! (indent "None!"))
|
|
|
|
|
(dolist (group clis)
|
|
|
|
|
(print! (bold "%s%s:"
|
|
|
|
|
(doom-cli-command-string (car group))
|
|
|
|
|
(if (doom-cli-fn (doom-cli-get (car group)))
|
|
|
|
|
"" " *")))
|
|
|
|
|
(dolist (cli (cdr group))
|
|
|
|
|
(print! (indent "%s") (markup (cdr (assoc key (doom-cli-docs cli))))))))))
|
|
|
|
|
("--postamble"
|
|
|
|
|
(print! "See %s for documentation."
|
|
|
|
|
(join (cl-loop with spec =
|
|
|
|
|
`((?p . ,(doom-cli-context-prefix context))
|
|
|
|
|
(?c . ,(doom-cli-command-string (cdr (doom-cli-command (or cli fallbackcli))))))
|
|
|
|
|
for cmd in doom-help-commands
|
|
|
|
|
for formatted = (trim (format-spec cmd spec))
|
|
|
|
|
collect (replace-regexp-in-string
|
|
|
|
|
" +" " " (format "'%s'" formatted)))
|
|
|
|
|
" or ")))))))))
|
|
|
|
|
|
|
|
|
|
(defcli! (:root :version)
|
|
|
|
|
((simple? ("--simple"))
|
|
|
|
|
&context context)
|
|
|
|
|
"Show installed versions of Doom, Doom modules, and Emacs."
|
|
|
|
|
(doom/version)
|
|
|
|
|
(unless simple?
|
|
|
|
|
(terpri)
|
|
|
|
|
(with-temp-buffer
|
|
|
|
|
(insert-file-contents (doom-path doom-emacs-dir "LICENSE"))
|
|
|
|
|
(re-search-forward "^Copyright (c) ")
|
|
|
|
|
(print! "%s\n" (trim (thing-at-point 'line t)))
|
|
|
|
|
(print! (p "Doom Emacs uses the MIT license and is provided without warranty "
|
|
|
|
|
"of any kind. You may redistribute and modify copies if "
|
|
|
|
|
"given proper attribution. See the LICENSE file for details.")))))
|
refactor: introduce doom-context
Introduces a system to announce what execution contexts are active, so I
can react appropriately, emit more helpful logs/warnings in the case of
issues, and throw more meaningful errors.
* bin/doom: load module CLIs in the 'modules' context.
* lisp/cli/doctor.el: load package files in 'packages' context.
* lisp/doom-cli.el:
- (doom-before-init-hook, doom-after-init-hook): trigger hooks at the
correct time. This may increase startup load time, as the benchmark
now times more of the startup process.
- (doom-cli-execute, doom-cli-context-execute,
doom-cli-context-restore, doom-cli-context-parse,
doom-cli--output-benchmark-h, doom-cli-call, doom-cli--restart,
doom-cli-load, run!): remove redundant context prefix in debug logs,
it's now redundant with doom-context, which doom-log now prefixes
them with.
* lisp/doom-lib.el (doom-log): prefix doom-context to doom-log output,
unless it starts with :.
* lisp/doom-packages.el (package!, doom-packages--read): throw error if
not used in a packages.el file or in the context of our package
manager.
* lisp/doom-profiles.el (doom-profile--generate-init-vars,
doom-profile--generate-load-modules): use modules doom-context instead
of doom-init-time to detect startup.
* lisp/doom-start.el (doom-load-packages-incrementally-h): move function
closer to end of doom-after-init-hook.
* lisp/doom.el:
- (doom-before-init-hook, doom--set-initial-values-h,
doom--begin-init-h): rename doom--set-initial-values-h to
doom--begin-init-h and ensure it runs as late in
doom-before-init-hook as possible, as that is the point where Doom's
"initialization" formally begins.
- (doom-after-init-hook): don't trigger at the end of command-line-1
in non-interactive sessions. This will be triggered manually in
doom-cli.el's run!.
* lisp/lib/config.el (doom/reload, doom/reload-autoloads,
doom/reload-env): use 'reload' context for reload commands.
* modules/lang/emacs-lisp/autoload.el (+emacs-lisp-eval): use 'eval'
context.
* modules/lang/org/config.el: remove doom-reloading-p; check for
'reload' doom context instead.
2022-09-24 12:38:25 +02:00
|
|
|
|
2022-07-30 21:49:00 +02:00
|
|
|
(provide 'doom-cli)
|
|
|
|
|
;;; doom-cli.el ends here
|