Add exit-code param to eask-help

Author: joshbax189

lisp/_prepare.el

@@ -1860,18 +1860,33 @@ Arguments FNC and ARGS are used for advice `:around'."
     (eask-msg (ansi-white (buffer-string)))
     (eask-msg (concat "''" (spaces-string max-column) "''"))))
 
-(defun eask-help (command)
-  "Show COMMAND's help instruction."
+(defun eask-help (command &optional print-or-exit-code)
+  "Show COMMAND's help instruction.
+
+When the optional variable PRINT-OR-EXIT-CODE is a number, it will exit with
+that code.  Set to non-nil would just print the help message without sending
+the exit code.  The default value `nil' will be replaced by `1'; therefore
+would send exit code of `1'."
   (let* ((command (eask-2str command))  ; convert to string
-         (help-file (concat eask-lisp-root "help/" command)))
+         (help-file (concat eask-lisp-root "help/" command))
+         ;; The default exit code is `1' since `eask-help' prints the help
+         ;; message on user error 99% of the time.
+         ;;
+         ;; TODO: Later replace exit code `1' with readable symbol after
+         ;; the exit code has specified.
+         (print-or-exit-code (or print-or-exit-code 1)))
     (if (file-exists-p help-file)
         (with-temp-buffer
           (insert-file-contents help-file)
           (unless (string-empty-p (buffer-string))
             (let ((buf-str (eask--msg-displayable-kwds (buffer-string))))
               (erase-buffer)
               (insert buf-str))
-            (eask--help-display)))
+            (eask--help-display))
+          ;; Exit with code if needed
+          (cond ((numberp print-or-exit-code)
+                 (eask--exit print-or-exit-code))
+                (t )))  ; Don't exit with anything else.
       (eask-error "Help manual missing %s" help-file))))
 
 ;;

lisp/link/add.el

@@ -83,7 +83,7 @@
           (eask-link-add--create source)
           (when (and (zerop (length links))         ; if no link previously,
                      (= 1 (length (eask-link-list))))  ; and first link created!
-            (eask-help "link/add/success/pkg")))
+            (eask-help "link/add/success/pkg" t))) ;; don't error
          ((ignore-errors (file-exists-p pkg-eask))
           (eask-log "💡 Validating package through %s... done!" pkg-eask)
           (eask--save-load-eask-file pkg-eask
@@ -113,7 +113,7 @@
                 (eask-link-add--create source)
                 (when (and (zerop (length links))         ; if no link previously,
                            (= 1 (length (eask-link-list))))  ; and first link created!
-                  (eask-help "link/add/success/eask")))
+                  (eask-help "link/add/success/eask" t))) ;; don't error
             (eask-error "✗ Error loading Eask-file: %s" pkg-eask)))
          (t
           (eask-info "(Missing `%s-pkg.el` file in your source folder)" name)