Move inlay hints implementation in core (#3970)

Author: yyoncho

CHANGELOG.org

@@ -72,6 +72,9 @@
   * Add [[https://github.com/charliermarsh/ruff-lsp][ruff-lsp]] support (additional server for Python).
   * Update documentation of Vue3 install server
   * Add GLSL support.
+  * Move inlay hint support in core from ~lsp-rust~ and ~lsp-javascript~. Use
+    ~lsp-inlay-hint-enable~ instead of ~lsp-rust-analyzer-server-display-inlay-hints~ and
+    ~lsp-javascript-server-display-inlay-hints~
 ** Release 8.0.0
   * Add ~lsp-clients-angular-node-get-prefix-command~ to get the Angular server from another location which is still has ~/lib/node_modules~ in it.
   * Set ~lsp-clients-angular-language-server-command~ after the first connection to speed up subsequent connections.

clients/lsp-javascript.el

@@ -599,50 +599,12 @@ TypeScript 3.0 or newer in the workspace."
   :type 'boolean
   :package-version '(lsp-mode . "6.1"))
 
-;; inlay hints
-
-(defface lsp-javascript-inlay-face
-  '((t :inherit font-lock-comment-face))
-  "The face to use for the JavaScript inlays."
-  :group 'lsp-javascript
-  :package-version '(lsp-mode . "8.0.1"))
-
-(defface lsp-javascript-inlay-type-face
-  '((t :inherit lsp-javascript-inlay-face))
-  "Face for inlay type hints (e.g. inferred variable types)."
-  :group 'lsp-javascript
-  :package-version '(lsp-mode . "8.0.1"))
-
-(defcustom lsp-javascript-inlay-type-format ": %s"
-  "Format string for variable inlays (part of the inlay face)."
-  :type '(string :tag "String")
-  :group 'lsp-javascript
-  :package-version '(lsp-mode . "8.0.1"))
-
-(defface lsp-javascript-inlay-parameter-face
-  '((t :inherit lsp-javascript-inlay-face))
-  "Face for inlay parameter hints (e.g. function parameter names at
-call-site)."
-  :group 'lsp-javascript
-  :package-version '(lsp-mode . "8.0.1"))
-
-(defcustom lsp-javascript-inlay-param-format "%s:"
-  "Format string for parameter inlays (part of the inlay face)."
-  :type '(string :tag "String")
-  :group 'lsp-javascript
-  :package-version '(lsp-mode . "8.0.1"))
-
 (defcustom lsp-typescript-surveys-enabled t
   "Enabled/disable occasional surveys that help us improve VS
 Code's JavaScript and TypeScript support."
   :type 'boolean
   :package-version '(lsp-mode . "6.1"))
 
-(defcustom lsp-javascript-display-inlay-hints nil
-  "Whether to display inlay hints."
-  :type 'boolean
-  :package-version '(lsp-mode . "8.0.1"))
-
 (defcustom lsp-javascript-display-enum-member-value-hints nil
   "Show inlay hints for enum member values."
   :type 'boolean
@@ -681,11 +643,6 @@ name (e.g. `data' variable passed as `data' parameter)."
   :type 'boolean
   :package-version '(lsp-mode . "8.0.1"))
 
-(defcustom lsp-javascript-update-inlay-hints-on-scroll t
-  "Update inlay hints immediately when scrolling or modifying window sizes."
-  :type 'boolean
-  :package-version '(lsp-mode . "8.0.1"))
-
 (defcustom lsp-javascript-completions-complete-function-calls t
   "Complete function calls."
   :type 'boolean
@@ -829,75 +786,10 @@ name (e.g. `data' variable passed as `data' parameter)."
       (lsp)
       (lsp--info "Renamed '%s' to '%s'." name (file-name-nondirectory new)))))
 
-(defun lsp-javascript-update-inlay-hints-scroll-function (window start)
-  (lsp-javascript--update-inlay-hints start (window-end window t)))
-
-(defun lsp-javascript-update-inlay-hints ()
-  (lsp-javascript--update-inlay-hints (window-start) (window-end nil t)))
-
-(defun lsp-javascript--update-inlay-hints (start end)
-  (if (lsp-javascript-initialized?)
-      (lsp-request-async
-       "textDocument/inlayHint"
-       (lsp-make-javascript-inlay-hints-params
-        :text-document (lsp--text-document-identifier)
-        :range (lsp-make-range :start
-                               (lsp-point-to-position start)
-                               :end
-                               (lsp-point-to-position end)))
-       (lambda (res)
-         (lsp--remove-overlays 'lsp-javascript-inlay-hint)
-         (dolist (hint res)
-           (-let* (((&javascript:InlayHint :label :position :kind :padding-left? :padding-right?) hint)
-                   (pos (lsp--position-to-point position))
-                   (overlay (make-overlay pos pos nil 'front-advance 'end-advance)))
-              (when (stringp label)
-                (overlay-put overlay 'lsp-javascript-inlay-hint t)
-                (overlay-put overlay 'before-string
-                             (format "%s%s%s"
-                                     (if padding-left? " " "")
-                                     (propertize (lsp-javascript-format-inlay label kind)
-                                                 'font-lock-face (lsp-javascript-face-for-inlay kind))
-                                     (if padding-right? " " "")))))))
-       :mode 'tick)))
-
-(defun lsp-javascript-column-at-pos (pos)
-  (save-excursion
-    (goto-char pos)
-    (current-column)))
-
-(defun lsp-javascript-format-inlay (text kind)
-  (cond
-   ((eql kind lsp/javascript-inlay-hint-kind-type-hint) (format lsp-javascript-inlay-type-format text))
-   ((eql kind lsp/javascript-inlay-hint-kind-parameter-hint) (format lsp-javascript-inlay-param-format text))
-   ;; ((eql kind lsp/javascript-inlay-hint-kind-enum-hint) (format lsp-javascript-inlay-enum-format text))
-   (t text)))
-
-(defun lsp-javascript-face-for-inlay (kind)
-  (cond
-   ((eql kind lsp/javascript-inlay-hint-kind-type-hint) 'lsp-javascript-inlay-type-face)
-   ((eql kind lsp/javascript-inlay-hint-kind-parameter-hint) 'lsp-javascript-inlay-parameter-face)
-   (t 'lsp-javascript-inlay-face)))
-
 (defun lsp-javascript-initialized? ()
   (when-let ((workspace (lsp-find-workspace 'ts-ls (buffer-file-name))))
     (eq 'initialized (lsp--workspace-status workspace))))
 
-(define-minor-mode lsp-javascript-inlay-hints-mode
-  "Mode for displaying inlay hints."
-  :lighter nil
-  (cond
-   (lsp-javascript-inlay-hints-mode
-    (lsp-javascript-update-inlay-hints)
-    (add-hook 'lsp-on-idle-hook #'lsp-javascript-update-inlay-hints nil t)
-    (when lsp-javascript-update-inlay-hints-on-scroll
-      (add-to-list (make-local-variable 'window-scroll-functions) #'lsp-javascript-update-inlay-hints-scroll-function)))
-   (t
-    (lsp--remove-overlays 'lsp-javascript-inlay-hint)
-    (remove-hook 'lsp-on-idle-hook #'lsp-javascript-update-inlay-hints t)
-    (when lsp-javascript-update-inlay-hints-on-scroll
-      (setf window-scroll-functions (delete #'lsp-javascript-update-inlay-hints-scroll-function window-scroll-functions))))))
-
 (defun lsp-clients-typescript-project-ts-server-path ()
   (f-join (lsp-workspace-root) "node_modules" "typescript" "lib" "tsserver.js"))
 
@@ -946,9 +838,6 @@ name (e.g. `data' variable passed as `data' parameter)."
                                           (format-enable (or lsp-javascript-format-enable lsp-typescript-format-enable)))
                                       (lsp:set-server-capabilities-document-formatting-provider? caps format-enable)
                                       (lsp:set-server-capabilities-document-range-formatting-provider? caps format-enable)))
-                  :after-open-fn (lambda ()
-                                   (when lsp-javascript-display-inlay-hints
-                                     (lsp-javascript-inlay-hints-mode)))
                   :ignore-messages '("readFile .*? requested by TypeScript but content not available")
                   :server-id 'ts-ls
                   :request-handlers (ht ("_typescript.rename" #'lsp-javascript--rename))

clients/lsp-rust.el

@@ -378,12 +378,6 @@ to a closure.ppOnly applies to closures with blocks, same as
   :group 'lsp-rust-analyzer
   :package-version '(lsp-mode . "8.0.1"))
 
-(defcustom lsp-rust-analyzer-server-display-inlay-hints nil
-  "Show inlay hints."
-  :type 'boolean
-  :group 'lsp-rust-analyzer
-  :package-version '(lsp-mode . "6.2"))
-
 (defcustom lsp-rust-analyzer-max-inlay-hint-length nil
   "Max inlay hint length."
   :type 'integer
@@ -783,7 +777,7 @@ or JSON objects in `rust-project.json` format."
                  :parameterHints ,(lsp-json-bool lsp-rust-analyzer-display-parameter-hints)
                  :reborrowHints ,lsp-rust-analyzer-display-reborrow-hints
                  :renderColons ,(lsp-json-bool lsp-rust-analyzer-server-format-inlay-hints)
-                 :typeHints (:enable ,(lsp-json-bool lsp-rust-analyzer-server-display-inlay-hints)
+                 :typeHints (:enable ,(lsp-json-bool lsp-inlay-hint-enable)
                              :hideClosureInitialization ,(lsp-json-bool lsp-rust-analyzer-hide-closure-initialization)
                              :hideNamedConstructor ,(lsp-json-bool lsp-rust-analyzer-hide-named-constructor)))
     :completion (:addCallParenthesis ,(lsp-json-bool lsp-rust-analyzer-completion-add-call-parenthesis)
@@ -1233,9 +1227,7 @@ tokens legend."
     ("public" . ,lsp-rust-analyzer-public-modifier)
     ("reference" . ,lsp-rust-analyzer-reference-modifier)
     ("trait" . ,lsp-rust-analyzer-trait-modifier)
-    ("unsafe" . ,lsp-rust-analyzer-unsafe-modifier)
-    ))
-
+    ("unsafe" . ,lsp-rust-analyzer-unsafe-modifier)))
 
 (lsp-register-client
  (make-lsp-client
@@ -1255,14 +1247,9 @@ tokens legend."
                        ("rust-analyzer.showReferences" #'lsp-rust--analyzer-show-references)
                        ("rust-analyzer.triggerParameterHints" #'lsp--action-trigger-parameter-hints))
   :library-folders-fn (lambda (_workspace) lsp-rust-analyzer-library-directories)
-  :after-open-fn (lambda ()
-                   (when lsp-rust-analyzer-server-display-inlay-hints
-                     (lsp-rust-analyzer-inlay-hints-mode)))
-  :ignore-messages nil
-
   :semantic-tokens-faces-overrides `(:discard-default-modifiers t
-                                     :modifiers
-                                     ,(lsp-rust-analyzer--semantic-modifiers))
+                                                                :modifiers
+                                                                ,(lsp-rust-analyzer--semantic-modifiers))
   :server-id 'rust-analyzer
   :custom-capabilities `((experimental . ((snippetTextEdit . ,(and lsp-enable-snippet (featurep 'yasnippet))))))
   :download-server-fn (lambda (_client callback error-callback _update?)
@@ -1282,42 +1269,6 @@ tokens legend."
 
 ;; inlay hints
 
-(defvar-local lsp-rust-analyzer-inlay-hints-timer nil)
-
-(defface lsp-rust-analyzer-inlay-face
-  '((t :inherit font-lock-comment-face))
-  "The face to use for the Rust Analyzer inlays."
-  :group 'lsp-rust-analyzer
-  :package-version '(lsp-mode . "7.0"))
-
-(defface lsp-rust-analyzer-inlay-type-face
-  '((t :inherit lsp-rust-analyzer-inlay-face))
-  "Face for inlay type hints (e.g. inferred variable types)."
-  :group 'lsp-rust-analyzer
-  :package-version '(lsp-mode . "8.0.0"))
-
-(defcustom lsp-rust-analyzer-inlay-type-format ": %s"
-  "Format string for variable inlays (part of the inlay face,
-used only if lsp-rust-analyzer-server-format-inlay-hints is
-non-nil)."
-  :type '(string :tag "String")
-  :group 'lsp-rust-analyzer
-  :package-version '(lsp-mode . "8.0.0"))
-
-(defface lsp-rust-analyzer-inlay-param-face
-  '((t :inherit lsp-rust-analyzer-inlay-face))
-  "Face for inlay parameter hints (e.g. function parameter names at call-site)."
-  :group 'lsp-rust-analyzer
-  :package-version '(lsp-mode . "8.0.0"))
-
-(defcustom lsp-rust-analyzer-inlay-param-format "%s:"
-  "Format string for parameter inlays (part of the inlay face,
-used only if lsp-rust-analyzer-server-format-inlay-hints is
-non-nil)."
-  :type '(string :tag "String")
-  :group 'lsp-rust-analyzer
-  :package-version '(lsp-mode . "8.0.0"))
-
 (defcustom lsp-rust-analyzer-debug-lens-extra-dap-args
   '(:MIMode "gdb" :miDebuggerPath "gdb" :stopAtEntry t :externalConsole :json-false)
   "Extra arguments to pass to DAP template when debugging a test from code lens.
@@ -1331,85 +1282,10 @@ meaning."
   :group 'lsp-rust-analyzer
   :package-version '(lsp-mode . "8.0.0"))
 
-(defvar lsp-rust-analyzer-already-warned-about-inlay-hint-type nil)
-
-(defun lsp-rust-analyzer-update-inlay-hints (buffer)
-  (if (and (lsp-rust-analyzer-initialized?)
-           (eq buffer (current-buffer)))
-      (lsp-request-async
-       "textDocument/inlayHint"
-       (lsp-make-rust-analyzer-inlay-hints-params
-        :text-document (lsp--text-document-identifier)
-        :range (if (use-region-p)
-                   (lsp--region-to-range (region-beginning) (region-end))
-                 (lsp--region-to-range (point-min) (point-max))))
-       (lambda (res)
-         (remove-overlays (point-min) (point-max) 'lsp-rust-analyzer-inlay-hint t)
-         (dolist (hint res)
-           (-let* (((&rust-analyzer:InlayHint :position :label :kind :padding-left :padding-right) hint)
-                   (pos (lsp--position-to-point position))
-                   (overlay (make-overlay pos pos nil 'front-advance 'end-advance)))
-             (let ((concat-label
-                    (cl-typecase label
-                      (vector
-                       (string-join
-                        (mapcar
-                         (lambda (label)
-                           (when (lsp-structure-p label)
-                             (lsp-get label :value)))
-                         label)))
-                      (string
-                       label)
-                      (t
-                       (unless lsp-rust-analyzer-already-warned-about-inlay-hint-type
-                         (message "Unexpected type for inlay hint: %s" (type-of label))
-                         (setq lsp-rust-analyzer-already-warned-about-inlay-hint-type t))
-                       ""))))
-               (overlay-put overlay 'lsp-rust-analyzer-inlay-hint t)
-               (overlay-put overlay 'before-string
-                            (format "%s%s%s"
-                                    (if padding-left " " "")
-                                    (propertize (lsp-rust-analyzer-format-inlay concat-label kind)
-                                                'font-lock-face (lsp-rust-analyzer-face-for-inlay kind))
-                                    (if padding-right " " "")))))))
-       :mode 'tick))
-  nil)
-
-(defun lsp-rust-analyzer-format-inlay (label kind)
-  (if lsp-rust-analyzer-server-format-inlay-hints
-      label
-    (cond
-     ((eql kind lsp/rust-analyzer-inlay-hint-kind-type-hint) (format lsp-rust-analyzer-inlay-type-format label))
-     ((eql kind lsp/rust-analyzer-inlay-hint-kind-param-hint) (format lsp-rust-analyzer-inlay-param-format label))
-     (t label))))
-
-(defun lsp-rust-analyzer-face-for-inlay (kind)
-  (cond
-   ((eql kind lsp/rust-analyzer-inlay-hint-kind-type-hint) 'lsp-rust-analyzer-inlay-type-face)
-   ((eql kind lsp/rust-analyzer-inlay-hint-kind-param-hint) 'lsp-rust-analyzer-inlay-param-face)
-   (t 'lsp-rust-analyzer-inlay-face)))
-
 (defun lsp-rust-analyzer-initialized? ()
   (when-let ((workspace (lsp-find-workspace 'rust-analyzer (buffer-file-name))))
     (eq 'initialized (lsp--workspace-status workspace))))
 
-(defun lsp-rust-analyzer-inlay-hints-change-handler (&rest _rest)
-  (when lsp-rust-analyzer-inlay-hints-timer
-    (cancel-timer lsp-rust-analyzer-inlay-hints-timer))
-  (setq lsp-rust-analyzer-inlay-hints-timer
-        (run-with-idle-timer 0.1 nil #'lsp-rust-analyzer-update-inlay-hints (current-buffer))))
-
-(define-minor-mode lsp-rust-analyzer-inlay-hints-mode
-  "Mode for displaying inlay hints."
-  :lighter nil
-  (cond
-   (lsp-rust-analyzer-inlay-hints-mode
-    (lsp-rust-analyzer-update-inlay-hints (current-buffer))
-    (add-hook 'lsp-on-change-hook #'lsp-rust-analyzer-inlay-hints-change-handler nil t))
-   (t
-    (remove-overlays (point-min) (point-max) 'lsp-rust-analyzer-inlay-hint t)
-    (remove-hook 'lsp-on-change-hook #'lsp-rust-analyzer-inlay-hints-change-handler t))))
-
 (defun lsp-rust-analyzer-expand-macro ()
   "Expands the macro call at point recursively."
   (interactive)