Merge pull request #217 from Aankhen/add-clippy-command

Add `rust-run-clippy' and `rust-buffer-project' with testing paraphernalia

Author: tromey

rust-mode-tests.el

@@ -2650,6 +2650,13 @@ extern \"rust-intrinsic\" fn five() {
       "four"
       "five"))))
 
+(when (executable-find rust-cargo-bin)
+  (ert-deftest rust-test-project-located ()
+    (lexical-let* ((test-dir (expand-file-name "test-project" default-directory))
+                   (manifest-file (expand-file-name "Cargo.toml" test-dir)))
+      (let ((default-directory test-dir))
+        (should (equal (expand-file-name (rust-buffer-project)) manifest-file))))))
+
 ;; If electric-pair-mode is available, load it and run the tests that use it.  If not,
 ;; no error--the tests will be skipped.
 (require 'elec-pair nil t)

rust-mode.el

@@ -18,9 +18,14 @@
                    (require 'compile)
                    (require 'url-vars))
 
+(require 'json)
+
 (defvar electric-pair-inhibit-predicate)
 (defvar electric-indent-chars)
 
+(defvar rust-buffer-project)
+(make-variable-buffer-local 'rust-buffer-project)
+
 ;; for GNU Emacs < 24.3
 (eval-when-compile
   (unless (fboundp 'setq-local)
@@ -144,6 +149,17 @@ function or trait.  When nil, where will be aligned with fn or trait."
   :type 'string
   :group 'rust-mode)
 
+(defcustom rust-cargo-bin "cargo"
+  "Path to cargo executable."
+  :type 'string
+  :group 'rust-mode)
+
+(defcustom rust-always-locate-project-on-open nil
+  "Whether to run `cargo locate-project' every time `rust-mode'
+  is activated."
+  :type 'boolean
+  :group 'rust-mode)
+
 (defface rust-unsafe-face
   '((t :inherit font-lock-warning-face))
   "Face for the `unsafe' keyword."
@@ -1411,7 +1427,12 @@ This is written mainly to be used as `end-of-defun-function' for Rust."
 
   (setq-local compile-command "cargo build")
 
-  (add-hook 'before-save-hook 'rust--before-save-hook nil t))
+  (add-hook 'before-save-hook 'rust--before-save-hook nil t)
+
+  (setq-local rust-buffer-project nil)
+
+  (when rust-always-locate-project-on-open
+    (rust-update-buffer-project)))
 
 ;;;###autoload
 (add-to-list 'auto-mode-alist '("\\.rs\\'" . rust-mode))
@@ -1548,6 +1569,30 @@ visit the new file."
           (rename-file filename new-name 1)
           (set-visited-file-name new-name))))))
 
+(defun rust-run-clippy ()
+  "Run `cargo clippy'."
+  (interactive)
+  (when (null rust-buffer-project)
+    (rust-update-buffer-project))
+  (let* ((args (list rust-cargo-bin "clippy" (concat "--manifest-path=" rust-buffer-project)))
+         ;; set `compile-command' temporarily so `compile' doesn't
+         ;; clobber the existing value
+         (compile-command (mapconcat #'shell-quote-argument args " ")))
+    (compile compile-command)))
+
+(defun rust-update-buffer-project ()
+  (setq-local rust-buffer-project (rust-buffer-project)))
+
+(defun rust-buffer-project ()
+  "Get project root if possible."
+  (with-temp-buffer
+    (let ((ret (call-process rust-cargo-bin nil t nil "locate-project")))
+      (when (/= ret 0)
+        (error "`cargo locate-project' returned %s status: %s" ret (buffer-string)))
+      (goto-char 0)
+      (let ((output (json-read)))
+        (cdr (assoc-string "root" output))))))
+
 (provide 'rust-mode)
 
 ;;; rust-mode.el ends here

test-project/Cargo.toml

@@ -0,0 +1 @@
+# Dummy file needed for test