mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-27 05:23:24 +00:00

History

Elias Holzmann 3dfc1bfc67 Use vscode.env.openExternal instead of the vscode.open command for docs According to the VS Code documentation, the vscode.open command opens the URL _in the editor_ (https://code.visualstudio.com/api/references/commands). However, in reality, it seems to do so only for file:// URLs, falling back to other applications for other URL schemes (at least for HTTP/HTTPS). Until now, the URL to the documentation was always HTTP based, so using the vscode.open command was perfectly fine. However, displaying local documentation will be supported from now on (see next commit). Local documentation is not HTTP-based, but instead addressed via a file:// URL. The file URL would therefore be opened in VS Code instead of in the browser — this is definitely not what the user wants. Therefore, the vscode.env.openExternal function is used instead, this function never opens the URL in VS Code.		2023-10-08 04:56:48 +02:00
..
src	Use vscode.env.openExternal instead of the vscode.open command for docs	2023-10-08 04:56:48 +02:00
tests	editor/code: Re-apply code format	2023-07-13 22:44:29 +09: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	Remove markdown injection	2023-06-23 11:31:10 +02:00
icon.png	Extension icon	2020-01-15 16:07:39 +01:00
language-configuration.json	feat: add backtick to surrounding and auto-closing pairs	2023-09-26 06:36:37 +00:00
LICENSE	Add LICENSE file to make vsce happy	2021-12-04 12:29:27 +02:00
package-lock.json	vscode: change minimum VS Code version to 1.75 from 1.78	2023-07-24 11:24:24 -04:00
package.json	Auto merge of #15707 - dfireBird:default-statusbar-action-config, r=lnicola	2023-10-04 17:31:44 +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	editor/code: Add FIXME comments for TS' `--exactOptionalPropertyTypes` option	2023-07-10 23:39:08 +09: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.