feat: new option grip-command

add grip-command: auto, grip, go-grip or mdopn.
delete grip-binary-path, grip-mdopen-path, grip-gogrip-path.
delete grip-use-mdopen and grip-use-gogrip.

Author: seagle0128

README.md

@@ -23,7 +23,7 @@
 <!-- markdown-toc end -->
 
 Instant Github-flavored Markdown/Org preview using [Grip](https://github.com/joeyespo/grip)
-(GitHub Readme Instant Preview) or [mdopen](https://github.com/immanelg/mdopen) or [go-grip](https://github.com/chrishrb/go-grip).
+(GitHub Readme Instant Preview), [mdopen](https://github.com/immanelg/mdopen) or [go-grip](https://github.com/chrishrb/go-grip).
 
 ## Prerequisite
 
@@ -55,14 +55,14 @@ From melpa, `M-x package-install RET grip-mode RET`.
 ;; Use keybindings
 (use-package grip-mode
   :ensure t
-  :config (setq grip-use-mdopen t) ;; to use `mdopen` instead of `grip`
+  :config (setq grip-command 'auto) ;; auto, grip, go-grip or mdopen
   :bind (:map markdown-mode-command-map
          ("g" . grip-mode)))
 
 ;; Or using hooks
 (use-package grip-mode
   :ensure t
-  :config (setq grip-use-gogrip t) ;; to use `go-grip` instead of `grip`
+  :config (setq grip-command 'go-grip) ;; auto, grip, go-grip or mdopen
   :hook ((markdown-mode org-mode) . grip-mode))
 ```
 
@@ -84,11 +84,12 @@ Enjoy! :smile:
 Run `M-x customize-group RET grip RET` or set the variables.
 
 ```emacs-lisp
-;; Path to the grip binary
-(setq grip-binary-path "/path/to/grip")
+;; Command: auto, grip, go-grip or mdopen
+(setq grip-command 'auto)
 
 ;; Use embedded webkit to preview
 ;; This requires GNU/Emacs version >= 26 and built with the `--with-xwidgets` option.
+;; mdopen doesn't support webkit preview.
 (setq grip-preview-use-webkit t)
 
 ;; You can use this variable to define another browser
@@ -101,21 +102,25 @@ Run `M-x customize-group RET grip RET` or set the variables.
 (setq grip-url-args '("arg1" "arg2" "etc"))
 
 ;; A base URL to another GitHub API.
+;; Only available for `grip'.
 (setq grip-github-api-url "")
 
 ;; A GitHub username for API authentication
+;; Only available for `grip'.
 (setq grip-github-user "")
 
 ;; A GitHub password or auth token for API auth
+;; Only available for `grip'.
 (setq grip-github-password "")
 
+;; Preview hostname
+;; Only available for `grip'.
+(setq grip-preview-host "localhost")
+
 ;; When nil, update the preview after file saves only, instead of also
 ;; after every text change
 (setq grip-update-after-change nil)
 
-;; Preview hostname
-(setq grip-preview-host "localhost")
-
 ;; Sleep seconds to ensure the server starts
 (setq grip-sleep-time 2)
 ```

grip-mode.el

@@ -51,44 +51,28 @@
   :group 'markdown
   :link '(url-link :tag "Homepage" "https://github.com/seagle0128/grip-mode"))
 
-(defcustom grip-binary-path "grip"
-  "Path to the grip binary."
-  :type 'file
-  :group 'grip)
-
-(defcustom grip-mdopen-path "mdopen"
-  "Path to the mdopen binary."
-  :type 'file
-  :group 'grip)
-
-(defcustom grip-use-mdopen nil
-  "Use mdopen instead of grip if non-nil."
-  :type 'boolean
-  :group 'grip)
-
-(defcustom grip-use-gogrip nil
-  "Use go-grip instead of grip if non-nil."
-  :type 'boolean
-  :group 'grip)
-
-(defcustom grip-gogrip-path "go-grip"
-  "Path to the go-grip binary."
-  :type 'file
+(defcustom grip-command 'auto
+  "The command of grip."
+  :type '(choice
+          (const :tag "Automatic" auto)
+          (const :tag "Grip" grip)
+          (const :tag "Go-grip" go-grip)
+          (const :tag "Mdopen" mdopen))
   :group 'grip)
 
-(defcustom grip-gogrip-theme "auto"
+(defcustom grip-gogrip-theme 'auto
   "Theme choice for go-grip."
   :type '(choice
-          (const :tag "Automatic" "auto")
-          (const :tag "Dark" "dark")
-          (const :tag "Light" "light"))
+          (const :tag "Automatic" auto)
+          (const :tag "Dark" dark)
+          (const :tag "Light" light))
   :group 'grip)
 
 (defcustom grip-preview-use-webkit t
   "Use embedded webkit to preview.
 
 This requires Emacs GUI version >= 26 and built with the `--with-xwidgets`
-option."
+option. mdopen doesn't support webkit preview."
   :type 'boolean
   :group 'grip)
 
@@ -103,17 +87,26 @@ Use default browser if nil. It respects `grip-preview-use-webkit'."
   :type '(repeat (string :tag "Argument")))
 
 (defcustom grip-github-api-url ""
-  "A base URL to another GitHub API."
+  "A base URL to another GitHub API.
+Only available for `grip'."
   :type 'string
   :group 'grip)
 
 (defcustom grip-github-user ""
-  "A GitHub username for API authentication."
+  "A GitHub username for API authentication.
+Only available for `grip'."
   :type 'string
   :group 'grip)
 
 (defcustom grip-github-password ""
-  "A GitHub password or auth token for API auth."
+  "A GitHub password or auth token for API auth.
+Only available for `grip'."
+  :type 'string
+  :group 'grip)
+
+(defcustom grip-preview-host "localhost"
+  "Preview hostname.
+Only available for `grip'."
   :type 'string
   :group 'grip)
 
@@ -124,11 +117,6 @@ When nil, only update the preview on file save."
   :type 'boolean
   :group 'grip)
 
-(defcustom grip-preview-host "localhost"
-  "Preview hostname."
-  :type 'string
-  :group 'grip)
-
 (defcustom grip-sleep-time 2
   "Sleep seconds to ensure the server starts successfully."
   :type 'integer
@@ -182,67 +170,79 @@ Use default browser unless `xwidget' is available."
               (file-name-nondirectory grip--preview-file))
     (format "http://%s:%d" grip-preview-host grip--port)))
 
+(defvar grip--command nil)
 (defun grip-start-process ()
-  "Render and preview with grip or mdopen."
+  "Render and preview."
   (unless (processp grip--process)
-    (cond (grip-use-mdopen
-           (progn
-             (unless (and grip-mdopen-path (executable-find grip-mdopen-path))
-               (grip-mode -1)                    ; Force to disable
-               (user-error "The `mdopen' is not available in PATH environment"))
-             (when grip--preview-file
-               (setq grip--process
-                     (start-process "mdopen" "*mdopen*"
-                                    grip-mdopen-path
-                                    grip--preview-file))
-               (message "Preview `%s' on %s" buffer-file-name (grip--preview-url)))))
-          (grip-use-gogrip
-           (progn
-             (unless (and grip-gogrip-path (executable-find grip-gogrip-path))
-               (grip-mode -1)                    ; Force to disable
-               (user-error "The `go-grip' is not available in PATH environment"))
-             ;; Generate random port
-             (while (< grip--port 6419)
-               (setq grip--port (random 65535)))
-             ;; Start a new grip process
-             (when grip--preview-file
-               (setq grip--process
-                     (start-process (format "grip-%d" grip--port)
-                                    (format " *grip-%d*" grip--port)
-                                    grip-gogrip-path
-                                    (format "--port=%d" grip--port)
-                                    (format "--theme=%s" grip-gogrip-theme)
-                                    "--browser=false"
-                                    grip--preview-file))
-               (message "Preview `%s' on %s" buffer-file-name (grip--preview-url))
-               (sleep-for grip-sleep-time)
-               (grip--browse-url (grip--preview-url)))))
-          (t
-           (progn
-             (unless (and grip-binary-path (executable-find grip-binary-path))
-               (grip-mode -1)                    ; Force to disable
-               (user-error "The `grip' is not available in PATH environment"))
-             ;; Generate random port
-             (while (< grip--port 6419)
-               (setq grip--port (random 65535)))
-             ;; Start a new grip process
-             (when grip--preview-file
-               (setq grip--process
-                     (start-process (format "grip-%d" grip--port)
-                                    (format " *grip-%d*" grip--port)
-                                    grip-binary-path
-                                    (format "--api-url=%s" grip-github-api-url)
-                                    (format "--user=%s" grip-github-user)
-                                    (format "--pass=%s" grip-github-password)
-                                    (format "--title=%s - Grip" (buffer-name))
-                                    grip--preview-file
-                                    (number-to-string grip--port)))
-               (message "Preview `%s' on %s" buffer-file-name (grip--preview-url))
-               (sleep-for grip-sleep-time)
-               (grip--browse-url (grip--preview-url))))))))
+    (setq grip--command grip-command)
+    (when (eq grip--command 'auto)
+      (setq grip--command
+            (cond
+             ((executable-find "go-grip") 'go-grip)
+             ((executable-find "mdopen") 'mdopen)
+             ((executable-find "grip") 'grip)
+             (t (user-error "No grip comamnd is available in PATH environment")))))
+
+    (pcase grip--command
+      ('mdopen
+       (progn
+         (unless (executable-find "mdopen")
+           (grip-mode -1)                    ; Force to disable
+           (user-error "The `mdopen' is not available in PATH environment"))
+         (when grip--preview-file
+           (setq grip--process
+                 (start-process "grip" "*grip*" "mdopen" grip--preview-file))
+           (message "Preview `%s' on %s" buffer-file-name (grip--preview-url)))))
+      ('go-grip
+       (progn
+         (unless (executable-find "go-grip")
+           (grip-mode -1)                    ; Force to disable
+           (user-error "The `go-grip' is not available in PATH environment"))
+         ;; Generate random port
+         (while (< grip--port 6419)
+           (setq grip--port (random 65535)))
+         ;; Start a new grip process
+         (when grip--preview-file
+           (setq grip--process
+                 (start-process (format "grip-%d" grip--port)
+                                (format " *grip-%d*" grip--port)
+                                "go-grip"
+                                (format "--port=%d" grip--port)
+                                (format "--theme=%s" grip-gogrip-theme)
+                                "--browser=false"
+                                grip--preview-file))
+           (message "Preview `%s' on %s" buffer-file-name (grip--preview-url))
+           (grip--browse-url (format "%s/%s"
+                                     (grip--preview-url)
+                                     (file-name-nondirectory grip--preview-file))))))
+      ('grip
+       (progn
+         (unless (executable-find "grip")
+           (grip-mode -1)                    ; Force to disable
+           (user-error "The `grip' is not available in PATH environment"))
+         ;; Generate random port
+         (while (< grip--port 6419)
+           (setq grip--port (random 65535)))
+         ;; Start a new grip process
+         (when grip--preview-file
+           (setq grip--process
+                 (start-process (format "grip-%d" grip--port)
+                                (format " *grip-%d*" grip--port)
+                                "grip"
+                                (format "--api-url=%s" grip-github-api-url)
+                                (format "--user=%s" grip-github-user)
+                                (format "--pass=%s" grip-github-password)
+                                (format "--title=%s - Grip" (buffer-name))
+                                grip--preview-file
+                                (number-to-string grip--port)))
+           (message "Preview `%s' on %s" buffer-file-name (grip--preview-url))
+           (sleep-for grip-sleep-time)
+           (grip--browse-url (grip--preview-url)))))
+      (_
+       (user-error "No grip comamnd is available in PATH environment")))))
 
 (defun grip--kill-process ()
-  "Kill grip or mdopen or go-grip process."
+  "Kill the preview process."
   (when grip--process
     ;; Delete xwidget buffer
     (when (and grip-preview-use-webkit