Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-27 05:23:24 +00:00
Code Issues Projects Releases Packages Wiki Activity
rust-analyzer/README.md

132 lines
7.5 KiB
Markdown
Raw Normal View History

Update readme
2018-09-16 11:29:34 +00:00
# Rust Analyzer
D: start documenting stuff
2018-01-10 18:58:38 +00:00
fix readme
2018-10-09 13:18:22 +00:00
[![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)
Add appveyor badge
2018-01-28 00:15:30 +00:00
tweak readme
2019-01-13 10:51:26 +00:00
Rust Analyzer is an **experimental** modular compiler frontend for the Rust
update readme to point to the WG
2019-02-12 14:55:02 +00:00
language. It is a part of a larger rls-2.0 effort to create excellent IDE
Point to the compiler-team repo directly
2019-03-13 18:36:26 +00:00
support for Rust. If you want to get involved, check the rls-2.0 working group
in the compiler-team repository:
Add Gitter badge
2018-01-10 19:49:22 +00:00
Point to the compiler-team repo directly
2019-03-13 18:36:26 +00:00
https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0
D: start documenting stuff
2018-01-10 18:58:38 +00:00
Add link to ferrous
2018-10-22 12:59:01 +00:00
Work on the Rust Analyzer is sponsored by
[![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/)
README
2018-08-24 15:14:21 +00:00
## Quick Start
update README with Rust 1.31
2018-12-28 22:02:23 +00:00
Rust analyzer builds on Rust >= 1.31.0 and uses the 2018 edition.
tweak readme
2018-09-16 12:36:09 +00:00
README
2018-08-24 15:14:21 +00:00
```
tweak readme
2018-09-16 12:36:09 +00:00
# run tests
README
2018-08-24 15:14:21 +00:00
$ cargo test
tweak readme
2018-09-16 12:36:09 +00:00
# show syntax tree of a Rust file
$ cargo run --package ra_cli parse < crates/ra_syntax/src/lib.rs
README
2018-08-24 15:14:21 +00:00
tweak readme
2018-09-16 12:36:09 +00:00
# show symbols of a Rust file
$ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs
README
2018-08-24 15:14:21 +00:00
tweak readme
2019-01-13 10:51:26 +00:00
# install the language server
Add install-lsp subcommand
2019-01-23 18:41:23 +00:00
$ cargo install-lsp
or
tweak readme
2019-01-13 10:51:26 +00:00
$ cargo install --path crates/ra_lsp_server
```
note about symbol search
2018-09-08 16:23:52 +00:00
tweak readme
2019-01-13 10:51:26 +00:00
See [these instructions](./editors/README.md) for VS Code setup and the list of
features (some of which are VS Code specific).
README
2018-08-24 15:14:21 +00:00
Config for raLspServerPath will be overwritten if __RA_LSP_SERVER_DEBUG is set Changed presentation from clear to reveal silent Removed the vscode gitignore entry Added debugging documentation Added tasks and launch configs
2019-01-18 10:59:08 +00:00
## Debugging
Corrected the readme on debugging
2019-01-18 11:45:17 +00:00
See [these instructions](./DEBUGGING.md) on how to debug the vscode extension and the lsp server.
Config for raLspServerPath will be overwritten if __RA_LSP_SERVER_DEBUG is set Changed presentation from clear to reveal silent Removed the vscode gitignore entry Added debugging documentation Added tasks and launch configs
2019-01-18 10:59:08 +00:00
update readme to point to the WG
2019-02-12 14:55:02 +00:00
## Getting in touch
Update readme
2018-09-16 11:29:34 +00:00
update readme to point to the WG
2019-02-12 14:55:02 +00:00
We are on the rust-lang Zulip!
Update readme
2018-09-16 11:29:34 +00:00
update readme to point to the WG
2019-02-12 14:55:02 +00:00
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
brush up docs
2018-10-09 18:30:41 +00:00
update readme to point to the WG
2019-02-12 14:55:02 +00:00
## Contributing
tweak readme
2019-01-13 10:51:26 +00:00
update readme to point to the WG
2019-02-12 14:55:02 +00:00
See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md)
README
2018-08-24 15:14:21 +00:00
Add supported LSP features to README.md
2019-01-23 17:16:20 +00:00
## Supported LSP features
### General
- [x] [initialize](https://microsoft.github.io/language-server-protocol/specification#initialize)
- [x] [initialized](https://microsoft.github.io/language-server-protocol/specification#initialized)
- [x] [shutdown](https://microsoft.github.io/language-server-protocol/specification#shutdown)
- [ ] [exit](https://microsoft.github.io/language-server-protocol/specification#exit)
- [x] [$/cancelRequest](https://microsoft.github.io/language-server-protocol/specification#cancelRequest)
### Workspace
- [ ] [workspace/workspaceFolders](https://microsoft.github.io/language-server-protocol/specification#workspace_workspaceFolders)
- [ ] [workspace/didChangeWorkspaceFolders](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeWorkspaceFolders)
- [x] [workspace/didChangeConfiguration](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeConfiguration)
- [ ] [workspace/configuration](https://microsoft.github.io/language-server-protocol/specification#workspace_configuration)
- [x] [workspace/didChangeWatchedFiles](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeWatchedFiles)
- [x] [workspace/symbol](https://microsoft.github.io/language-server-protocol/specification#workspace_symbol)
- [x] [workspace/executeCommand](https://microsoft.github.io/language-server-protocol/specification#workspace_executeCommand)
- `apply_code_action`
- [ ] [workspace/applyEdit](https://microsoft.github.io/language-server-protocol/specification#workspace_applyEdit)
### Text Synchronization
- [x] [textDocument/didOpen](https://microsoft.github.io/language-server-protocol/specification#textDocument_didOpen)
- [x] [textDocument/didChange](https://microsoft.github.io/language-server-protocol/specification#textDocument_didChange)
- [ ] [textDocument/willSave](https://microsoft.github.io/language-server-protocol/specification#textDocument_willSave)
- [ ] [textDocument/willSaveWaitUntil](https://microsoft.github.io/language-server-protocol/specification#textDocument_willSaveWaitUntil)
- [x] [textDocument/didSave](https://microsoft.github.io/language-server-protocol/specification#textDocument_didSave)
- [x] [textDocument/didClose](https://microsoft.github.io/language-server-protocol/specification#textDocument_didClose)
### Diagnostics
- [x] [textDocument/publishDiagnostics](https://microsoft.github.io/language-server-protocol/specification#textDocument_publishDiagnostics)
### Lanuguage Features
- [x] [textDocument/completion](https://microsoft.github.io/language-server-protocol/specification#textDocument_completion)
- open close: false
- change: Full
- will save: false
- will save wait until: false
- save: false
- [x] [completionItem/resolve](https://microsoft.github.io/language-server-protocol/specification#completionItem_resolve)
- resolve provider: none
- trigger characters: `:`, `.`
- [x] [textDocument/hover](https://microsoft.github.io/language-server-protocol/specification#textDocument_hover)
- [x] [textDocument/signatureHelp](https://microsoft.github.io/language-server-protocol/specification#textDocument_signatureHelp)
- trigger characters: `(`, `,`, `)`
- [ ] [textDocument/declaration](https://microsoft.github.io/language-server-protocol/specification#textDocument_declaration)
- [x] [textDocument/definition](https://microsoft.github.io/language-server-protocol/specification#textDocument_definition)
- [ ] [textDocument/typeDefinition](https://microsoft.github.io/language-server-protocol/specification#textDocument_typeDefinition)
Go to Implementation for structs and enums
2019-01-28 14:26:32 +00:00
- [x] [textDocument/implementation](https://microsoft.github.io/language-server-protocol/specification#textDocument_implementation)
Add supported LSP features to README.md
2019-01-23 17:16:20 +00:00
- [x] [textDocument/references](https://microsoft.github.io/language-server-protocol/specification#textDocument_references)
- [x] [textDocument/documentHighlight](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentHighlight)
- [x] [textDocument/documentSymbol](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentSymbol)
- [x] [textDocument/codeAction](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeAction)
align command naming
2019-01-28 11:43:07 +00:00
- rust-analyzer.syntaxTree
- rust-analyzer.extendSelection
- rust-analyzer.matchingBrace
- rust-analyzer.parentModule
- rust-analyzer.joinLines
- rust-analyzer.run
- rust-analyzer.analyzerStatus
Add supported LSP features to README.md
2019-01-23 17:16:20 +00:00
- [x] [textDocument/codeLens](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeLens)
- [ ] [textDocument/documentLink](https://microsoft.github.io/language-server-protocol/specification#codeLens_resolve)
- [ ] [documentLink/resolve](https://microsoft.github.io/language-server-protocol/specification#documentLink_resolve)
- [ ] [textDocument/documentColor](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentColor)
- [ ] [textDocument/colorPresentation](https://microsoft.github.io/language-server-protocol/specification#textDocument_colorPresentation)
- [x] [textDocument/formatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_formatting)
- [ ] [textDocument/rangeFormatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_rangeFormatting)
- [x] [textDocument/onTypeFormatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_onTypeFormatting)
- first trigger character: `=`
- more trigger character `.`
- [x] [textDocument/rename](https://microsoft.github.io/language-server-protocol/specification#textDocument_rename)
- [x] [textDocument/prepareRename](https://microsoft.github.io/language-server-protocol/specification#textDocument_prepareRename)
- [x] [textDocument/foldingRange](https://microsoft.github.io/language-server-protocol/specification#textDocument_foldingRange)
Licenses
2018-01-10 19:47:04 +00:00
## License
tweak readme
2018-09-16 12:36:09 +00:00
Rust analyzer is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0).
Licenses
2018-01-10 19:47:04 +00:00
See LICENSE-APACHE and LICENSE-MIT for details.
Reference in a new issue Copy permalink