Implement support for textDocument/linkedEditingRange (#3166)

Fixes #2449

Author: yyoncho

CHANGELOG.org

@@ -1,5 +1,7 @@
 * Changelog
 ** Unreleased 8.0.1
+  * Added support for ~textDocument/linkedEditingRange~ via
+    ~lsp-iedit-linked-ranges~ and ~lsp-evil-multiedit-ranges~ (see [[https://github.com/emacs-lsp/lsp-mode/pull/3166][#3166]])
   * Add [[https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-cli#readme][GraphQL Language Server]] for autocomplete graphql query
   * Added ~lsp-auto-touch-files~. When it is non-nil it will auto-create the
     file on the disk before sending ~textDocument/didOpen~.

clients/lsp-xml.el

@@ -189,7 +189,7 @@ Newlines and excess whitespace are removed."
   ("xml.catalogs" lsp-xml-catalogs)
   ("xml.trace.server" lsp-xml-trace-server)))
 
-(defconst lsp-xml-jar-version "0.13.1")
+(defconst lsp-xml-jar-version "0.18.0")
 
 (defconst lsp-xml-jar-name (format "org.eclipse.lemminx-%s-uber.jar" lsp-xml-jar-version))
 

lsp-iedit.el

@@ -31,6 +31,7 @@
 (declare-function iedit-lib-start "iedit-lib" (mode-exit-func))
 (declare-function iedit-done "iedit" ())
 (declare-function evil-multiedit-state "evil-multiedit" ())
+(declare-function evil-iedit-state "evil-iedit-state" ())
 
 (defvar iedit-mode)
 (defvar iedit-auto-buffering)
@@ -64,6 +65,8 @@ from various lsp protocol requests, e.g.
     (message "%d occurrences of \"%s\""
              (seq-length ranges)
              (lsp--range-text (lsp-seq-first ranges)))))
+
+;; iedit
 
 ;;;###autoload
 (defun lsp-iedit-highlights ()
@@ -76,11 +79,26 @@ See also `lsp-enable-symbol-highlighting'."
   (let ((highlights (lsp-request "textDocument/documentHighlight"
                                  (lsp--text-document-position-params)))
         (-compare-fn (-lambda ((&Location :range (&Range :start l-start :end l-end))
-                                          (&Location :range (&Range :start r-start :end r-end)))
-                               (and (lsp--position-equal l-start r-start)
-                                    (lsp--position-equal l-end   r-end)))))
+                               (&Location :range (&Range :start r-start :end r-end)))
+                       (and (lsp--position-equal l-start r-start)
+                            (lsp--position-equal l-end   r-end)))))
     (lsp-iedit--on-ranges (mapcar #'lsp:document-highlight-range (-distinct highlights)))))
 
+;;;###autoload
+(defun lsp-iedit-linked-ranges ()
+  "Start an `iedit' for `textDocument/linkedEditingRange'"
+  (interactive)
+  (unless (lsp-feature? "textDocument/linkedEditingRange")
+    (user-error "`textDocument/linkedEditingRange' is not supported by current server"))
+
+  (-> (lsp-request "textDocument/linkedEditingRange" (lsp--text-document-position-params))
+      (lsp:linked-editing-ranges-ranges)
+      (or (user-error "No editing ranges found"))
+      (lsp-iedit--on-ranges)))
+
+
+;; evil-multi-edit
+
 ;;;###autoload
 (defun lsp-evil-multiedit-highlights ()
   "Start an `evil-multiedit' operation on the documentHighlights at point.
@@ -95,6 +113,36 @@ See also `lsp-enable-symbol-highlighting'."
   (lsp-iedit-highlights)
   (evil-multiedit-state))
 
+;;;###autoload
+(defun lsp-evil-multiedit-linked-ranges ()
+  "Start an `evil-multiedit' for `textDocument/linkedEditingRange'"
+  (interactive)
+  (require 'evil-multiedit)
+  (when (fboundp 'ahs-clear) (ahs-clear))
+  (setq evil-multiedit--dont-recall t)
+  (lsp-iedit-linked-ranges)
+  (evil-multiedit-state))
+
+;; evil-evil-state
+
+;;;###autoload
+(defun lsp-evil-state-highlights ()
+  "Start `iedit-mode'. for `textDocument/documentHighlight'"
+  (interactive "P")
+  (if (fboundp 'ahs-clear) (ahs-clear))
+  (lsp-iedit-highlights)
+  (evil-iedit-state))
+
+;;;###autoload
+(defun lsp-evil-state-linked-ranges ()
+  "Start `iedit-mode'. for `textDocument/linkedEditingRange'"
+  (interactive "P")
+  (if (fboundp 'ahs-clear) (ahs-clear))
+  (lsp-iedit-linked-ranges)
+  (evil-iedit-state))
+
+
+
 (lsp-consistency-check lsp-iedit)
 
 (provide 'lsp-iedit)

lsp-mode.el

@@ -835,6 +835,7 @@ directory")
     ("textDocument/formatting" :capability :documentFormattingProvider)
     ("textDocument/hover" :capability :hoverProvider)
     ("textDocument/implementation" :capability :implementationProvider)
+    ("textDocument/linkedEditingRange" :capability :linkedEditingRangeProvider)
     ("textDocument/onTypeFormatting" :capability :documentOnTypeFormattingProvider)
     ("textDocument/prepareRename"
      :check-command (lambda (workspace)
@@ -3451,8 +3452,7 @@ disappearing, unset all the variables related to it."
                       (publishDiagnostics . ((relatedInformation . t)
                                              (tagSupport . ((valueSet . [1 2])))
                                              (versionSupport . t)))
-                      (moniker . nil)
-                      (linkedEditingRange . nil)))
+                      (linkedEditingRange . ((dynamicRegistration . t)))))
      (window . ((workDoneProgress . t)
                 (showMessage . nil)
                 (showDocument . nil))))

lsp-protocol.el

@@ -604,6 +604,7 @@ See `-let' for a description of the destructuring mechanism."
  (FormattingOptions (:tabSize :insertSpaces) (:trimTrailingWhitespace :insertFinalNewline :trimFinalNewlines))
  (HoverCapabilities nil (:contentFormat :dynamicRegistration))
  (ImplementationCapabilities nil (:dynamicRegistration :linkSupport))
+ (LinkedEditingRanges (:ranges) (:wordPattern))
  (Location (:range :uri) nil)
  (MarkedString (:language :value) nil)
  (MarkupContent (:kind :value) nil)