Minor improvement (#705)

* Clean up util

* clean up

* remove util

* fix

* Fix warning

* Fix compile

* fix

* cancel on push

* Add checkdoc and lint

* Don't lint

* checkdoc

* Fix install warn

Author: jcs090218

.github/workflows/test.yml

@@ -8,6 +8,10 @@ on:
     branches:
       - master
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     runs-on: ${{ matrix.os }}

Makefile

@@ -8,8 +8,8 @@ TEST-FILES := test/windows-bootstrap.el test/test-helper.el \
 LOAD-FILE = -l $(test-file)
 LOAD-TEST-FILES := $(foreach test-file, $(TEST-FILES), $(LOAD-FILE))
 
-# FIXME: add `test`
-ci: build compile clean
+# FIXME: add `test`, and `lint`
+ci: clean build compile checkdoc
 
 build:
 	$(EASK) package
@@ -25,6 +25,14 @@ test:
 	$(EASK) install-deps --dev
 	$(EASK) exec ert-runner -L . $(LOAD-TEST-FILES) -t '!no-win' -t '!org'
 
+checkdoc:
+	@echo "Run checkdoc..."
+	@$(EASK) checkdoc
+
+lint:
+	@echo "Run package-lint..."
+	@$(EASK) lint
+
 clean:
 	@$(EASK) clean-all
 

lsp-ui-doc.el

@@ -30,8 +30,6 @@
 
 ;;; Code:
 
-(require 'lsp-ui-util)
-
 (require 'lsp-protocol)
 (require 'lsp-mode)
 (require 'dash)
@@ -54,6 +52,9 @@
 (declare-function xwidget-webkit-execute-script-rv "ext:xwidget" (xwidget script &optional default))
 (declare-function xwidget-resize "ext:xwidget" (xwidget new-width new-height))
 
+(declare-function lsp-ui-kill-timer 'lsp-ui)
+(declare-function lsp-ui-delete-overlay 'lsp-ui)
+
 (defgroup lsp-ui-doc nil
   "Display informations of the current line."
   :group 'tools
@@ -64,7 +65,8 @@
 
 (defcustom lsp-ui-doc-enable t
   "Whether or not to enable lsp-ui-doc.
-Displays documentation of the symbol at point on hover. This only takes effect when a buffer is started."
+Displays documentation of the symbol at point on hover. This only takes effect
+when a buffer is started."
   :type 'boolean
   :group 'lsp-ui)
 
@@ -181,31 +183,31 @@ Only the `background' is used in this face."
   :group 'lsp-ui-doc)
 
 (defvar lsp-ui-doc-frame-parameters
-  '((left . -1)
-    (no-focus-on-map . t)
-    (min-width  . 0)
-    (width  . 0)
-    (min-height  . 0)
-    (height  . 0)
-    (internal-border-width . 1)
-    (vertical-scroll-bars . nil)
-    (horizontal-scroll-bars . nil)
-    (right-fringe . 0)
-    (menu-bar-lines . 0)
-    (tool-bar-lines . 0)
-    (tab-bar-lines . 0)
+  '((left                     . -1)
+    (no-focus-on-map          . t)
+    (min-width                . 0)
+    (width                    . 0)
+    (min-height               . 0)
+    (height                   . 0)
+    (internal-border-width    . 1)
+    (vertical-scroll-bars     . nil)
+    (horizontal-scroll-bars   . nil)
+    (right-fringe             . 0)
+    (menu-bar-lines           . 0)
+    (tool-bar-lines           . 0)
+    (tab-bar-lines            . 0)
     (tab-bar-lines-keep-state . 0)
-    (line-spacing . 0)
-    (unsplittable . t)
-    (undecorated . t)
-    (top . -1)
-    (visibility . nil)
-    (mouse-wheel-frame . nil)
-    (no-other-frame . t)
+    (line-spacing             . 0)
+    (unsplittable             . t)
+    (undecorated              . t)
+    (top                      . -1)
+    (visibility               . nil)
+    (mouse-wheel-frame        . nil)
+    (no-other-frame           . t)
     (inhibit-double-buffering . t)
-    (drag-internal-border . t)
-    (no-special-glyphs . t)
-    (desktop-dont-save . t))
+    (drag-internal-border     . t)
+    (no-special-glyphs        . t)
+    (desktop-dont-save        . t))
   "Frame parameters used to create the frame.")
 
 (defvar lsp-ui-doc-render-function nil
@@ -244,6 +246,8 @@ Because some variables are buffer local.")
 (defvar-local lsp-ui-doc--from-mouse-current nil
   "Non nil when the current call is triggered by a mouse event")
 
+(defvar-local lsp-ui-doc--unfocus-frame-timer nil)
+
 (defconst lsp-ui-doc--buffer-prefix " *lsp-ui-doc-")
 
 (defmacro lsp-ui-doc--with-buffer (&rest body)
@@ -422,8 +426,8 @@ We don't extract the string that `lps-line' is already displaying."
   "Hide the frame."
   (setq lsp-ui-doc--bounds nil
         lsp-ui-doc--from-mouse nil)
-  (lsp-ui-util-safe-delete-overlay lsp-ui-doc--inline-ov)
-  (lsp-ui-util-safe-delete-overlay lsp-ui-doc--highlight-ov)
+  (lsp-ui-delete-overlay lsp-ui-doc--inline-ov)
+  (lsp-ui-delete-overlay lsp-ui-doc--highlight-ov)
   (when-let ((frame (lsp-ui-doc--get-frame)))
     (when (frame-visible-p frame)
       (make-frame-invisible frame))))
@@ -889,15 +893,15 @@ HEIGHT is the documentation number of lines."
     (run-hook-with-args 'lsp-ui-doc-frame-hook frame window)
     (when lsp-ui-doc-use-webkit
       (define-key (current-global-map) [xwidget-event]
-        (lambda ()
-          (interactive)
-          (let ((xwidget-event-type (nth 1 last-input-event)))
-            ;; (when (eq xwidget-event-type 'load-changed)
-            ;;   (lsp-ui-doc--move-frame (lsp-ui-doc--get-frame)))
-            (when (eq xwidget-event-type 'javascript-callback)
-              (let ((proc (nth 3 last-input-event))
-                    (arg (nth 4 last-input-event)))
-                (funcall proc arg))))))
+                  (lambda ()
+                    (interactive)
+                    (let ((xwidget-event-type (nth 1 last-input-event)))
+                      ;; (when (eq xwidget-event-type 'load-changed)
+                      ;;   (lsp-ui-doc--move-frame (lsp-ui-doc--get-frame)))
+                      (when (eq xwidget-event-type 'javascript-callback)
+                        (let ((proc (nth 3 last-input-event))
+                              (arg (nth 4 last-input-event)))
+                          (funcall proc arg))))))
       (lsp-ui-doc--webkit-run-xwidget))
     frame))
 
@@ -920,7 +924,7 @@ HEIGHT is the documentation number of lines."
                          (and (looking-at "[[:graph:]]") (cons (point) (1+ (point))))))
         (unless (equal lsp-ui-doc--bounds bounds)
           (lsp-ui-doc--hide-frame)
-          (lsp-ui-util-safe-kill-timer lsp-ui-doc--timer)
+          (lsp-ui-kill-timer lsp-ui-doc--timer)
           (setq lsp-ui-doc--timer
                 (run-with-idle-timer
                  lsp-ui-doc-delay nil
@@ -1167,7 +1171,6 @@ It is supposed to be called from `lsp-ui--toggle'"
   (interactive)
   (lsp-ui-doc--hide-frame))
 
-(defvar-local lsp-ui-doc--unfocus-frame-timer nil)
 (defun lsp-ui-doc--glance-hide-frame ()
   "Hook to hide hover information popup for `lsp-ui-doc-glance'."
   (when (or (overlayp lsp-ui-doc--inline-ov)

lsp-ui-imenu.el

@@ -35,7 +35,8 @@
 
 (require 'lsp-mode)
 (require 'dash)
-(require 'lsp-ui-util)
+
+(declare-function lsp-ui-kill-timer 'lsp-ui)
 
 (defgroup lsp-ui-imenu nil
   "Display imenu entries."
@@ -379,7 +380,7 @@ ITEMS are used when the kind position is 'left."
 
 (defun lsp-ui-imenu--start-refresh (&rest _)
   "Starts the auto refresh timer."
-  (lsp-ui-util-safe-kill-timer lsp-ui-imenu--refresh-timer)
+  (lsp-ui-kill-timer lsp-ui-imenu--refresh-timer)
   (setq lsp-ui-imenu--refresh-timer
         (run-with-idle-timer lsp-ui-imenu-auto-refresh-delay nil #'lsp-ui-imenu--refresh)))
 

lsp-ui-peek.el

@@ -39,6 +39,8 @@
 (require 'xref)
 (require 'dash)
 
+(declare-function lsp-ui--mute-apply 'lsp-ui)
+
 (defgroup lsp-ui-peek nil
   "Improve version of xref with peek feature."
   :group 'tools
@@ -181,12 +183,12 @@ will cause performances issues.")
   (eval '(progn
            (evil-define-motion lsp-ui-peek-jump-backward (count)
                                (lsp-ui-peek--with-evil-jumps
-                                (evil--jump-backward count)
-                                (run-hooks 'xref-after-return-hook)))
+                                   (evil--jump-backward count)
+                                 (run-hooks 'xref-after-return-hook)))
            (evil-define-motion lsp-ui-peek-jump-forward (count)
                                (lsp-ui-peek--with-evil-jumps
-                                (evil--jump-forward count)
-                                (run-hooks 'xref-after-return-hook))))
+                                   (evil--jump-forward count)
+                                 (run-hooks 'xref-after-return-hook))))
         t))
 
 (defmacro lsp-ui-peek--prop (prop &optional string)
@@ -346,10 +348,8 @@ XREFS is a list of references/definitions."
   (with-temp-buffer
     (insert string)
     (delay-mode-hooks
-      (let ((inhibit-message t))
-        (funcall major))
-      (ignore-errors
-        (font-lock-ensure)))
+      (lsp-ui--mute-apply (funcall major))
+      (ignore-errors (font-lock-ensure)))
     (buffer-string)))
 
 (defun lsp-ui-peek--peek ()
@@ -635,7 +635,8 @@ EXTRA is a plist of extra parameters."
                            (append extra (lsp--text-document-position-params))))
 
 (defun lsp-ui-peek--extract-chunk-from-buffer (pos start end)
-  "Return the chunk of code pointed to by POS (a Position object) in the current buffer.
+  "Return the chunk of code pointed to by POS (a Position object) in the current
+buffer.
 START and END are delimiters."
   (let* ((point (lsp--position-to-point pos))
          (inhibit-field-text-motion t)

lsp-ui-sideline.el

@@ -30,7 +30,6 @@
 
 ;;; Code:
 
-(require 'lsp-ui-util)
 (require 'lsp-protocol)
 (require 'lsp-mode)
 (require 'flycheck nil 'noerror)
@@ -44,6 +43,8 @@
 (declare-function flycheck-error-format-message-and-id "ext:flycheck.el")
 (declare-function flycheck-error-level "ext:flycheck.el")
 
+(declare-function lsp-ui-line-number-display-width 'lsp-ui)
+
 (defgroup lsp-ui-sideline nil
   "Display information for the current line."
   :group 'tools
@@ -325,8 +326,8 @@ CURRENT is non-nil when the point is on the symbol."
      (propertize str 'display (lsp-ui-sideline--compute-height)))))
 
 (defun lsp-ui-sideline--check-duplicate (symbol info)
-  "Check if there's already a SYMBOL containing INFO, unless `lsp-ui-sideline-ignore-duplicate'
-is set to t."
+  "Check if there's already a SYMBOL containing INFO, unless
+`lsp-ui-sideline-ignore-duplicate' is set to t."
   (not (when lsp-ui-sideline-ignore-duplicate
          (--any (and (string= (overlay-get it 'symbol) symbol)
                      (string= (overlay-get it 'info) info))
@@ -349,7 +350,7 @@ is set to t."
      (if (< emacs-major-version 27)
          ;; This was necessary with emacs < 27, recent versions take
          ;; into account the display-line width with :align-to
-         (lsp-ui-util-line-number-display-width)
+         (lsp-ui-line-number-display-width)
        0)
      (if (or
           (bound-and-true-p whitespace-mode)
@@ -363,7 +364,7 @@ is set to t."
      (or (and (>= emacs-major-version 27)
               ;; We still need this number when calculating available space
               ;; even with emacs >= 27
-              (lsp-ui-util-line-number-display-width))
+              (lsp-ui-line-number-display-width))
          0)))
 
 (defun lsp-ui-sideline--valid-tag-p (tag mode)
@@ -435,7 +436,8 @@ is set to t."
           (lsp-ui-sideline--toggle-current ov nil))))))
 
 (defun lsp-ui-sideline--split-long-lines (lines)
-  "Fill LINES so that they are not longer than `lsp-ui-sideline-diagnostic-max-line-length' characters."
+  "Fill LINES so that they are not longer than
+`lsp-ui-sideline-diagnostic-max-line-length' characters."
   (cl-mapcan (lambda (line)
                (if (< (length line) lsp-ui-sideline-diagnostic-max-line-length)
                    (list line)
@@ -449,7 +451,8 @@ is set to t."
 (defun lsp-ui-sideline--diagnostics (buffer bol eol)
   "Show diagnostics belonging to the current line.
 Loop over flycheck errors with `flycheck-overlay-errors-in'.
-Find appropriate position for sideline overlays with `lsp-ui-sideline--find-line'.
+Find appropriate position for sideline overlays with
+`lsp-ui-sideline--find-line'.
 Push sideline overlays on `lsp-ui-sideline--ovs'."
   (when (and (bound-and-true-p flycheck-mode)
              (bound-and-true-p lsp-ui-sideline-mode)