rust-lang / rust-lang/rust-analyzer

`cargo.buildScripts.*` are poor config names

Open
#13,465 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-config A-documentation C-enhancement
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

Given cargo.buildScripts.overrideCommand allows an arbitrary command to be executed, these configs should not be prefixed with cargo. buildScripts is also a poor choice, given these are not build-script specific settings but also proc-macro related. We should come up with a better more fitting prefix, something like compileTimeDeps.*.

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 tracing the definitions and usages of the cargo.buildScripts.* configuration keys in rust-analyzer. Review how the settings cover build scripts and proc macros, then determine a more fitting shared prefix with the maintainers. Done means the naming decision is agreed and all exposed references are updated consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.