From 91203699eccf63ee21fee236f493c361c64b5d86 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Wed, 20 Mar 2019 09:37:51 +0300 Subject: [PATCH] introduce docs dir --- README.md | 72 -------------------- ARCHITECTURE.md => docs/dev/ARCHITECTURE.md | 0 CONTRIBUTING.md => docs/dev/CONTRIBUTING.md | 0 DEBUGGING.md => docs/dev/DEBUGGING.md | 0 ROADMAP.md => docs/dev/ROADMAP.md | 0 guide.md => docs/dev/guide.md | 0 docs/dev/lsp-features.md | 74 +++++++++++++++++++++ {editors => docs/user}/README.md | 0 8 files changed, 74 insertions(+), 72 deletions(-) rename ARCHITECTURE.md => docs/dev/ARCHITECTURE.md (100%) rename CONTRIBUTING.md => docs/dev/CONTRIBUTING.md (100%) rename DEBUGGING.md => docs/dev/DEBUGGING.md (100%) rename ROADMAP.md => docs/dev/ROADMAP.md (100%) rename guide.md => docs/dev/guide.md (100%) create mode 100644 docs/dev/lsp-features.md rename {editors => docs/user}/README.md (100%) diff --git a/README.md b/README.md index 5bc90a3f01..acce7219e1 100644 --- a/README.md +++ b/README.md @@ -50,78 +50,6 @@ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0 See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md) -## 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) -- [x] [textDocument/implementation](https://microsoft.github.io/language-server-protocol/specification#textDocument_implementation) -- [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) - - rust-analyzer.syntaxTree - - rust-analyzer.extendSelection - - rust-analyzer.matchingBrace - - rust-analyzer.parentModule - - rust-analyzer.joinLines - - rust-analyzer.run - - rust-analyzer.analyzerStatus -- [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) ## License diff --git a/ARCHITECTURE.md b/docs/dev/ARCHITECTURE.md similarity index 100% rename from ARCHITECTURE.md rename to docs/dev/ARCHITECTURE.md diff --git a/CONTRIBUTING.md b/docs/dev/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/dev/CONTRIBUTING.md diff --git a/DEBUGGING.md b/docs/dev/DEBUGGING.md similarity index 100% rename from DEBUGGING.md rename to docs/dev/DEBUGGING.md diff --git a/ROADMAP.md b/docs/dev/ROADMAP.md similarity index 100% rename from ROADMAP.md rename to docs/dev/ROADMAP.md diff --git a/guide.md b/docs/dev/guide.md similarity index 100% rename from guide.md rename to docs/dev/guide.md diff --git a/docs/dev/lsp-features.md b/docs/dev/lsp-features.md new file mode 100644 index 0000000000..212d132eed --- /dev/null +++ b/docs/dev/lsp-features.md @@ -0,0 +1,74 @@ +# Supported LSP features + +This list documents LSP features, supported by rust-analyzer. + +## 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) +- [x] [textDocument/implementation](https://microsoft.github.io/language-server-protocol/specification#textDocument_implementation) +- [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) + - rust-analyzer.syntaxTree + - rust-analyzer.extendSelection + - rust-analyzer.matchingBrace + - rust-analyzer.parentModule + - rust-analyzer.joinLines + - rust-analyzer.run + - rust-analyzer.analyzerStatus +- [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) diff --git a/editors/README.md b/docs/user/README.md similarity index 100% rename from editors/README.md rename to docs/user/README.md