Added project-specific Zed IDE settings

[ChaiTRex]

This repository currently has project-specific VS Code IDE settings in .vscode and compiler/rustc_codegen_cranelift/.vscode. Now there are equivalent project-specific Zed IDE settings alongside those.

This fixes rust-analyzer not being able to properly handle this project.

Note that:

1. The contents of src/tools/rust-analyzer/.vscode could not be translated to Zed, as they aren't basic IDE settings.

2. One of the VS Code settings in .vscode has no corresponding setting in Zed, and so this has been noted like this:

     "_settings_only_in_vs_code_not_yet_in_zed": {
       "git.detectSubmodulesLimit": 20
     },

[rustbot]

r? @nnethercote

rustbot has assigned @nnethercote.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

[rustbot]

Some changes occurred in compiler/rustc_codegen_cranelift

cc @bjorn3

[tgross35]

I don't think this repo has a top-level .vscode, but it seems like x can generate that for you https://rustc-dev-guide.rust-lang.org/building/suggested.html#configuring-rust-analyzer-for-rustc. Maybe we could do the same here?

[nnethercote]

This repository currently has project-specific VS Code IDE settings in .vscode and compiler/rustc_codegen_cranelift/.vscode.

.vscode doesn't exist but compiler/rustc_codegen_cranelift/.vscode does exist. That's strange. (cc @bjorn3)

I don't know much about IDEs, but @tgross35's suggestion about generating the Zed settings seems reasonable.

[bjorn3]

As @tgross35 said, for this repo, ./x.py has a command to generate .vscode/settings.json as well as update it when the user hasn't changed it themself (by keeping hashes of all previous versions). For Zed we should probably do something similar. As for compiler/rustc_codegen_cranelift, that is maintained in a separate repo (https://github.com/rust-lang/rustc_codegen_cranelift) which is periodically synced with this repo. It doesn't have a command for generating .vscode/settings.json. Instead I checked in my personal workspace settings, which should work fine for most people.

[ChaiTRex]

OK, I'll examine x.py and rust-lang/rustc_codegen_cranelift and try to get it working through those.

[ChaiTRex]

@bjorn3 said:

As for compiler/rustc_codegen_cranelift, that is maintained in a separate repo (https://github.com/rust-lang/rustc_codegen_cranelift) which is periodically synced with this repo. It doesn't have a command for generating .vscode/settings.json. Instead I checked in my personal workspace settings, which should work fine for most people.

Made rustc_codegen_cranelift pull request at rust-lang/rustc_codegen_cranelift#1517.

[ChaiTRex]

rustc_codegen_cranelift pull request was merged.

[rustbot]

This PR modifies src/bootstrap/src/core/config.

If appropriate, please update CONFIG_CHANGE_HISTORY in src/bootstrap/src/utils/change_tracker.rs.

[bjorn3]

This option was introduced for vscode in #120138. There is a fair chance that zed won't suffer from the same issue once it has a git ui anyway (they may not even add a hard limit on the amount of auto detected git submodules at all). I don't think there is any value in keeping this.

[tgross35]

It could be nicer to still keep one file for RA settings, then just delete this key via bootstrap (serde_json is already a dependency). So if there are future updates that work for both, they only need to happen in one file.

[ChaiTRex]

In order to do this properly, I think we'll need three files: one shared file for rust-analyzer settings and one file each for the non-rust-analyzer IDE-specific settings.

Even IDE settings that do the same thing are different between the two IDEs. For example, to turn on format-on-save, VS Code wants "editor.formatOnSave": true, while Zed wants "format_on_save": "on",.

There are also JSON structure requirements that differ between the IDEs. For example, VS Code wants the rust-analyzer settings to use the standard dotted notation at the root of the JSON tree, like:

{
    "rust-analyzer.rustc.source": "discover"
}

Zed wants the rust-analyzer settings to live under a path through the JSON tree of "lsp", then "rust-analyzer", then "initialization_options", then the setting with the original dots signifying an increase in tree depth:

{
  "lsp": {
    "rust-analyzer": {
      "initialization_options": {
        "rustc": {
          "source": "discover"
        }
      }
    }
  }
}

So this means that we need to do JSON parsing of our three files, transformation of the structure, and JSON generation of the resulting .vscode/settings.json and .zed/settings.json files.

[tgross35]

You could also just have one rust source file with everything in json!, and build it dynamically

use serde_json::{json, Value};

fn base_settings() -> Value {
    json! {{
         // common settings 
    }}
}

fn vscode_settings() -> Value {
    let vscode_specific = json! {{ anything new}} 

    let mut inner = base_settings();
    inner.as_object_mut().unwrap().extend(vscode_specific);

    json! {{
         "lsp": {
             "rust_analyzer": /* other nesting */ inner,
         }
    }}
}

fn zed_settings() -> Value {
    // ...
}

Which would also be kind of nice because it's easy to cover any config file schema or format. E.g. I would appreciate a Helix config at some point, but that uses toml (easy to convert from serde_json to toml, both are already dependencies of bootstrap).

But 🤷, that may be overkill.

[ChaiTRex]

@bjorn3 Removed comment in Zed settings.json.

[ChaiTRex]

@tgross35 It looks like they've added some settings for a few more IDEs in the meantime (Emacs, Helix, and Vim/VS Code), but they put all the settings into each one.

[bjorn3]

Can this function be deduplicated with the vscode version?

[ChaiTRex]

@bjorn3 It seems to have been deduplicated in the meantime.

[nnethercote]

I will defer on the review to either @bjorn3 or @tgross35, who clearly know much more about this stuff than I do :)

[tgross35]

Should probably just see what bootstrap prefers here

r? bootstrap

[onur-ozkan]

Can Zed work with the VsCode configuration file somehow (like neovim)?

FWIW #120611 would solve the whole problem of maintaining IDE specific files.

[onur-ozkan]

FWIW #120611 would solve the whole problem of maintaining IDE specific files.

Seems like we will also need rust-lang/rust-analyzer#13529 for that.

[bors]

☔ The latest upstream changes (presumably #130091) made this pull request unmergeable. Please resolve the merge conflicts.

[tgross35]

Okay well we added emacs and helix sample config files, so maybe just adding the zed file is fine here too :) #130932

[Kobzol]

FYI, we now have a dedicated x setup editor command for configuring setup for various IDEs (#131075). So Zed could be added as another IDE to that command.

[Dylan-DPC]

@ChaiTRex any updates on this pr? thanks

[ChaiTRex]

@Dylan-DPC Sorry for the delay. I've rebased this on the new multi-IDE system we now have and made a few minor improvements, like double-checking the latest hashes for all IDEs rather than just VS Code, which caught a missing Helix hash.

[Kobzol]

Thanks! Could you also please add a mention of Zed to the suggested workflow page in rustc-dev-guide (https://github.com/rust-lang/rust/blob/fd911ea65a50c838f4334ef353c80ec46358c9e6/src/doc/rustc-dev-guide/src/building/suggested.md#helix)? You can do it directly with a commit in this PR, as rustc-dev-guide is now a subtree of rust-lang/rust.

[rustbot]

The rustc-dev-guide subtree was changed. If this PR only touches the dev guide consider submitting a PR directly to rust-lang/rustc-dev-guide otherwise thank you for updating the dev guide with your changes.

cc @BoxyUwU, @jieyouxu, @Kobzol

[ChaiTRex]

@Kobzol Done. Please let me know if it needs improvement.

[Kobzol]

Thanks!

@bors r+ rollup

[bors]

📌 Commit 410331c has been approved by Kobzol

It is now in the queue for this repository.