Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rust-lang/atom-ide-rust
Rust IDE support for Atom, powered by the Rust Analyzer or Rust Language Server
https://github.com/rust-lang/atom-ide-rust
atom atom-ide ide rls rust
Last synced: about 1 month ago
JSON representation
Rust IDE support for Atom, powered by the Rust Analyzer or Rust Language Server
- Host: GitHub
- URL: https://github.com/rust-lang/atom-ide-rust
- Owner: rust-lang
- License: mit
- Archived: true
- Created: 2017-07-20T22:56:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-17T06:12:07.000Z (about 1 year ago)
- Last Synced: 2024-09-25T20:14:05.200Z (about 2 months ago)
- Topics: atom, atom-ide, ide, rls, rust
- Language: JavaScript
- Size: 625 KB
- Stars: 259
- Watchers: 15
- Forks: 42
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-cn - rust-lang/atom-ide-rust
README
# IDE-Rust
Rust language support for Atom-IDE, powered by [rust-analyzer](https://github.com/rust-analyzer/rust-analyzer).
## Features
- Auto-completion
- Diagnostics (errors and warnings from `rustc`)
- Document outline
- Go to definition (`ctrl` or `cmd` click)
- Type information and Documentation on hover (hold `ctrl` or `cmd` for more information)
- Find references (`ctrl-alt-shift-f` or `cmd-opt-shift-f` also in context menu)
- Format file with rustfmt (`ctrl-shift-c` or `cmd-shift-c` also in context menu)
- Format on save (disabled by default, see `atom-ide-ui` settings)
- Rustup toolchain update checking at startup & every 6 hours thereafter
- Supports rustup override toolchains
- Rust language snippets
## Install
Install from Settings view by searching for `ide-rust`, or with the command line:
```
$ apm install ide-rust
```
### Prerequisites
**rust-analyzer** must be installed manually, if possible on the PATH _(otherwise configure this in the package settings)_.
See https://rust-analyzer.github.io/manual.html#rust-analyzer-language-server-binary.
NOTE: On Windows, you can install it using [choco](https://chocolatey.org/install): `choco install rust-analyzer`
No other packages or manual setup is required as these will be handled with user prompts after install.
However, you may wish to install `rustup` with your OS package manager instead of following prompts to install via [rustup.rs](https://rustup.rs).
## Configure rust-analyzer
**rust-analyzer** settings can be stored in a JSON file in the project directory.
It first looks for `rust-analyzer.json`.
If the file does not exists, it then checks `.config/rust-analyzer.json`.
Refer to the rust-analyzer [User Manual](https://rust-analyzer.github.io/manual.html#configuration) for the supported config options.
### Examples
#### enable proc-macro support (from the [User Manual](https://rust-analyzer.github.io/manual.html#configuration))
```json
{
"cargo": {
"loadOutDirsFromCheck": true,
},
"procMacro": {
"enable": true,
}
}
```
#### configure rust-fmt
```json
{
"rustfmt": {
"extraArgs": ["+nightly"]
}
}
```
## Commands
- `ide-rust:restart-all-language-servers` Restart all currently active Rls processes
## Debugging IDE-Rust
If stuff isn't working you can try **enabling logging** to debug:
- Open the atom console _(ctrl-shift-i)_
- Enter `atom.config.set('core.debugLSP', true)`
- Reload atom _(ctrl-shift-F5)_
This will spit out language server message logging into the atom console. Check if requests/responses are being sent or are incorrect.
## RLS
RLS is no longer supported. To use RLS install a previous version of ide-rust, `apm install [email protected]`.
## Screenshots
**Autocomplete**:
**Datatips**:
**Linter**:
**Outline**:
## License
MIT License. See the [license](LICENSE) for more details.