Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create setup documentation #18304

Merged
merged 3 commits into from
Oct 30, 2024

Conversation

davidkurilla
Copy link
Contributor

Created opinionated rust-analyzer workflow setup guide.

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 15, 2024
@rustbot
Copy link
Collaborator

rustbot commented Oct 18, 2024

There are merge commits (commits with multiple parents) in your changes. We have a no merge policy so these commits will need to be removed for this pull request to be merged.

You can start a rebase with the following commands:

$ # rebase
$ git pull --rebase https://github.com/rust-lang/rust-analyzer.git master
$ git push --force-with-lease

The following commits are merge commits:

@rustbot rustbot added has-merge-commits S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 18, 2024
@davidkurilla davidkurilla force-pushed the docs-create-setup-document branch from f0c54fb to 9ee29f4 Compare October 18, 2024 21:58
@rustbot rustbot removed has-merge-commits S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 18, 2024
Comment on lines 9 to 13
You will also need Visual Studio Code and Visual Studio Code Insiders for this workflow. You can download and install Visual Studio Code [here](https://code.visualstudio.com/Download) and you can download and install Visual Studio Code Insiders [here](https://code.visualstudio.com/insiders/).

You will also need to install the rust-analyzer extension for Visual Studio Code and Visual Studio Code Insiders.

More information about Rust on Visual Studio Code can be found [here](https://code.visualstudio.com/docs/languages/rust)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vscode and/or vscode insiders isn't strictly requirement (unless you want to work on the vscode extension)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be fine to clarify that the setup is for vscode specifically though at the top (given the rest of this guide assumes it)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed vscode and vscode insders as prerequisites. I added some information at the top stating that this workflow guide assumes that the user is using vscode and vscode insiders for this workflow.

**Step 04**: Install the language server locally by running the following command:

```sh
cargo xtask install --server --code-bin code-insiders --dev-rel
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cargo xtask install --server --dev-rel

no need to build the extension unless you use it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This workflow requires building a local installation of the extension. This would allow the user to view eprintln! debug statements in the Rust Analyzer Language Server output.

@davidkurilla davidkurilla force-pushed the docs-create-setup-document branch from a80d3c6 to 0719432 Compare October 22, 2024 15:49
@davidkurilla davidkurilla requested a review from Veykril October 26, 2024 22:16
@Veykril Veykril added this pull request to the merge queue Oct 30, 2024
Merged via the queue into rust-lang:master with commit cd206f5 Oct 30, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants