rust-lang / rust-lang/rust-analyzer

Rename/alias "Run flycheck" command to something more obvious

Open
#14,398 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

I agree that flycheck isn't the best fit, but check seems really generic so I am not sure if its apparent what check necessarily means for people when they read it for the first time either? I guess Run cargo check would be better? (shame we can't have the command label be dynamic).

Alternatively we can start pushing the flycheck term so that people know what it means. After adding this I was thinking of maybe changing the name of checkOnSave configs to check, flycheck, etc since it's no longer only tied to saving

Originally posted by @Veykril in https://github.com/rust-lang/rust-analyzer/issues/13785#issuecomment-1357837161

I found the above comment while trying to find the name of this command, which does not seem to be very discoverable with cargo check or rust check in the VSCode command palette:

Screenshot_20230324_093044

Screenshot_20230324_093247

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the VSCode command registration for the current “Run flycheck” command and inspect how its label appears in the command palette. Rename or alias it so users can find it through cargo check or rust check, then verify the updated wording in the VSCode command palette.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.