commit 74f45d3992307806fd5d7545f72b1d5e338b11f4
parent df78c23aedcf9d4ee324662612f0d1d7545daac1
Author: Lukas Henkel <lh@entf.net>
Date: Fri, 22 Apr 2022 21:33:10 +0200
consult-eglot from melpa
Diffstat:
5 files changed, 246 insertions(+), 211 deletions(-)
diff --git a/elpa/consult-eglot-20220409.1238/consult-eglot-autoloads.el b/elpa/consult-eglot-20220409.1238/consult-eglot-autoloads.el
@@ -0,0 +1,25 @@
+;;; consult-eglot-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*-
+;;
+;;; Code:
+
+(add-to-list 'load-path (directory-file-name
+ (or (file-name-directory #$) (car load-path))))
+
+
+;;;### (autoloads nil "consult-eglot" "consult-eglot.el" (0 0 0 0))
+;;; Generated autoloads from consult-eglot.el
+
+(autoload 'consult-eglot-symbols "consult-eglot" "\
+Interactively select a symbol from the current workspace." t nil)
+
+(register-definition-prefixes "consult-eglot" '("consult-eglot-"))
+
+;;;***
+
+;; Local Variables:
+;; version-control: never
+;; no-byte-compile: t
+;; no-update-autoloads: t
+;; coding: utf-8-emacs-unix
+;; End:
+;;; consult-eglot-autoloads.el ends here
diff --git a/elpa/consult-eglot-20220409.1238/consult-eglot-pkg.el b/elpa/consult-eglot-20220409.1238/consult-eglot-pkg.el
@@ -0,0 +1,2 @@
+;;; Generated package description from consult-eglot.el -*- no-byte-compile: t -*-
+(define-package "consult-eglot" "20220409.1238" "A consulting-read interface for eglot" '((emacs "27.1") (eglot "1.7") (consult "0.16") (project "0.3.0")) :commit "0da8801dd8435160ce1f62ad8066bd52e38f5cbd" :authors '(("mohsin kaleem" . "mohkale@kisara.moe")) :maintainer '("Mohsin Kaleem") :keywords '("tools" "completion" "lsp") :url "https://github.com/mohkale/consult-eglot")
diff --git a/elpa/consult-eglot-20220409.1238/consult-eglot.el b/elpa/consult-eglot-20220409.1238/consult-eglot.el
@@ -0,0 +1,218 @@
+;;; consult-eglot.el --- A consulting-read interface for eglot -*- lexical-binding: t; -*-
+
+;; Licence: MIT
+;; Keywords: tools, completion, lsp
+;; Package-Version: 20220409.1238
+;; Package-Commit: 0da8801dd8435160ce1f62ad8066bd52e38f5cbd
+;; Author: mohsin kaleem <mohkale@kisara.moe>
+;; Maintainer: Mohsin Kaleem
+;; Version: 0.2
+;; Package-Requires: ((emacs "27.1") (eglot "1.7") (consult "0.16") (project "0.3.0"))
+;; Homepage: https://github.com/mohkale/consult-eglot
+
+;; Copyright (c) 2021 Mohsin Kaleem
+
+;; Permission is hereby granted, free of charge, to any person obtaining a copy
+;; of this software and associated documentation files (the "Software"), to deal
+;; in the Software without restriction, including without limitation the rights
+;; to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+;; copies of the Software, and to permit persons to whom the Software is
+;; furnished to do so, subject to the following conditions:
+
+;; The above copyright notice and this permission notice shall be included in all
+;; copies or substantial portions of the Software.
+
+;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+;; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+;; SOFTWARE.
+
+;;; Commentary:
+
+;; Query workspace symbol from eglot using consult.
+;;
+;; This package provides a single command `consult-eglot-symbols' that uses the
+;; lsp workspace/symbol procedure to get a list of symbols exposed in the current
+;; workspace. This differs from the default document/symbols call, that eglot
+;; exposes through imenu, in that it can present symbols from multiple open files
+;; or even files not indirectly loaded by an open file but still used by your
+;; project.
+;;
+;; This code was partially adapted from the excellent consult-lsp package.
+
+;;; Code:
+
+(require 'eglot)
+(require 'consult)
+
+(defgroup consult-eglot nil
+ "Consulting-read for eglot."
+ :prefix "consult-eglot"
+ :group 'completion
+ :group 'eglot
+ :group 'consult)
+
+(defcustom consult-eglot-ignore-column nil
+ "When true `consult-eglot-symbols' only jumps to start of symbols line.
+Otherwise `consult-eglot-symbols' will go to the exact symbol of a matched
+candidate."
+ :type 'boolean)
+
+(defcustom consult-eglot-narrow
+ '(;; Lowercase classes
+ (?c . "Class")
+ (?f . "Function")
+ (?e . "Enum")
+ (?i . "Interface")
+ (?m . "Module")
+ (?n . "Namespace")
+ (?p . "Package")
+ (?s . "Struct")
+ (?t . "Type Parameter")
+ (?v . "Variable")
+
+ ;; Uppercase classes
+ (?A . "Array")
+ (?B . "Boolean")
+ (?C . "Constant")
+ (?E . "Enum Member")
+ (?F . "Field")
+ (?M . "Method")
+ (?N . "Number")
+ (?O . "Object")
+ (?P . "Property")
+ (?S . "String")
+
+ ;; Other. Any which aren't above are taken from here
+ (?o . "Other"))
+ "Narrow key configuration used with `consult-eglot-symbols'.
+For the format see `consult--read', for the value types see the
+values in `eglot--symbol-kind-names'."
+ :type '(alist :key-type character :value-type string))
+
+(defcustom consult-eglot-show-kind-name t
+ "When true prefix completion candidates with their type."
+ :type 'boolean)
+
+(defun consult-eglot--make-async-source (async server)
+ "Search for symbols in a consult ASYNC source.
+Pipe a `consult--read' compatible async-source ASYNC to search for
+symbols in the workspace tied to SERVER."
+ (lambda (action)
+ (pcase-exhaustive action
+ ((or 'setup (pred stringp))
+ (let ((query (if (stringp action) action "")))
+ (jsonrpc-async-request
+ server :workspace/symbol
+ `(:query ,query)
+ :success-fn
+ (lambda (resp)
+ (funcall async 'flush)
+ (funcall async (append resp nil)))
+ :error-fn
+ (eglot--lambda ((ResponseError) code message)
+ (message "%s: %s" code message))
+ :timeout-fn
+ (lambda ()
+ (message "error: request timed out")))
+ (funcall async action)))
+ (_ (funcall async action)))))
+
+(defun consult-eglot--transformer (symbol-info)
+ "Default transformer to produce a completion candidate from SYMBOL-INFO.
+The produced candidate follows the same form as `consult--grep' however it
+contains the SYMBOL-INFO as the second field instead of the file URI."
+ (eglot--dbind ((SymbolInformation) name kind location)
+ symbol-info
+ (eglot--dbind ((Location) uri range) location
+ (let* ((line (1+ (plist-get (plist-get range :start) :line)))
+ (kind-name (alist-get kind eglot--symbol-kind-names))
+ (uri-path (eglot--uri-to-path uri)))
+ (propertize
+ (concat
+ (when consult-eglot-show-kind-name
+ (format "%-7s " kind-name))
+ name
+ " "
+ (string-remove-suffix ":"
+ (consult--format-location
+ ;; If the src is relative to our project directory then use
+ ;; the path from there, otherwise use the absolute file path.
+ (let ((relative-uri-path (file-relative-name uri-path)))
+ (if (string-prefix-p ".." relative-uri-path)
+ (abbreviate-file-name uri-path)
+ relative-uri-path))
+ line)))
+ 'consult--type (or (car (rassoc kind-name consult-eglot-narrow))
+ (car (rassoc "Other" consult-eglot-narrow)))
+ 'consult--candidate symbol-info)))))
+
+(defun consult-eglot--symbol-information-to-grep-params (symbol-info)
+ "Extract grep parameters from SYMBOL-INFO."
+ (eglot--dbind ((SymbolInformation) location) symbol-info
+ (eglot--dbind ((Location) uri range) location
+ (list
+ (eglot--uri-to-path uri) ; URI
+ (1+ (plist-get (plist-get range :start) :line)) ; Line number
+ ; Column Number
+ (or
+ (and (not consult-eglot-ignore-column)
+ (plist-get (plist-get range :start) :character))
+ 0)))))
+
+(defun consult-eglot--state ()
+ "State function for `consult-eglot-symbols' to preview candidates.
+This is mostly just a copy-paste of `consult--grep-state' except it doesn't
+rely on regexp matching to extract the relevent file and column fields."
+ (let ((open (consult--temporary-files))
+ (jump (consult--jump-state)))
+ (lambda (action cand)
+ (when (eq action 'exit)
+ (funcall open)
+ (setq open nil))
+ (funcall jump
+ action
+ (and cand
+ (pcase-let
+ ((`(,file ,line ,col)
+ (consult-eglot--symbol-information-to-grep-params cand)))
+ (consult--position-marker
+ (funcall (or open #'find-file) file)
+ line col)))))))
+
+;;;###autoload
+(defun consult-eglot-symbols ()
+ "Interactively select a symbol from the current workspace."
+ (interactive)
+ ;; Set `default-directory' here so we can show file names
+ ;; relative to the project root.
+ (let* ((server (eglot--current-server-or-lose))
+ (default-directory (or (project-root (eglot--project server))
+ default-directory)))
+ (if (eglot--server-capable :workspaceSymbolProvider)
+ (progn
+ (consult--read
+ (thread-first
+ (consult--async-sink)
+ (consult--async-refresh-immediate)
+ (consult--async-map #'consult-eglot--transformer)
+ (consult-eglot--make-async-source server)
+ (consult--async-throttle)
+ (consult--async-split))
+ :history t
+ :require-match t
+ :prompt "LSP Symbols: "
+ :initial (consult--async-split-initial nil)
+ :category 'consult-lsp-symbols
+ :lookup #'consult--lookup-candidate
+ :group (consult--type-group consult-eglot-narrow)
+ :narrow (consult--type-narrow consult-eglot-narrow)
+ :state (consult-eglot--state))
+ (run-hooks 'consult-after-jump-hook))
+ (user-error "Server doesn't support symbol search"))))
+
+(provide 'consult-eglot)
+;;; consult-eglot.el ends here
diff --git a/init.el b/init.el
@@ -14,8 +14,6 @@
(require 'lh)
(require 'iso-transl)
-(with-eval-after-load 'eglot
- (require 'consult-eglot))
(with-eval-after-load 'paredit
(require 'paredit-menu))
(with-eval-after-load 'restclient
@@ -241,7 +239,7 @@
("melpa-stable" . "https://stable.melpa.org/packages/")
("melpa" . "https://melpa.org/packages/")))
'(package-selected-packages
- '(jq-mode multiple-cursors ob-restclient restclient vterm deadgrep helpful pdf-tools paredit-menu paredit corfu sly eglot aggressive-indent project nov nhexl-mode elfeed magit yaml-mode json-mode lua-mode go-mode geiser-guile geiser org-roam org-contrib org ace-window expand-region consult marginalia uuidgen request diminish which-key))
+ '(consult-eglot jq-mode multiple-cursors ob-restclient restclient vterm deadgrep helpful pdf-tools paredit-menu paredit corfu sly eglot aggressive-indent project nov nhexl-mode elfeed magit yaml-mode json-mode lua-mode go-mode geiser-guile geiser org-roam org-contrib org ace-window expand-region consult marginalia uuidgen request diminish which-key))
'(pcomplete-ignore-case t t)
'(pixel-scroll-precision-mode t)
'(read-buffer-completion-ignore-case t)
diff --git a/lisp/consult-eglot.el b/lisp/consult-eglot.el
@@ -1,208 +0,0 @@
-;;; consult-eglot.el --- A consulting-read interface for eglot -*- lexical-binding: t; -*-
-
-;; Licence: MIT
-;; Keywords: tools, completion, lsp
-;; Author: mohsin kaleem <mohkale@kisara.moe>
-;; Maintainer: Mohsin Kaleem
-;; Version: 0.1
-;; Package-Requires: ((emacs "27.1") (eglot "1.7") (consult "0.9"))
-;; Homepage: https://github.com/mohkale/consult-eglot
-
-;; Copyright (c) 2021 Mohsin Kaleem
-
-;; Permission is hereby granted, free of charge, to any person obtaining a copy
-;; of this software and associated documentation files (the "Software"), to deal
-;; in the Software without restriction, including without limitation the rights
-;; to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-;; copies of the Software, and to permit persons to whom the Software is
-;; furnished to do so, subject to the following conditions:
-
-;; The above copyright notice and this permission notice shall be included in all
-;; copies or substantial portions of the Software.
-
-;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-;; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-;; SOFTWARE.
-
-;;; Commentary:
-
-;; Query workspace symbol from eglot using consult.
-;;
-;; This package provides a single command `consult-eglot-symbols' that uses the
-;; lsp workspace/symbol procedure to get a list of symbols exposed in the current
-;; workspace. This differs from the default document/symbols call, that eglot
-;; exposes through imenu, in that it can present symbols from multiple open files
-;; or even files not indirectly loaded by an open file but still used by your
-;; project.
-;;
-;; This code was partially adapted from the excellent consult-lsp package.
-
-;;; Code:
-
-(require 'eglot)
-(require 'consult)
-
-(defgroup consult-eglot nil
- "Consulting-read for eglot."
- :prefix "consult-eglot"
- :group 'completion
- :group 'eglot
- :group 'consult)
-
-(defcustom consult-eglot-narrow
- '(;; Lowercase classes
- (?c . "Class")
- (?f . "Function")
- (?e . "Enum")
- (?i . "Interface")
- (?m . "Module")
- (?n . "Namespace")
- (?p . "Package")
- (?s . "Struct")
- (?t . "Type Parameter")
- (?v . "Variable")
-
- ;; Uppercase classes
- (?A . "Array")
- (?B . "Boolean")
- (?C . "Constant")
- (?E . "Enum Member")
- (?F . "Field")
- (?M . "Method")
- (?N . "Number")
- (?O . "Object")
- (?P . "Property")
- (?S . "String")
-
- ;; Other. Any which aren't above are taken from here
- (?o . "Other"))
- "Narrow key configuration used with `consult-eglot-symbols'.
-For the format see `consult--read', for the value types see the
-values in `eglot--symbol-kind-names'."
- :type '(alist :key-type character :value-type string))
-
-(defcustom consult-eglot-show-kind-name t
- "When true prefix completion candidates with their type."
- :type 'boolean)
-
-(defun consult-eglot--make-async-source (async server)
- "Search for symbols in a consult ASYNC source.
-Pipe a `consult--read' compatible async-source ASYNC to search for
-symbols in the workspace tied to SERVER."
- (lambda (action)
- (pcase-exhaustive action
- ((or 'setup (pred stringp))
- (let ((query (if (stringp action) action "")))
- (jsonrpc-async-request
- server :workspace/symbol
- `(:query ,query)
- :success-fn
- (lambda (resp)
- (funcall async 'flush)
- (funcall async (append resp nil)))
- :error-fn
- (eglot--lambda ((ResponseError) code message)
- (message "%s: %s" code message))
- :timeout-fn
- (lambda ()
- (message "error: request timed out")))
- (funcall async action)))
- (_ (funcall async action)))))
-
-(defun consult-eglot--transformer (symbol-info)
- "Default transformer to produce a completion candidate from SYMBOL-INFO.
-The produced candidate follows the same form as `consult--grep' however it
-contains the SYMBOL-INFO as the second field instead of the file URI."
- (eglot--dbind ((SymbolInformation) name kind location)
- symbol-info
- (eglot--dbind ((Location) uri range) location
- (let* ((line (1+ (plist-get (plist-get range :start) :line)))
- (kind-name (alist-get kind eglot--symbol-kind-names))
- (uri-path (eglot--uri-to-path uri))
- (res (propertize
- (concat
- (when consult-eglot-show-kind-name
- (format "%-7s " kind-name))
- name
- " "
- (string-remove-suffix ":"
- (consult--format-location
- ;; If the src is relative to our project directory then use
- ;; the path from there, otherwise use the absolute file path.
- (let ((relative-uri-path (file-relative-name uri-path)))
- (if (string-prefix-p ".." relative-uri-path)
- (abbreviate-file-name uri-path)
- relative-uri-path))
- line)))
- 'consult--type (or (car (rassoc kind-name consult-eglot-narrow))
- (car (rassoc "Other" consult-eglot-narrow)))
- 'consult--candidate symbol-info)))
- res))))
-
-(defun consult-eglot--symbol-information-to-grep-params (symbol-info)
- "Extract grep parameters from SYMBOL-INFO."
- (eglot--dbind ((SymbolInformation) location) symbol-info
- (eglot--dbind ((Location) uri range) location
- (list
- (eglot--uri-to-path uri) ; URI
- (1+ (plist-get (plist-get range :start) :line)) ; Line number
- 0 ; Column number
- ))))
-
-(defun consult-eglot--state ()
- "State function for `consult-eglot-symbols' to preview candidates.
-This is mostly just a copy-paste of `consult--grep-state' except it doesn't
-rely on regexp matching to extract the relevent file and column fields."
- (let ((open (consult--temporary-files))
- (jump (consult--jump-state)))
- (lambda (cand restore)
- (when restore
- (funcall open))
- (funcall jump
- (and cand
- (pcase-let ((`(,file ,line ,col)
- (consult-eglot--symbol-information-to-grep-params cand)))
- (consult--position-marker (funcall open file) line col)))
- restore))))
-
-;;;###autoload
-(defun consult-eglot-symbols ()
- "Interactively select a symbol from the current workspace."
- (interactive)
- ;; Set `default-directory' here so we can show file names
- ;; relative to the project root.
- (let* ((server (eglot--current-server-or-lose))
- (default-directory (or (project-root (project-current))
- default-directory)))
- (if (eglot--server-capable :workspaceSymbolProvider)
- (cl-destructuring-bind (path line _col)
- (consult-eglot--symbol-information-to-grep-params
- (consult--read
- (thread-first
- (consult--async-sink)
- (consult--async-refresh-immediate)
- (consult--async-map #'consult-eglot--transformer)
- (consult-eglot--make-async-source server)
- (consult--async-throttle)
- (consult--async-split))
- :history t
- :require-match t
- :prompt "LSP Symbols: "
- :initial (consult--async-split-initial nil)
- :category 'consult-lsp-symbols
- :lookup #'consult--lookup-candidate
- :group (consult--type-group consult-eglot-narrow)
- :narrow (consult--type-narrow consult-eglot-narrow)
- :state (consult-eglot--state)))
- (find-file path)
- (goto-char (point-min))
- (forward-line (- line 1))
- (run-hooks 'consult-after-jump-hook))
- (user-error "Server doesn't support symbol search"))))
-
-(provide 'consult-eglot)
-;;; consult-eglot.el ends here
