remove variables for elixir and mix paths

Trevoke · Trevoke · commit c42fcad4b451 · 2018-06-03T20:06:16.000-04:00
diff --git a/README.md b/README.md
@@ -151,41 +151,6 @@ You can use [web-mode.el](http://web-mode.org) to edit elixir templates (eex fil
 
 ## Elixir Format
 
-### Setup of elixir-format
-Customize the elixir and mix paths
-
-In Emacs, run following command to customize option
-``` elisp
-M-x customize-option
-
-Customize-variable: elixir-format-elixir-path
-```
-and set your elixir executable path there. After that run:
-``` elisp
-M-x customize-option
-
-Customize-variable: elixir-format-mix-path
-```
-and set your mix executable path there.
-
-Your machine's elixir and mix executable paths can be found with `which` command as shown below
-
-``` shell
-$ which elixir
-/usr/local/bin/elixir
-
-$ which mix
-/usr/local/bin/mix
-```
-Alternavively you can define variables as below
-
-``` elisp
-(setq elixir-format-elixir-path "/usr/local/bin/elixir")
-(setq elixir-format-mix-path "/usr/local/bin/mix")
-```
-
-### Use it
-
 ``` elisp
 M-x elixir-format
 ```
@@ -215,7 +180,8 @@ or you set `elixir-format-arguments` in a hook like this:
                                    (setq elixir-format-arguments nil))))
 ```
 
-In this example we use [Projectile](https://github.com/bbatsov/projectile) to get the project root and set `elixir-format-arguments` accordingly.
+In this example we use [Projectile](https://github.com/bbatsov/projectile) to determine if we are in a project and then set `elixir-format-arguments` accordingly.
+Please note that this code snippet may cause unhappiness if there is no `.formatter.exs` file available.
 
 
 ## History
diff --git a/elixir-format.el b/elixir-format.el
@@ -25,32 +25,6 @@
 
 (require 'ansi-color)
 
-(defcustom elixir-format-elixir-path ""
-  "Path to the Elixir executable. Usually it is /usr/local/bin/elixir. You can type `which elixir` in terminal to find out the elixir binary path in your system.
-
-Customize the elixir path
-
-In Emacs, run following command to customize option
-
-M-x customize-option
-
-Customize-variable: elixir-format-elixir-path"
-  :type 'string
-  :group 'elixir-format)
-
-(defcustom elixir-format-mix-path ""
-  "Path to the 'mix' executable. Usually it is /usr/local/bin/mix. You can type `which mix` in terminal to find out the mix binary path in your system
-
-Customize the mix path
-
-In Emacs, run following command to customize option
-
-M-x customize-option
-
-Customize-variable: elixir-format-mix-path"
-  :type 'string
-  :group 'elixir-format)
-
 (defcustom elixir-format-arguments nil
   "Additional arguments to 'mix format'"
   :type '(repeat string)
@@ -70,60 +44,62 @@ Customize-variable: elixir-format-mix-path"
 (defun elixir-format--outbuff ()
   (get-buffer-create "*elixir-format-output*"))
 
-(defun elixir-format--clean-output-buffers ()
-  (with-current-buffer (elixir-format--outbuff)
-    (erase-buffer))
+(defun elixir-format--elixir-executable ()
+  (executable-find "elixir"))
 
-  (with-current-buffer (elixir-format--errbuff)
-    (setq buffer-read-only nil)
-    (erase-buffer)))
+(defun elixir-format--mix-executable ()
+  (executable-find "mix"))
 
 ;;;###autoload
 (defun elixir-format (&optional called-interactively-p)
   (interactive "p")
-
-  (let ((tmpfile (make-temp-file "elixir-format" nil ".ex"))
-        (our-elixir-format-arguments (list elixir-format-mix-path "format"))
-        (output nil))
-
-    (if (elixir-format--elixir-and-mix-path-not-set-p)
-        (elixir-format--display-missing-configuration-error called-interactively-p)
-      (unwind-protect
-          (save-restriction
-            (elixir-format--clean-output-buffers)
-            (elixir-format--run-format called-interactively-p tmpfile))))))
-
-(defun elixir-format--elixir-and-mix-path-not-set-p ()
-  (or (= (length elixir-format-mix-path) 0)
-      (= (length elixir-format-elixir-path) 0)))
-
-(defun elixir-format--display-missing-configuration-error (called-interactively-p)
+  (if (not (elixir-format--elixir-and-mix-path-set-p))
+      (elixir-format--display-missing-executables-error called-interactively-p)
+    (unwind-protect
+        (save-restriction
+          (elixir-format--clean-output-buffers)
+          (elixir-format--run-format called-interactively-p)))))
+
+(defun elixir-format--elixir-and-mix-path-set-p ()
+  (and (elixir-format--elixir-executable)
+       (elixir-format--mix-executable)))
+
+(defun elixir-format--display-missing-executables-error (called-interactively-p)
   (with-current-buffer (elixir-format--errbuff)
     (setq buffer-read-only nil)
     (erase-buffer)
-    (insert "Elixir or mix binary path not set, please check the documentation for `elixir-format-elixir-path` and `elixir-format-mix-path` with `C-h v <VARNAME> RET` to set the variables appropriately")
+    (insert "Emacs is unable to find the executables for elixir and/or mix. Either they are not installed on your system or emacs' PATH is not as wide as it needs to be. The latter is most likely to happen on OSX, in which case the simplest answer may be to add the exec-path-from-shell package to your configuration.")
     (setq buffer-read-only t)
     (ansi-color-apply-on-region (point-min) (point-max))
     (special-mode)
     (if called-interactively-p
-        (display-buffer elixir-format--errbuff)
-      (error "elixir-format-configuration-missing: see %s" (buffer-name (elixir-format--errbuff))))))
+        (display-buffer (elixir-format--errbuff))
+      (error "Elixir Format error see %s" (elixir-format--errbuff)))))
+
+(defun elixir-format--clean-output-buffers ()
+  (with-current-buffer (elixir-format--outbuff)
+    (erase-buffer))
 
-(defun elixir-format--run-format (called-interactively-p tmpfile)
-  (write-region nil nil tmpfile)
+  (with-current-buffer (elixir-format--errbuff)
+    (setq buffer-read-only nil)
+    (erase-buffer)))
 
-  (run-hooks 'elixir-format-hook)
+(defun elixir-format--run-format (called-interactively-p)
+  (let ((tmpfile (make-temp-file "elixir-format" nil ".ex"))
+        (our-elixir-format-arguments (list (elixir-format--mix-executable) "format")))
 
-  (when elixir-format-arguments
-    (setq our-elixir-format-arguments (append our-elixir-format-arguments elixir-format-arguments)))
-  (setq our-elixir-format-arguments (append our-elixir-format-arguments (list tmpfile)))
+    (write-region nil nil tmpfile)
+    (run-hooks 'elixir-format-hook)
 
-  (if (zerop (apply #'call-process elixir-format-elixir-path nil (elixir-format--errbuff) nil our-elixir-format-arguments))
-      (elixir-format--call-format-command tmpfile)
-    (elixir-format--failed-to-format called-interactively-p))
+    (when elixir-format-arguments
+      (setq our-elixir-format-arguments (append our-elixir-format-arguments elixir-format-arguments)))
+    (setq our-elixir-format-arguments (append our-elixir-format-arguments (list tmpfile)))
 
-  (delete-file tmpfile)
-  (kill-buffer (elixir-format--outbuff)))
+    (if (zerop (apply #'call-process (elixir-format--elixir-executable) nil (elixir-format--errbuff) nil our-elixir-format-arguments))
+        (elixir-format--call-format-command tmpfile)
+      (elixir-format--failed-to-format called-interactively-p))
+    (delete-file tmpfile)
+    (kill-buffer (elixir-format--outbuff))))
 
 (defun elixir-format--call-format-command (tmpfile)
   (if (zerop (call-process-region (point-min) (point-max) "diff" nil (elixir-format--outbuff) nil "-n" "-" tmpfile))
@@ -142,38 +118,6 @@ Customize-variable: elixir-format-mix-path"
       (display-buffer (elixir-format--errbuff))
     (error "elixir-format failed: see %s" (buffer-name (elixir-format--errbuff)))))
 
-(defun elixir-format--goto-line (line)
-  (goto-char (point-min))
-  (forward-line (1- line)))
-
-(defun elixir-format--delete-whole-line (&optional arg)
-  "Delete the current line without putting it in the `kill-ring'.
-Derived from function `kill-whole-line'.  ARG is defined as for that
-function.
-
-Shamelessly stolen from go-mode (https://github.com/dominikh/go-mode.el)"
-  (setq arg (or arg 1))
-  (if (and (> arg 0)
-           (eobp)
-           (save-excursion (forward-visible-line 0) (eobp)))
-      (signal 'end-of-buffer nil))
-  (if (and (< arg 0)
-           (bobp)
-           (save-excursion (end-of-visible-line) (bobp)))
-      (signal 'beginning-of-buffer nil))
-  (cond ((zerop arg)
-         (delete-region (progn (forward-visible-line 0) (point))
-                        (progn (end-of-visible-line) (point))))
-        ((< arg 0)
-         (delete-region (progn (end-of-visible-line) (point))
-                        (progn (forward-visible-line (1+ arg))
-                               (unless (bobp)
-                                 (backward-char))
-                               (point))))
-        (t
-         (delete-region (progn (forward-visible-line 0) (point))
-                        (progn (forward-visible-line arg) (point))))))
-
 (defun elixir-format--apply-rcs-patch (patch-buffer)
   "Apply an RCS-formatted diff from PATCH-BUFFER to the current buffer.
 Shamelessly stolen from go-mode (https://github.com/dominikh/go-mode.el)"
@@ -218,6 +162,38 @@ Shamelessly stolen from go-mode (https://github.com/dominikh/go-mode.el)"
              (t
               (error "Invalid rcs patch or internal error in elixir-format--apply-rcs-patch")))))))))
 
+(defun elixir-format--goto-line (line)
+  (goto-char (point-min))
+  (forward-line (1- line)))
+
+(defun elixir-format--delete-whole-line (&optional arg)
+  "Delete the current line without putting it in the `kill-ring'.
+Derived from function `kill-whole-line'.  ARG is defined as for that
+function.
+
+Shamelessly stolen from go-mode (https://github.com/dominikh/go-mode.el)"
+  (setq arg (or arg 1))
+  (if (and (> arg 0)
+           (eobp)
+           (save-excursion (forward-visible-line 0) (eobp)))
+      (signal 'end-of-buffer nil))
+  (if (and (< arg 0)
+           (bobp)
+           (save-excursion (end-of-visible-line) (bobp)))
+      (signal 'beginning-of-buffer nil))
+  (cond ((zerop arg)
+         (delete-region (progn (forward-visible-line 0) (point))
+                        (progn (end-of-visible-line) (point))))
+        ((< arg 0)
+         (delete-region (progn (end-of-visible-line) (point))
+                        (progn (forward-visible-line (1+ arg))
+                               (unless (bobp)
+                                 (backward-char))
+                               (point))))
+        (t
+         (delete-region (progn (forward-visible-line 0) (point))
+                        (progn (forward-visible-line arg) (point))))))
+
 (provide 'elixir-format)
 
 ;;; elixir-format.el ends here
