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

fix(cli): ensure $EMACSDIR/lisp/cli is in $DOOMPATH

Browse source 
If $DOOMPATH is malformed or set to a value that does not contain a
valid path to Doom's CLI library in $EMACSDIR/lisp/cli (see #7608),
bin/doom no longer functions, emitting "a subcommand is required"
errors.

This change ensures that the CLI library is always the last (implicit)
element in doom-cli-load-path, and ensures $DOOMPATH is never written to
the user's envvar file (in case they try to use bin/doom from inside a
terminal within a Doom Emacs session), which should ensure users -- at
least -- never find themselves stranded without the Doom CLI.

Fix: #7608
Co-authored-by: bpizzi <bpizzi@users.noreply.github.com>
This commit is contained in:
Henrik Lissner 2024-02-07 15:24:08 -05:00
parent a2484538b4
commit 90dae25940
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
2 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

3
lisp/cli/env.el
View file

@ -33,7 +33,8 @@
"^SSH_\\(AUTH_SOCK\\|AGENT_PID\\)$" "^\\(SSH\\|GPG\\)_TTY$" "^SSH_\\(AUTH_SOCK\\|AGENT_PID\\)$" "^\\(SSH\\|GPG\\)_TTY$"
"^GPG_AGENT_INFO$" "^GPG_AGENT_INFO$"
;; Internal Doom envvars ;; Internal Doom envvars
"^DEBUG$" "^INSECURE$" "^\\(EMACS\\|DOOM\\)DIR$" "^DOOMPROFILE$" "^__") "^DEBUG$" "^INSECURE$" "^\\(EMACS\\|DOOM\\)DIR$"
"^DOOM\\(PATH\\|PROFILE\\)$" "^__")
"Environment variables to omit from envvar files. "Environment variables to omit from envvar files.
Each string is a regexp, matched against variable names to omit from Each string is a regexp, matched against variable names to omit from

11
lisp/doom-cli.el
View file

@ -92,15 +92,14 @@
:group 'doom) :group 'doom)
(defvar doom-cli-load-path (defvar doom-cli-load-path
(let ((paths (split-string (or (getenv "DOOMPATH") "") path-separator))) (append (when-let ((doompath (getenv "DOOMPATH")))
(if (member "" paths) (cl-loop for dir in (split-string doompath path-separator)
(cl-substitute (doom-path (dir!) "cli/") "" paths :test #'equal) collect (expand-file-name dir)))
paths)) (list (file-name-concat (dir!) "cli")))
"A list of paths to search for autoloaded Doom CLIs. "A list of paths to search for autoloaded Doom CLIs.
It is prefilled by the DOOMPATH envvar (a colon-separated list on Linux/macOS, It is prefilled by the DOOMPATH envvar (a colon-separated list on Linux/macOS,
semicolon otherwise). Empty entries in DOOMPATH are replaced with the semicolon otherwise).")
$EMACSDIR/cli/.")
;;; CLI definition variables ;;; CLI definition variables
(defvar doom-cli-argument-types (defvar doom-cli-argument-types