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