Skip to content

Commit c6c0ac2

Browse files
committed
Auto merge of #12919 - jonas-schievink:speling, r=jonas-schievink
fix: Fix r-a spelling in some places User-facing change: All commands are now rendered as "rust-analyzer: Command" rather than "Rust Analyzer: Command". Alternative to #12910 Potentially controversial, since other extensions don't do this, so I won't self-approve.
2 parents 8e38833 + bd7dfac commit c6c0ac2

28 files changed

+64
-64
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Before submitting, please make sure that you're not running into one of these kn
1919
Otherwise please try to provide information which will help us to fix the issue faster. Minimal reproducible examples with few dependencies are especially lovely <3.
2020
-->
2121

22-
**rust-analyzer version**: (eg. output of "Rust Analyzer: Show RA Version" command)
22+
**rust-analyzer version**: (eg. output of "rust-analyzer: Show RA Version" command)
2323

2424
**rustc version**: (eg. output of `rustc -V`)
2525

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer
4343

4444
## License
4545

46-
Rust analyzer is primarily distributed under the terms of both the MIT
46+
rust-analyzer is primarily distributed under the terms of both the MIT
4747
license and the Apache License (Version 2.0).
4848

4949
See LICENSE-APACHE and LICENSE-MIT for details.

crates/hir-def/src/item_tree.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
//! unaffected, so we don't have to recompute name resolution results or item data (see `data.rs`).
1515
//!
1616
//! The `ItemTree` for the currently open file can be displayed by using the VS Code command
17-
//! "Rust Analyzer: Debug ItemTree".
17+
//! "rust-analyzer: Debug ItemTree".
1818
//!
1919
//! Compared to rustc's architecture, `ItemTree` has properties from both rustc's AST and HIR: many
2020
//! syntax-level Rust features are already desugared to simpler forms in the `ItemTree`, but name

crates/ide-db/src/apply_change.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ impl RootDatabase {
4545
// |===
4646
// | Editor | Action Name
4747
//
48-
// | VS Code | **Rust Analyzer: Memory Usage (Clears Database)**
48+
// | VS Code | **rust-analyzer: Memory Usage (Clears Database)**
4949
// |===
5050
// image::https://user-images.githubusercontent.com/48062697/113065592-08559f00-91b1-11eb-8c96-64b88068ec02.gif[]
5151
pub fn per_query_memory_usage(&mut self) -> Vec<(String, Bytes)> {

crates/ide-ssr/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
// |===
5858
// | Editor | Action Name
5959
//
60-
// | VS Code | **Rust Analyzer: Structural Search Replace**
60+
// | VS Code | **rust-analyzer: Structural Search Replace**
6161
// |===
6262
//
6363
// Also available as an assist, by writing a comment containing the structural

crates/ide/src/expand_macro.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ pub struct ExpandedMacro {
1919
// |===
2020
// | Editor | Action Name
2121
//
22-
// | VS Code | **Rust Analyzer: Expand macro recursively**
22+
// | VS Code | **rust-analyzer: Expand macro recursively**
2323
// |===
2424
//
2525
// image::https://user-images.githubusercontent.com/48062697/113020648-b3973180-917a-11eb-84a9-ecb921293dc5.gif[]
@@ -32,7 +32,7 @@ pub(crate) fn expand_macro(db: &RootDatabase, position: FilePosition) -> Option<
3232
_ => 0,
3333
})?;
3434

35-
// due to how Rust Analyzer works internally, we need to special case derive attributes,
35+
// due to how rust-analyzer works internally, we need to special case derive attributes,
3636
// otherwise they might not get found, e.g. here with the cursor at $0 `#[attr]` would expand:
3737
// ```
3838
// #[attr]

crates/ide/src/inlay_hints.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ pub enum InlayTooltip {
100100
// |===
101101
// | Editor | Action Name
102102
//
103-
// | VS Code | **Rust Analyzer: Toggle inlay hints*
103+
// | VS Code | **rust-analyzer: Toggle inlay hints*
104104
// |===
105105
//
106106
// image::https://user-images.githubusercontent.com/48062697/113020660-b5f98b80-917a-11eb-8d70-3be3fd558cdd.png[]

crates/ide/src/join_lines.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ pub struct JoinLinesConfig {
2828
// |===
2929
// | Editor | Action Name
3030
//
31-
// | VS Code | **Rust Analyzer: Join lines**
31+
// | VS Code | **rust-analyzer: Join lines**
3232
// |===
3333
//
3434
// image::https://user-images.githubusercontent.com/48062697/113020661-b6922200-917a-11eb-87c4-b75acc028f11.gif[]

crates/ide/src/matching_brace.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use syntax::{
1212
// |===
1313
// | Editor | Action Name
1414
//
15-
// | VS Code | **Rust Analyzer: Find matching brace**
15+
// | VS Code | **rust-analyzer: Find matching brace**
1616
// |===
1717
//
1818
// image::https://user-images.githubusercontent.com/48062697/113065573-04298180-91b1-11eb-8dec-d4e2a202f304.gif[]

crates/ide/src/move_item.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ pub enum Direction {
1919
// |===
2020
// | Editor | Action Name
2121
//
22-
// | VS Code | **Rust Analyzer: Move item up**
23-
// | VS Code | **Rust Analyzer: Move item down**
22+
// | VS Code | **rust-analyzer: Move item up**
23+
// | VS Code | **rust-analyzer: Move item down**
2424
// |===
2525
//
2626
// image::https://user-images.githubusercontent.com/48062697/113065576-04298180-91b1-11eb-91ce-4505e99ed598.gif[]

crates/ide/src/parent_module.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ use crate::NavigationTarget;
1818
// |===
1919
// | Editor | Action Name
2020
//
21-
// | VS Code | **Rust Analyzer: Locate parent module**
21+
// | VS Code | **rust-analyzer: Locate parent module**
2222
// |===
2323
//
2424
// image::https://user-images.githubusercontent.com/48062697/113065580-04c21800-91b1-11eb-9a32-00086161c0bd.gif[]

crates/ide/src/runnables.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ impl Runnable {
116116
// |===
117117
// | Editor | Action Name
118118
//
119-
// | VS Code | **Rust Analyzer: Run**
119+
// | VS Code | **rust-analyzer: Run**
120120
// |===
121121
// image::https://user-images.githubusercontent.com/48062697/113065583-055aae80-91b1-11eb-958f-d67efcaf6a2f.gif[]
122122
pub(crate) fn runnables(db: &RootDatabase, file_id: FileId) -> Vec<Runnable> {
@@ -202,7 +202,7 @@ pub(crate) fn runnables(db: &RootDatabase, file_id: FileId) -> Vec<Runnable> {
202202
// |===
203203
// | Editor | Action Name
204204
//
205-
// | VS Code | **Rust Analyzer: Peek related tests**
205+
// | VS Code | **rust-analyzer: Peek related tests**
206206
// |===
207207
pub(crate) fn related_tests(
208208
db: &RootDatabase,

crates/ide/src/shuffle_crate_graph.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use ide_db::{
1212
// |===
1313
// | Editor | Action Name
1414
//
15-
// | VS Code | **Rust Analyzer: Shuffle Crate Graph**
15+
// | VS Code | **rust-analyzer: Shuffle Crate Graph**
1616
// |===
1717
pub(crate) fn shuffle_crate_graph(db: &mut RootDatabase) {
1818
let crate_graph = db.crate_graph();

crates/ide/src/status.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ fn macro_syntax_tree_stats(db: &RootDatabase) -> SyntaxTreeStats {
2929
// |===
3030
// | Editor | Action Name
3131
//
32-
// | VS Code | **Rust Analyzer: Status**
32+
// | VS Code | **rust-analyzer: Status**
3333
// |===
3434
// image::https://user-images.githubusercontent.com/48062697/113065584-05f34500-91b1-11eb-98cc-5c196f76be7f.gif[]
3535
pub(crate) fn status(db: &RootDatabase, file_id: Option<FileId>) -> String {

crates/ide/src/syntax_tree.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use syntax::{
1212
// |===
1313
// | Editor | Action Name
1414
//
15-
// | VS Code | **Rust Analyzer: Show Syntax Tree**
15+
// | VS Code | **rust-analyzer: Show Syntax Tree**
1616
// |===
1717
// image::https://user-images.githubusercontent.com/48062697/113065586-068bdb80-91b1-11eb-9507-fee67f9f45a0.gif[]
1818
pub(crate) fn syntax_tree(

crates/ide/src/view_crate_graph.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ use ide_db::{
1616
// |===
1717
// | Editor | Action Name
1818
//
19-
// | VS Code | **Rust Analyzer: View Crate Graph**
19+
// | VS Code | **rust-analyzer: View Crate Graph**
2020
// |===
2121
pub(crate) fn view_crate_graph(db: &RootDatabase, full: bool) -> Result<String, String> {
2222
let crate_graph = db.crate_graph();

crates/ide/src/view_hir.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use syntax::{algo::find_node_at_offset, ast, AstNode};
88
// |===
99
// | Editor | Action Name
1010
//
11-
// | VS Code | **Rust Analyzer: View Hir**
11+
// | VS Code | **rust-analyzer: View Hir**
1212
// |===
1313
// image::https://user-images.githubusercontent.com/48062697/113065588-068bdb80-91b1-11eb-9a78-0b4ef1e972fb.gif[]
1414
pub(crate) fn view_hir(db: &RootDatabase, position: FilePosition) -> String {

crates/ide/src/view_item_tree.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use ide_db::RootDatabase;
99
// |===
1010
// | Editor | Action Name
1111
//
12-
// | VS Code | **Rust Analyzer: Debug ItemTree**
12+
// | VS Code | **rust-analyzer: Debug ItemTree**
1313
// |===
1414
pub(crate) fn view_item_tree(db: &RootDatabase, file_id: FileId) -> String {
1515
db.file_item_tree(file_id.into()).pretty_print()

crates/proc-macro-api/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ impl MacroDylib {
6060

6161
let info = version::read_dylib_info(&path)?;
6262
if info.version.0 < 1 || info.version.1 < 47 {
63-
let msg = format!("proc-macro {} built by {:#?} is not supported by Rust Analyzer, please update your rust version.", path.display(), info);
63+
let msg = format!("proc-macro {} built by {:#?} is not supported by rust-analyzer, please update your Rust version.", path.display(), info);
6464
return Err(io::Error::new(io::ErrorKind::InvalidData, msg));
6565
}
6666

crates/proc-macro-srv/src/abis/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//! compiler into submodules of this module (e.g proc_macro_srv::abis::abi_1_47).
66
//!
77
//! All of these ABIs are subsumed in the `Abi` enum, which exposes a simple
8-
//! interface the rest of rust analyzer can use to talk to the macro
8+
//! interface the rest of rust-analyzer can use to talk to the macro
99
//! provider.
1010
//!
1111
//! # Adding a new ABI

crates/project-model/src/cargo_workspace.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ use crate::{utf8_stdout, ManifestPath};
1919
/// [`CargoWorkspace`] represents the logical structure of, well, a Cargo
2020
/// workspace. It pretty closely mirrors `cargo metadata` output.
2121
///
22-
/// Note that internally, rust analyzer uses a different structure:
22+
/// Note that internally, rust-analyzer uses a different structure:
2323
/// `CrateGraph`. `CrateGraph` is lower-level: it knows only about the crates,
2424
/// while this knows about `Packages` & `Targets`: purely cargo-related
2525
/// concepts.

crates/rust-analyzer/src/integrated_benchmarks.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
//! code here exercise this specific completion, and thus have a fast
77
//! edit/compile/test cycle.
88
//!
9-
//! Note that "Rust Analyzer: Run" action does not allow running a single test
10-
//! in release mode in VS Code. There's however "Rust Analyzer: Copy Run Command Line"
9+
//! Note that "rust-analyzer: Run" action does not allow running a single test
10+
//! in release mode in VS Code. There's however "rust-analyzer: Copy Run Command Line"
1111
//! which you can use to paste the command in terminal and add `--release` manually.
1212
1313
use std::sync::Arc;

crates/syntax/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Syntax Tree library used throughout the rust analyzer.
1+
//! Syntax Tree library used throughout the rust-analyzer.
22
//!
33
//! Properties:
44
//! - easy and fast incremental re-parsing

docs/dev/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ There's **"Run Extension (Debug Build)"** launch configuration for this in VS Co
8282
In general, I use one of the following workflows for fixing bugs and implementing features:
8383

8484
If the problem concerns only internal parts of rust-analyzer (i.e. I don't need to touch the `rust-analyzer` crate or TypeScript code), there is a unit-test for it.
85-
So, I use **Rust Analyzer: Run** action in VS Code to run this single test, and then just do printf-driven development/debugging.
85+
So, I use **rust-analyzer: Run** action in VS Code to run this single test, and then just do printf-driven development/debugging.
8686
As a sanity check after I'm done, I use `cargo xtask install --server` and **Reload Window** action in VS Code to verify that the thing works as I expect.
8787

8888
If the problem concerns only the VS Code extension, I use **Run Installed Extension** launch configuration from `launch.json`.
@@ -152,11 +152,11 @@ To log all communication between the server and the client, there are two choice
152152

153153
There are also several VS Code commands which might be of interest:
154154

155-
* `Rust Analyzer: Status` shows some memory-usage statistics.
155+
* `rust-analyzer: Status` shows some memory-usage statistics.
156156

157-
* `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection.
157+
* `rust-analyzer: Syntax Tree` shows syntax tree of the current file/selection.
158158

159-
* `Rust Analyzer: View Hir` shows the HIR expressions within the function containing the cursor.
159+
* `rust-analyzer: View Hir` shows the HIR expressions within the function containing the cursor.
160160

161161
You can hover over syntax nodes in the opened text file to see the appropriate
162162
rust code that it refers to and the rust editor will also highlight the proper

docs/dev/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ That is, rust-analyzer requires unwinding.
371371

372372
### Testing
373373

374-
Rust Analyzer has three interesting [system boundaries](https://www.tedinski.com/2018/04/10/making-tests-a-positive-influence-on-design.html) to concentrate tests on.
374+
rust-analyzer has three interesting [system boundaries](https://www.tedinski.com/2018/04/10/making-tests-a-positive-influence-on-design.html) to concentrate tests on.
375375

376376
The outermost boundary is the `rust-analyzer` crate, which defines an LSP interface in terms of stdio.
377377
We do integration testing of this component, by feeding it with a stream of LSP requests and checking responses.

docs/dev/guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Next, let's talk about what the inputs to the `Analysis` are, precisely.
6363

6464
## Inputs
6565

66-
Rust Analyzer never does any I/O itself, all inputs get passed explicitly via
66+
rust-analyzer never does any I/O itself, all inputs get passed explicitly via
6767
the `AnalysisHost::apply_change` method, which accepts a single argument, a
6868
`Change`. [`Change`] is a builder for a single change
6969
"transaction", so it suffices to study its methods to understand all of the

docs/user/manual.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ You can follow instructions for installing <<rust-analyzer-language-server-binar
479479
== Troubleshooting
480480

481481
Start with looking at the rust-analyzer version.
482-
Try **Rust Analyzer: Show RA Version** in VS Code (using **Command Palette** feature typically activated by Ctrl+Shift+P) or `rust-analyzer --version` in the command line.
482+
Try **rust-analyzer: Show RA Version** in VS Code (using **Command Palette** feature typically activated by Ctrl+Shift+P) or `rust-analyzer --version` in the command line.
483483
If the date is more than a week ago, it's better to update rust-analyzer version.
484484

485485
The next thing to check would be panic messages in rust-analyzer's log.
@@ -492,7 +492,7 @@ To fully capture LSP messages between the editor and the server, set `"rust-anal
492492
The root cause for many "`nothing works`" problems is that rust-analyzer fails to understand the project structure.
493493
To debug that, first note the `rust-analyzer` section in the status bar.
494494
If it has an error icon and red, that's the problem (hover will have somewhat helpful error message).
495-
**Rust Analyzer: Status** prints dependency information for the current file.
495+
**rust-analyzer: Status** prints dependency information for the current file.
496496
Finally, `RA_LOG=project_model=debug` enables verbose logs during project loading.
497497

498498
If rust-analyzer outright crashes, try running `rust-analyzer analysis-stats /path/to/project/directory/` on the command line.

0 commit comments

Comments
 (0)