crates/rust-analyzer/src/caps.rs

   1 //! Advertizes the capabilities of the LSP Server.
   2 use std::env;
   3
   4 use lsp_types::{
   5     CallHierarchyServerCapability, ClientCapabilities, CodeActionKind, CodeActionOptions,
   6     CodeActionProviderCapability, CodeLensOptions, CompletionOptions,
   7     DocumentOnTypeFormattingOptions, FileOperationFilter, FileOperationPattern,
   8     FileOperationPatternKind, FileOperationRegistrationOptions, FoldingRangeProviderCapability,
   9     HoverProviderCapability, ImplementationProviderCapability, OneOf, RenameOptions, SaveOptions,
  10     SelectionRangeProviderCapability, SemanticTokensFullOptions, SemanticTokensLegend,
  11     SemanticTokensOptions, ServerCapabilities, SignatureHelpOptions, TextDocumentSyncCapability,
  12     TextDocumentSyncKind, TextDocumentSyncOptions, TypeDefinitionProviderCapability,
  13     WorkDoneProgressOptions, WorkspaceFileOperationsServerCapabilities,
  14     WorkspaceServerCapabilities,
  15 };
  16 use serde_json::json;
  17
  18 use crate::semantic_tokens;
  19
  20 pub fn server_capabilities(client_caps: &ClientCapabilities) -> ServerCapabilities {
  21     ServerCapabilities {
  22         text_document_sync: Some(TextDocumentSyncCapability::Options(TextDocumentSyncOptions {
  23             open_close: Some(true),
  24             change: Some(if env::var("RA_NO_INCREMENTAL_SYNC").is_ok() {
  25                 TextDocumentSyncKind::Full
  26             } else {
  27                 TextDocumentSyncKind::Incremental
  28             }),
  29             will_save: None,
  30             will_save_wait_until: None,
  31             save: Some(SaveOptions::default().into()),
  32         })),
  33         hover_provider: Some(HoverProviderCapability::Simple(true)),
  34         completion_provider: Some(CompletionOptions {
  35             resolve_provider: completions_resolve_provider(client_caps),
  36             trigger_characters: Some(vec![":".to_string(), ".".to_string(), "'".to_string()]),
  37             all_commit_characters: None,
  38             completion_item: None,
  39             work_done_progress_options: WorkDoneProgressOptions { work_done_progress: None },
  40         }),
  41         signature_help_provider: Some(SignatureHelpOptions {
  42             trigger_characters: Some(vec!["(".to_string(), ",".to_string()]),
  43             retrigger_characters: None,
  44             work_done_progress_options: WorkDoneProgressOptions { work_done_progress: None },
  45         }),
  46         declaration_provider: None,
  47         definition_provider: Some(OneOf::Left(true)),
  48         type_definition_provider: Some(TypeDefinitionProviderCapability::Simple(true)),
  49         implementation_provider: Some(ImplementationProviderCapability::Simple(true)),
  50         references_provider: Some(OneOf::Left(true)),
  51         document_highlight_provider: Some(OneOf::Left(true)),
  52         document_symbol_provider: Some(OneOf::Left(true)),
  53         workspace_symbol_provider: Some(OneOf::Left(true)),
  54         code_action_provider: Some(code_action_capabilities(client_caps)),
  55         code_lens_provider: Some(CodeLensOptions { resolve_provider: Some(true) }),
  56         document_formatting_provider: Some(OneOf::Left(true)),
  57         document_range_formatting_provider: None,
  58         document_on_type_formatting_provider: Some(DocumentOnTypeFormattingOptions {
  59             first_trigger_character: "=".to_string(),
  60             more_trigger_character: Some(vec![".".to_string(), ">".to_string(), "{".to_string()]),
  61         }),
  62         selection_range_provider: Some(SelectionRangeProviderCapability::Simple(true)),
  63         folding_range_provider: Some(FoldingRangeProviderCapability::Simple(true)),
  64         rename_provider: Some(OneOf::Right(RenameOptions {
  65             prepare_provider: Some(true),
  66             work_done_progress_options: WorkDoneProgressOptions { work_done_progress: None },
  67         })),
  68         linked_editing_range_provider: None,
  69         document_link_provider: None,
  70         color_provider: None,
  71         execute_command_provider: None,
  72         workspace: Some(WorkspaceServerCapabilities {
  73             workspace_folders: None,
  74             file_operations: Some(WorkspaceFileOperationsServerCapabilities {
  75                 did_create: None,
  76                 will_create: None,
  77                 did_rename: None,
  78                 will_rename: Some(FileOperationRegistrationOptions {
  79                     filters: vec![
  80                         FileOperationFilter {
  81                             scheme: Some(String::from("file")),
  82                             pattern: FileOperationPattern {
  83                                 glob: String::from("**/*.rs"),
  84                                 matches: Some(FileOperationPatternKind::File),
  85                                 options: None,
  86                             },
  87                         },
  88                         FileOperationFilter {
  89                             scheme: Some(String::from("file")),
  90                             pattern: FileOperationPattern {
  91                                 glob: String::from("**"),
  92                                 matches: Some(FileOperationPatternKind::Folder),
  93                                 options: None,
  94                             },
  95                         },
  96                     ],
  97                 }),
  98                 did_delete: None,
  99                 will_delete: None,
 100             }),
 101         }),
 102         call_hierarchy_provider: Some(CallHierarchyServerCapability::Simple(true)),
 103         semantic_tokens_provider: Some(
 104             SemanticTokensOptions {
 105                 legend: SemanticTokensLegend {
 106                     token_types: semantic_tokens::SUPPORTED_TYPES.to_vec(),
 107                     token_modifiers: semantic_tokens::SUPPORTED_MODIFIERS.to_vec(),
 108                 },
 109
 110                 full: Some(SemanticTokensFullOptions::Delta { delta: Some(true) }),
 111                 range: Some(true),
 112                 work_done_progress_options: Default::default(),
 113             }
 114             .into(),
 115         ),
 116         moniker_provider: None,
 117         experimental: Some(json!({
 118             "joinLines": true,
 119             "ssr": true,
 120             "onEnter": true,
 121             "parentModule": true,
 122             "runnables": {
 123                 "kinds": [ "cargo" ],
 124             },
 125             "workspaceSymbolScopeKindFiltering": true,
 126         })),
 127     }
 128 }
 129
 130 fn completions_resolve_provider(client_caps: &ClientCapabilities) -> Option<bool> {
 131     if completion_item_edit_resolve(client_caps) {
 132         Some(true)
 133     } else {
 134         log::info!("No `additionalTextEdits` completion resolve capability was found in the client capabilities, autoimport completion is disabled");
 135         None
 136     }
 137 }
 138
 139 /// Parses client capabilities and returns all completion resolve capabilities rust-analyzer supports.
 140 pub(crate) fn completion_item_edit_resolve(caps: &ClientCapabilities) -> bool {
 141     (|| {
 142         Some(
 143             caps.text_document
 144                 .as_ref()?
 145                 .completion
 146                 .as_ref()?
 147                 .completion_item
 148                 .as_ref()?
 149                 .resolve_support
 150                 .as_ref()?
 151                 .properties
 152                 .iter()
 153                 .any(|cap_string| cap_string.as_str() == "additionalTextEdits"),
 154         )
 155     })() == Some(true)
 156 }
 157
 158 fn code_action_capabilities(client_caps: &ClientCapabilities) -> CodeActionProviderCapability {
 159     client_caps
 160         .text_document
 161         .as_ref()
 162         .and_then(|it| it.code_action.as_ref())
 163         .and_then(|it| it.code_action_literal_support.as_ref())
 164         .map_or(CodeActionProviderCapability::Simple(true), |_| {
 165             CodeActionProviderCapability::Options(CodeActionOptions {
 166                 // Advertise support for all built-in CodeActionKinds.
 167                 // Ideally we would base this off of the client capabilities
 168                 // but the client is supposed to fall back gracefully for unknown values.
 169                 code_action_kinds: Some(vec![
 170                     CodeActionKind::EMPTY,
 171                     CodeActionKind::QUICKFIX,
 172                     CodeActionKind::REFACTOR,
 173                     CodeActionKind::REFACTOR_EXTRACT,
 174                     CodeActionKind::REFACTOR_INLINE,
 175                     CodeActionKind::REFACTOR_REWRITE,
 176                 ]),
 177                 resolve_provider: Some(true),
 178                 work_done_progress_options: Default::default(),
 179             })
 180         })
 181 }