mirror of https://github.com/rust-lang/rust-analyzer synced 2025-01-13 21:54:42 +00:00

History

bors 78d5f05e70 Auto merge of #17508 - jjoeldaniel:landing-page, r=Veykril feat: Add landing/faq walkthrough pages This is a basic implementation of a landing and FAQ page; I've included the bare-bones information as well as a [recommended section on inlay hints](https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer/topic/Landing.20Page/near/446135321). I've also added `rust-analyzer: Open Walkthrough` and `rust-analyzer: Open FAQ` commands for ease of access. I am hoping to create a small list of FAQ to include that might be useful as well as any other information I may have missed in the landing page. Feel free to share any suggestions! ![landing/faq page demo](https://github.com/rust-lang/rust-analyzer/assets/100006388/4644e4f0-4555-4b29-83c1-b048084ad63d) cc #13351		2024-07-06 13:59:36 +00:00
..
src	Auto merge of #17508 - jjoeldaniel:landing-page, r=Veykril	2024-07-06 13:59:36 +00:00
tests	feature: add build system info; runnables to `rust-project.json`	2024-06-11 11:55:17 -04:00
.eslintignore	vscode extension: use esbuild instead of rollup.	2021-08-10 10:18:08 +01:00
.eslintrc.js	editor/code: Update typescript-eslint to v6	2023-07-13 22:44:29 +09:00
.gitignore	Add experimental VSCode api	2022-03-04 07:45:51 +02:00
.prettierignore	prettier config	2022-05-17 18:12:49 +01:00
.prettierrc.js	prettier config	2022-05-17 18:12:49 +01:00
.vscodeignore	internal: Revert #16541	2024-02-27 15:48:30 +01:00
icon.png	Extension icon	2020-01-15 16:07:39 +01:00
language-configuration.json	fix: support auto-closing for triple backticks	2024-04-11 18:46:22 +08:00
LICENSE	Add LICENSE file to make vsce happy	2021-12-04 12:29:27 +02:00
package-lock.json	Chore(deps-dev): Bump braces from 3.0.2 to 3.0.3 in /editors/code	2024-06-11 09:01:41 +00:00
package.json	Auto merge of #17508 - jjoeldaniel:landing-page, r=Veykril	2024-07-06 13:59:36 +00:00
ra_syntax_tree.tmGrammar.json	prettier run	2022-05-17 18:15:06 +01:00
README.md	Improve extension description and README	2022-05-13 18:15:33 +02:00
tsconfig.eslint.json	prettier run	2022-05-17 18:15:06 +01:00
tsconfig.json	internal: Remove unnecessary Arc allocations in `macro_expand`	2024-01-03 15:21:18 +01:00

README.md

rust-analyzer

This extension provides support for the Rust programming language. It is recommended over and replaces rust-lang.rust.

Features

code completion with imports insertion
go to definition, implementation, type definition
find all references, workspace symbol search, symbol renaming
types and documentation on hover
inlay hints for types and parameter names
semantic syntax highlighting
a lot of assists (code actions)
apply suggestions from errors
... and many more, check out the manual to see them all

Quick start

Install rustup.
Install the rust-analyzer extension.

Configuration

This extension provides configurations through VSCode's configuration settings. All configurations are under rust-analyzer.*.

See the manual for more information on VSCode specific configurations.

Communication

For usage and troubleshooting requests, please use the "IDEs and Editors" category of the Rust forum.

Documentation

See rust-analyzer.github.io for more information.