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, FoldingRangeProviderCapability, HoverProviderCapability,
   8     ImplementationProviderCapability, RenameOptions, RenameProviderCapability, SaveOptions,
   9     SelectionRangeProviderCapability, SemanticTokensDocumentProvider, SemanticTokensLegend,
  10     SemanticTokensOptions, ServerCapabilities, SignatureHelpOptions, TextDocumentSyncCapability,
  11     TextDocumentSyncKind, TextDocumentSyncOptions, TypeDefinitionProviderCapability,
  12     WorkDoneProgressOptions,
  13 };
  14 use serde_json::json;
  15
  16 use crate::semantic_tokens;
  17
  18 pub fn server_capabilities(client_caps: &ClientCapabilities) -> ServerCapabilities {
  19     let code_action_provider = code_action_capabilities(client_caps);
  20
  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: None,
  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(true),
  46         type_definition_provider: Some(TypeDefinitionProviderCapability::Simple(true)),
  47         implementation_provider: Some(ImplementationProviderCapability::Simple(true)),
  48         references_provider: Some(true),
  49         document_highlight_provider: Some(true),
  50         document_symbol_provider: Some(true),
  51         workspace_symbol_provider: Some(true),
  52         code_action_provider: Some(code_action_provider),
  53         code_lens_provider: Some(CodeLensOptions { resolve_provider: Some(true) }),
  54         document_formatting_provider: Some(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(RenameProviderCapability::Options(RenameOptions {
  64             prepare_provider: Some(true),
  65             work_done_progress_options: WorkDoneProgressOptions { work_done_progress: None },
  66         })),
  67         document_link_provider: None,
  68         color_provider: None,
  69         execute_command_provider: None,
  70         workspace: None,
  71         call_hierarchy_provider: Some(CallHierarchyServerCapability::Simple(true)),
  72         semantic_tokens_provider: Some(
  73             SemanticTokensOptions {
  74                 legend: SemanticTokensLegend {
  75                     token_types: semantic_tokens::SUPPORTED_TYPES.to_vec(),
  76                     token_modifiers: semantic_tokens::SUPPORTED_MODIFIERS.to_vec(),
  77                 },
  78
  79                 document_provider: Some(SemanticTokensDocumentProvider::Bool(true)),
  80                 range_provider: Some(true),
  81                 work_done_progress_options: Default::default(),
  82             }
  83             .into(),
  84         ),
  85         experimental: Some(json!({
  86             "joinLines": true,
  87             "ssr": true,
  88             "onEnter": true,
  89             "parentModule": true,
  90             "runnables": {
  91                 "kinds": [ "cargo" ],
  92             },
  93         })),
  94     }
  95 }
  96
  97 fn code_action_capabilities(client_caps: &ClientCapabilities) -> CodeActionProviderCapability {
  98     client_caps
  99         .text_document
 100         .as_ref()
 101         .and_then(|it| it.code_action.as_ref())
 102         .and_then(|it| it.code_action_literal_support.as_ref())
 103         .map_or(CodeActionProviderCapability::Simple(true), |_| {
 104             CodeActionProviderCapability::Options(CodeActionOptions {
 105                 // Advertise support for all built-in CodeActionKinds.
 106                 // Ideally we would base this off of the client capabilities
 107                 // but the client is supposed to fall back gracefully for unknown values.
 108                 code_action_kinds: Some(vec![
 109                     CodeActionKind::EMPTY,
 110                     CodeActionKind::QUICKFIX,
 111                     CodeActionKind::REFACTOR,
 112                     CodeActionKind::REFACTOR_EXTRACT,
 113                     CodeActionKind::REFACTOR_INLINE,
 114                     CodeActionKind::REFACTOR_REWRITE,
 115                 ]),
 116                 work_done_progress_options: Default::default(),
 117             })
 118         })
 119 }