Merge pull request #1537 from chrunchyjesus/cargo-mode

lang/rust: add cargo package & keybinds
This commit is contained in:
Henrik Lissner 2019-07-05 18:01:44 +02:00 committed by GitHub
commit d39500f143
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 43 additions and 19 deletions

View file

@ -27,6 +27,7 @@ Add support to Rust language and cargo commands inside emacs.
** Plugins
+ [[https://github.com/rust-lang/rust-mode][Rust-mode]]
+ [[https://github.com/racer-rust/emacs-racer][Racer-mode]]
+ [[https://github.com/racer-rust/emacs-racer][Cargo-mode]]
** Hacks
{A list of internal modifications to included packages}
@ -39,18 +40,34 @@ To get started with Rust, you can either use =rustup= and install rust with:
Package manager is not recommended to install Nightly version of Rust what is
required for ~racer~ from [[https://github.com/racer-rust/racer#installation][version 2.1]] (more info in [[#Troubleshooting][Troubleshooting]])
Some commands require additional crates to be installed to work, e.g. ~cargo
add~.
#+BEGIN_SRC sh
rustup component add rustfmt
rustup component add cargo-check
rustup component add cargo-edit
#+END_SRC
* Features
This module also supports LSP, it requires installation of Rust Language Server
[[https://github.com/rust-lang/rls][~RLS~]]. To enable this you need to enable ~lsp~ in ~:tools~ section in ~init.el~ file.
Keybindings
| Binding | Description |
|---------------------+---------------|
| ~<localleader> b b~ | ~cargo build~ |
| ~<localleader> b c~ | ~cargo check~ |
| ~<localleader> b r~ | ~cargo run~ |
| ~<localleader> b t~ | ~cargo test~ |
| Binding | Description |
|---------------------+-----------------------------|
| ~<localleader> b a~ | ~cargo add~ |
| ~<localleader> b b~ | ~cargo build~ |
| ~<localleader> b B~ | ~cargo bench~ |
| ~<localleader> b c~ | ~cargo check~ |
| ~<localleader> b C~ | ~cargo clippy~ |
| ~<localleader> b d~ | ~cargo doc~ |
| ~<localleader> b r~ | ~cargo run~ |
| ~<localleader> b s~ | ~cargo search~ |
| ~<localleader> b u~ | ~cargo update~ |
| ~<localleader> t a~ | ~cargo test~ |
| ~<localleader> t f~ | ~run tests in current file~ |
| ~<localleader> t t~ | ~run current test~ |
* TODO Configuration
How to configure this module, including common problems and how to address them.

View file

@ -7,12 +7,6 @@
"Return t if this is a cargo project."
(locate-dominating-file buffer-file-name "Cargo.toml"))
;;;###autoload
(defun +rust-cargo-compile (command)
"TODO"
(let ((default-directory (+rust-cargo-project-p)))
(compile command)))
;;;###autoload
(defun +rust-racer-lookup-documentation (identifier)
"A `+lookup/documentation' handler for Rust + Racer."

View file

@ -7,13 +7,25 @@
(when (featurep! +lsp)
(add-hook 'rust-mode-hook #'lsp!))
(map! :map rust-mode-map
:localleader
:prefix "b"
:desc "cargo build" "b" (λ! (+rust-cargo-compile "cargo build --color always"))
:desc "cargo check" "c" (λ! (+rust-cargo-compile "cargo check --color always"))
:desc "cargo run" "r" (λ! (+rust-cargo-compile "cargo run --color always"))
:desc "cargo test" "t" (λ! (+rust-cargo-compile "cargo test --color always"))))
(def-package! cargo
:defer t
:init
(map! :map rust-mode-map
:localleader
(:prefix "b"
:desc "cargo add" "a" #'cargo-process-add
:desc "cargo build" "b" #'cargo-process-build
:desc "cargo bench" "B" #'cargo-process-bench
:desc "cargo check" "c" #'cargo-process-check
:desc "cargo clippy" "C" #'cargo-process-clippy
:desc "cargo doc" "d" #'cargo-process-doc
:desc "cargo run" "r" #'cargo-process-run
:desc "cargo search" "s" #'cargo-process-search
:desc "cargo update" "u" #'cargo-process-update)
(:prefix ("t" . "cargo test")
:desc "all" "a" #'cargo-process-test
:desc "current file" "f" #'cargo-process-current-file-tests
:desc "current test" "t" #'cargo-process-current-test))))
(def-package! racer

View file

@ -2,6 +2,7 @@
;;; lang/rust/packages.el
(package! rust-mode)
(package! cargo)
(when (featurep! :tools flycheck)
(package! flycheck-rust))