feature/lookup: rewrite dash docset integration
+ Uses alist variable to store config, rather than hooks + Added check for installed docsets in +lookup/documentation + Set docsets for various language modules (c-mode, c++-mode, css-mode, scss-mode, sass-mode, web-mode, go-mode, racket-mode, emacs-lisp-mode, js2-mode, rjsx-mode, typescript-mode, rust-mode, and php-mode) + Made *eww* popups for dash docsets larger + Renamed set-docset! => set-docsets! (set-docset! is aliased to set-docsets!) + New +lookup/install-docset alias
This commit is contained in:
parent
2df2622329
commit
fd8f8c5108
13 changed files with 119 additions and 35 deletions
|
@ -1,16 +1,16 @@
|
|||
;;; feature/lookup/autoload/docsets.el -*- lexical-binding: t; -*-
|
||||
;;;###if (featurep! +docsets)
|
||||
|
||||
(defvar-local helm-dash-docsets nil
|
||||
"Docsets to use for this buffer.")
|
||||
(defvar +lookup-docset-alist nil
|
||||
"An alist mapping major and minor modes to lists of Dash docsets.
|
||||
|
||||
(defvar-local counsel-dash-docsets nil
|
||||
"Docsets to use for this buffer.")
|
||||
Entries are added by `set-docsets!' and used by `+lookup-docsets-for-buffer' to
|
||||
assemble a list of installed & active docsets.")
|
||||
|
||||
;;;###autodef
|
||||
(defun set-docset! (modes &rest docsets)
|
||||
(defun set-docsets! (modes &rest docsets)
|
||||
"Registers a list of DOCSETS (strings) for MODES (either one major/minor mode
|
||||
symbol or a list of them).
|
||||
symbol or a list of them). DOCSETS can also contain sublists.
|
||||
|
||||
If MODES is a minor mode, you can use :add or :remove as the first element of
|
||||
DOCSETS, to instruct it to append (or remove) those from the docsets already set
|
||||
|
@ -19,29 +19,82 @@ by a major-mode, if any.
|
|||
Used by `+lookup/in-docsets' and `+lookup/documentation'."
|
||||
(declare (indent defun))
|
||||
(dolist (mode (doom-enlist modes))
|
||||
(let ((fn (intern (format "+lookup|init-docsets--%s" mode)))
|
||||
(hook (intern (format "%s-hook" mode))))
|
||||
(cond ((null (car-safe docsets))
|
||||
(remove-hook hook fn)
|
||||
(unintern fn nil))
|
||||
((fset fn
|
||||
(lambda ()
|
||||
(let ((var-sym (if (featurep! :completion ivy)
|
||||
'counsel-dash-docsets
|
||||
'helm-dash-docsets)))
|
||||
(set var-sym
|
||||
(append (symbol-value var-sym)
|
||||
docsets)))))
|
||||
(add-hook hook fn))))))
|
||||
(if (null docsets)
|
||||
(setq +lookup-docset-alist
|
||||
(delq (assq mode +lookup-docset-alist)
|
||||
+lookup-docset-alist)))
|
||||
(setf (alist-get mode +lookup-docset-alist)
|
||||
(mapcan #'doom-enlist docsets))))
|
||||
|
||||
;;;###autodef
|
||||
(defalias 'set-docset! #'set-docsets!)
|
||||
|
||||
;; FIXME obsolete :docset
|
||||
;;;###autoload
|
||||
(def-setting! :docset (modes &rest docsets)
|
||||
:obsolete set-docset!
|
||||
`(set-docset! ,modes ,@docsets))
|
||||
`(set-docsets! ,modes ,@docsets))
|
||||
|
||||
|
||||
;;
|
||||
;; Library
|
||||
;;
|
||||
|
||||
;;;###autoload
|
||||
(defun +lookup-docsets-for-buffer ()
|
||||
"Return list of installed & selected docsets for the current major mode.
|
||||
|
||||
This list is built from `+lookup-docset-alist'."
|
||||
(let ((base-docsets (cdr (assq major-mode +lookup-docset-alist))))
|
||||
(dolist (spec +lookup-docset-alist)
|
||||
(cl-destructuring-bind (mode . docsets) spec
|
||||
(when (and (boundp mode) (symbol-value mode))
|
||||
(pcase (car docsets)
|
||||
(:add (nconc base-docsets (cdr docsets)))
|
||||
(:remove
|
||||
(dolist (docset (cdr docsets))
|
||||
(setq base-docsets (delete docset base-docsets))))
|
||||
(_ (setq base-docsets docsets))))))
|
||||
base-docsets))
|
||||
|
||||
;;;###autoload
|
||||
(defun +lookup-docset-installed-p (docset)
|
||||
"Return t if DOCSET is installed."
|
||||
(let ((path (helm-dash-docsets-path)))
|
||||
(file-directory-p
|
||||
(expand-file-name (format "%s.docset" docset)
|
||||
path))))
|
||||
|
||||
;;;###autoload
|
||||
(autoload 'helm-dash-installed-docsets "helm-dash")
|
||||
|
||||
;;;###autoload
|
||||
(autoload 'helm-dash-docset-installed-p "helm-dash")
|
||||
|
||||
|
||||
;;
|
||||
;; Commands
|
||||
;;
|
||||
|
||||
;;;###autoload
|
||||
(defalias '+lookup/install-docset #'helm-dash-install-docset)
|
||||
|
||||
(defvar counsel-dash-docsets)
|
||||
(defvar helm-dash-docsets)
|
||||
;;;###autoload
|
||||
(defun +lookup/in-docsets (&optional query docsets)
|
||||
"Lookup QUERY in dash DOCSETS.
|
||||
|
||||
QUERY is a string and docsets in an array of strings, each a name of a Dash
|
||||
docset. Requires either helm or ivy.
|
||||
|
||||
Use `+lookup/install-docset' to install docsets."
|
||||
(interactive)
|
||||
(let* ((counsel-dash-docsets (or docsets (+lookup-docsets-for-buffer)))
|
||||
(helm-dash-docsets counsel-dash-docsets)
|
||||
(query (or query (+lookup--symbol-or-region) "")))
|
||||
(cond ((featurep! :completion helm)
|
||||
(helm-dash query))
|
||||
((featurep! :completion ivy)
|
||||
(counsel-dash query))
|
||||
((user-error "No dash backend is installed, enable ivy or helm.")))))
|
||||
|
|
|
@ -63,6 +63,10 @@ properties:
|
|||
`(set-lookup-handlers! ,modes ,@plist))
|
||||
|
||||
|
||||
;;
|
||||
;; Library
|
||||
;;
|
||||
|
||||
;; Helpers
|
||||
(defun +lookup--online-provider (&optional force-p namespace)
|
||||
(let ((key (or namespace major-mode)))
|
||||
|
@ -201,17 +205,18 @@ Goes down a list of possible backends:
|
|||
3. Fall back to an online search, with `+lookup/online'"
|
||||
(interactive
|
||||
(list (+lookup--symbol-or-region)))
|
||||
(cond ((and +lookup-documentation-functions
|
||||
(cond ((null identifier) (user-error "Nothing under point"))
|
||||
|
||||
((and +lookup-documentation-functions
|
||||
(+lookup--jump-to :documentation identifier)))
|
||||
|
||||
((and (featurep! +docsets)
|
||||
(or (require 'counsel-dash nil t)
|
||||
(require 'helm-dash nil t))
|
||||
(or (bound-and-true-p counsel-dash-docsets)
|
||||
(bound-and-true-p helm-dash-docsets))
|
||||
;; counsel-dash uses helm-dash under the hood
|
||||
(helm-dash-installed-docsets))
|
||||
(+lookup/in-docsets identifier))
|
||||
(let ((docsets (+lookup-docsets-for-buffer)))
|
||||
(when (cl-some #'+lookup-docset-installed-p docsets)
|
||||
(+lookup/in-docsets identifier docsets)
|
||||
t))))
|
||||
|
||||
((+lookup/online
|
||||
identifier
|
||||
|
|
|
@ -120,8 +120,8 @@ argument: the identifier at point.")
|
|||
|
||||
;; Both packages depend on helm-dash, for now
|
||||
(def-package! helm-dash
|
||||
:defer t
|
||||
:when (featurep! +docsets)
|
||||
:defer t
|
||||
:init
|
||||
(setq helm-dash-enable-debugging doom-debug-mode
|
||||
helm-dash-browser-func #'eww)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue