Skip to content

Commit aeec153

Browse files
committed
Update CONTRIBUTING.md to use RustRover instead of IntelliJ Rust
JetBrains has transitioned from the IntelliJ Rust plugin to RustRover as their dedicated Rust IDE. This updates the documentation to reflect this change while maintaining backward compatibility with the existing cargo dev setup intellij command. Changes: - Replace IntelliJ Rust references with RustRover in CONTRIBUTING.md - Update links to point to official RustRover homepage - Update development guide in book/src/development/basics.md - Keep existing command names for backward compatibility
1 parent 7a17931 commit aeec153

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ All contributors are expected to follow the [Rust Code of Conduct].
1717
- [High level approach](#high-level-approach)
1818
- [Finding something to fix/improve](#finding-something-to-fiximprove)
1919
- [Getting code-completion for rustc internals to work](#getting-code-completion-for-rustc-internals-to-work)
20-
- [IntelliJ Rust](#intellij-rust)
20+
- [RustRover](#rustrover)
2121
- [Rust Analyzer](#rust-analyzer)
2222
- [How Clippy works](#how-clippy-works)
2323
- [Issue and PR triage](#issue-and-pr-triage)
@@ -92,22 +92,22 @@ an AST expression).
9292

9393
## Getting code-completion for rustc internals to work
9494

95-
### IntelliJ Rust
96-
Unfortunately, [`IntelliJ Rust`][IntelliJ_rust_homepage] does not (yet?) understand how Clippy uses compiler-internals
95+
### RustRover
96+
Unfortunately, [`RustRover`][RustRover_homepage] does not (yet?) understand how Clippy uses compiler-internals
9797
using `extern crate` and it also needs to be able to read the source files of the rustc-compiler which are not
9898
available via a `rustup` component at the time of writing.
9999
To work around this, you need to have a copy of the [rustc-repo][rustc_repo] available which can be obtained via
100100
`git clone https://github.com/rust-lang/rust/`.
101101
Then you can run a `cargo dev` command to automatically make Clippy use the rustc-repo via path-dependencies
102-
which `IntelliJ Rust` will be able to understand.
102+
which `RustRover` will be able to understand.
103103
Run `cargo dev setup intellij --repo-path <repo-path>` where `<repo-path>` is a path to the rustc repo
104104
you just cloned.
105105
The command will add path-dependencies pointing towards rustc-crates inside the rustc repo to
106-
Clippy's `Cargo.toml`s and should allow `IntelliJ Rust` to understand most of the types that Clippy uses.
106+
Clippy's `Cargo.toml`s and should allow `RustRover` to understand most of the types that Clippy uses.
107107
Just make sure to remove the dependencies again before finally making a pull request!
108108

109109
[rustc_repo]: https://github.com/rust-lang/rust/
110-
[IntelliJ_rust_homepage]: https://intellij-rust.github.io/
110+
[RustRover_homepage]: https://www.jetbrains.com/rust/
111111

112112
### Rust Analyzer
113113
For [`rust-analyzer`][ra_homepage] to work correctly make sure that in the `rust-analyzer` configuration you set

book/src/development/basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,15 @@ cargo dev new_lint
9595
cargo dev deprecate
9696
# automatically formatting all code before each commit
9797
cargo dev setup git-hook
98-
# (experimental) Setup Clippy to work with IntelliJ-Rust
98+
# (experimental) Setup Clippy to work with RustRover
9999
cargo dev setup intellij
100100
# runs the `dogfood` tests
101101
cargo dev dogfood
102102
```
103103

104104
More about [intellij] command usage and reasons.
105105

106-
[intellij]: https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md#intellij-rust
106+
[intellij]: https://github.com/rust-lang/rust-clippy/blob/master/CONTRIBUTING.md#rustrover
107107

108108
## lintcheck
109109

0 commit comments

Comments
 (0)