rust-lang / rust-lang/rust-analyzer

New assist: extract string to file (include_str)!

Open
#20,495 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

It would be nice to be able to easily move back and forth from a file for longer strings as necessary.

I propose an additional assist that allows strings to be extracted to a file and replaced in the source code with an include_str! macro call.

This is the reverse of https://github.com/rust-lang/rust-analyzer/issues/20494

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

Read issue 20494 first to understand the reverse assist, then inspect rust-analyzer's existing assist implementations and their tests. Trace how string literals and file edits are represented. Done means a user can extract a longer string into a file and have the source replaced with an include_str! call, with coverage for the assist's behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.