docs(cli): doom install: reformat output

Also simplifies the first-timer "things you should know" snippet after
running 'doom install'.
This commit is contained in:
Henrik Lissner 2024-09-04 14:47:19 -04:00
parent 52c91cc51c
commit 42df7cb9fd
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
3 changed files with 24 additions and 29 deletions

View file

@ -270,19 +270,18 @@ Note: warnings are not considered failures.")
hooks-path)) hooks-path))
(user-error "Aborted"))) (user-error "Aborted")))
(make-directory hooks-path 'parents) (make-directory hooks-path 'parents)
(print-group! (dolist (hook '("commit-msg" "pre-push"))
(dolist (hook '("commit-msg" "pre-push")) (let* ((hook (doom-path hooks-path hook))
(let* ((hook (doom-path hooks-path hook)) (overwrite-p (file-exists-p hook)))
(overwrite-p (file-exists-p hook))) (with-temp-file hook
(with-temp-file hook (insert "#!/usr/bin/env sh\n"
(insert "#!/usr/bin/env sh\n" (doom-path doom-emacs-dir "bin/doom")
(doom-path doom-emacs-dir "bin/doom") " --no-color ci hook " (file-name-base hook)
" --no-color ci hook " (file-name-base hook) " \"$@\""))
" \"$@\"")) (set-file-modes hook #o700)
(set-file-modes hook #o700) (print! (success "%s %s")
(print! (success "%s %s") (if overwrite-p "Overwrote" "Created")
(if overwrite-p "Overwrote" "Created") (path hook))))))
(path hook)))))))
;; TODO Move to 'doom lint commits' ;; TODO Move to 'doom lint commits'
(defcli! (ci lint-commits) (from &optional to) (defcli! (ci lint-commits) (from &optional to)

View file

@ -99,15 +99,15 @@ Change `$DOOMDIR' with the `--doomdir' option, e.g.
;; Install Doom packages ;; Install Doom packages
(if (eq install? :no) (if (eq install? :no)
(print! (warn "Not installing plugins, as requested")) (print! (warn "Not installing plugins, as requested"))
(print! "Installing plugins") (print! (start "Installing plugins"))
(doom-packages-ensure)) (print-group! (doom-packages-ensure)))
(print! "Regenerating autoloads files") (print! (start "Synchronizing default profile..."))
(doom-profile-generate) (print-group! (doom-profile-generate))
(if (eq hooks? :no) (if (eq hooks? :no)
(print! (warn "Not deploying commit-msg and pre-push git hooks, as requested")) (print! (warn "Not deploying commit-msg and pre-push git hooks, as requested"))
(print! "Deploying commit-msg and pre-push git hooks") (print! (start "Deploying commit-msg and pre-push git hooks"))
(print-group! (print-group!
(condition-case e (condition-case e
(call! `(ci deploy-hooks ,@(if yes? '("--force")))) (call! `(ci deploy-hooks ,@(if yes? '("--force"))))
@ -117,7 +117,7 @@ Change `$DOOMDIR' with the `--doomdir' option, e.g.
(when (file-exists-p "~/.emacs") (when (file-exists-p "~/.emacs")
(print! (warn "A ~/.emacs file was detected. This conflicts with Doom and should be deleted!"))) (print! (warn "A ~/.emacs file was detected. This conflicts with Doom and should be deleted!")))
(print! (success "\nFinished! Doom is ready to go!\n")) (print! (success "Finished! Doom is ready to go!\n"))
(with-temp-buffer (with-temp-buffer
(insert-file-contents (doom-path doom-emacs-dir "templates/QUICKSTART_INTRO")) (insert-file-contents (doom-path doom-emacs-dir "templates/QUICKSTART_INTRO"))
(print! "%s" (buffer-string))))) (print! "%s" (buffer-string)))))

View file

@ -1,19 +1,15 @@
But before you doom yourself, here are some things you should know: But before you doom yourself, here are some things you should know:
1. Don't forget to run 'doom sync', then restart Emacs, after modifying init.el 1. Don't forget to run 'doom sync' and restart Emacs after modifying init.el or
or packages.el in ~/.config/doom. packages.el in ~/.config/doom. This is never necessary for config.el.
This command ensures needed packages are installed, orphaned packages are 2. If something goes wrong, run `doom doctor` to diagnose common issues with
removed, and your autoloads/cache files are up to date. When in doubt, run your environment, setup, and config.
'doom sync'!
2. If something goes wrong, run `doom doctor`. It diagnoses common issues with
your environment and setup, and may offer clues about what is wrong.
3. Use 'doom upgrade' to update Doom. Doing it any other way will require 3. Use 'doom upgrade' to update Doom. Doing it any other way will require
additional steps. Run 'doom help upgrade' to understand those extra steps. additional steps (see 'doom help upgrade').
4. Access Doom's documentation from within Emacs via 'SPC h d h' or 'C-h d h' 4. Access Doom's documentation from within Emacs via 'SPC h d h' or 'C-h d h'
(or 'M-x doom/help') (or 'M-x doom/help').
Have fun! Have fun!