More Elisp linting
This should cover most of the remaining linting errors. After this, I expect fewer than ten linting errors.
This commit is contained in:
parent
a638e15c0d
commit
fb5ec068dd
47 changed files with 1049 additions and 989 deletions
|
|
@ -1,5 +1,9 @@
|
|||
;;; buffer.el --- Working with Emacs buffers -*- lexical-binding: t -*-
|
||||
;;; buffer.el --- Working with buffers -*- lexical-binding: t -*-
|
||||
|
||||
;; Author: William Carroll <wpcarro@gmail.com>
|
||||
;; Version: 0.0.1
|
||||
;; URL: https://git.wpcarro.dev/wpcarro/briefcase
|
||||
;; Package-Requires: ((emacs "24.3"))
|
||||
|
||||
;;; Commentary:
|
||||
;; Utilities for CRUDing buffers in Emacs.
|
||||
|
|
@ -33,14 +37,14 @@
|
|||
;; Library
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
(defconst buffer/enable-tests? t
|
||||
(defconst buffer-enable-tests? t
|
||||
"When t, run the test suite.")
|
||||
|
||||
(defconst buffer/install-kbds? t
|
||||
(defconst buffer-install-kbds? t
|
||||
"When t, install the keybindings defined herein.")
|
||||
|
||||
(defconst buffer/source-code-blacklist
|
||||
(set/new 'dired-mode
|
||||
(defconst buffer-source-code-blacklist
|
||||
(set-new 'dired-mode
|
||||
'erc-mode
|
||||
'vterm-mode
|
||||
'magit-status-mode
|
||||
|
|
@ -51,140 +55,140 @@
|
|||
'fundamental-mode)
|
||||
"A blacklist of major-modes to ignore for listing source code buffers.")
|
||||
|
||||
(defconst buffer/source-code-timeout 2
|
||||
(defconst buffer-source-code-timeout 2
|
||||
"Number of seconds to wait before invalidating the cycle.")
|
||||
|
||||
(cl-defstruct source-code-cycle cycle last-called)
|
||||
|
||||
(defun buffer/emacs-generated? (name)
|
||||
(defun buffer-emacs-generated? (name)
|
||||
"Return t if buffer, NAME, is an Emacs-generated buffer.
|
||||
Some buffers are Emacs-generated but are surrounded by whitespace."
|
||||
(let ((trimmed (s-trim name)))
|
||||
(and (s-starts-with? "*" trimmed))))
|
||||
|
||||
(defun buffer/find (buffer-or-name)
|
||||
(defun buffer-find (buffer-or-name)
|
||||
"Find a buffer by its BUFFER-OR-NAME."
|
||||
(get-buffer buffer-or-name))
|
||||
|
||||
(defun buffer/major-mode (name)
|
||||
(defun buffer-major-mode (name)
|
||||
"Return the active `major-mode' in buffer, NAME."
|
||||
(with-current-buffer (buffer/find name)
|
||||
(with-current-buffer (buffer-find name)
|
||||
major-mode))
|
||||
|
||||
(defun buffer/source-code-buffers ()
|
||||
(defun buffer-source-code-buffers ()
|
||||
"Return a list of source code buffers.
|
||||
This will ignore Emacs-generated buffers, like *Messages*. It will also ignore
|
||||
any buffer whose major mode is defined in `buffer/source-code-blacklist'."
|
||||
any buffer whose major mode is defined in `buffer-source-code-blacklist'."
|
||||
(->> (buffer-list)
|
||||
(list/map #'buffer-name)
|
||||
(list/reject #'buffer/emacs-generated?)
|
||||
(list/reject (lambda (name)
|
||||
(set/contains? (buffer/major-mode name)
|
||||
buffer/source-code-blacklist)))))
|
||||
(list-map #'buffer-name)
|
||||
(list-reject #'buffer-emacs-generated?)
|
||||
(list-reject (lambda (name)
|
||||
(set-contains? (buffer-major-mode name)
|
||||
buffer-source-code-blacklist)))))
|
||||
|
||||
(defvar buffer/source-code-cycle-state
|
||||
(defvar buffer-source-code-cycle-state
|
||||
(make-source-code-cycle
|
||||
:cycle (cycle/from-list (buffer/source-code-buffers))
|
||||
:cycle (cycle-from-list (buffer-source-code-buffers))
|
||||
:last-called (ts-now))
|
||||
"State used to manage cycling between source code buffers.")
|
||||
|
||||
(defun buffer/exists? (name)
|
||||
(defun buffer-exists? (name)
|
||||
"Return t if buffer, NAME, exists."
|
||||
(maybe-some? (buffer/find name)))
|
||||
(maybe-some? (buffer-find name)))
|
||||
|
||||
(defun buffer/new (name)
|
||||
(defun buffer-new (name)
|
||||
"Return a newly created buffer NAME."
|
||||
(generate-new-buffer name))
|
||||
|
||||
(defun buffer/find-or-create (name)
|
||||
(defun buffer-find-or-create (name)
|
||||
"Find or create buffer, NAME.
|
||||
Return a reference to that buffer."
|
||||
(let ((x (buffer/find name)))
|
||||
(let ((x (buffer-find name)))
|
||||
(if (maybe-some? x)
|
||||
x
|
||||
(buffer/new name))))
|
||||
(buffer-new name))))
|
||||
|
||||
;; TODO: Should this consume: `display-buffer' or `switch-to-buffer'?
|
||||
(defun buffer/show (buffer-or-name)
|
||||
(defun buffer-show (buffer-or-name)
|
||||
"Display the BUFFER-OR-NAME, which is either a buffer reference or its name."
|
||||
(display-buffer buffer-or-name))
|
||||
|
||||
;; TODO: Move this and `buffer/cycle-prev' into a separate module that
|
||||
;; TODO: Move this and `buffer-cycle-prev' into a separate module that
|
||||
;; encapsulates all of this behavior.
|
||||
|
||||
(defun buffer/cycle (cycle-fn)
|
||||
"Cycle forwards or backwards through `buffer/source-code-buffers'."
|
||||
(defun buffer-cycle (cycle-fn)
|
||||
"Cycle forwards or backwards through `buffer-source-code-buffers'."
|
||||
(let ((last-called (source-code-cycle-last-called
|
||||
buffer/source-code-cycle-state))
|
||||
buffer-source-code-cycle-state))
|
||||
(cycle (source-code-cycle-cycle
|
||||
buffer/source-code-cycle-state)))
|
||||
buffer-source-code-cycle-state)))
|
||||
(if (> (ts-diff (ts-now) last-called)
|
||||
buffer/source-code-timeout)
|
||||
buffer-source-code-timeout)
|
||||
(progn
|
||||
(struct-set! source-code-cycle
|
||||
cycle
|
||||
(cycle/from-list (buffer/source-code-buffers))
|
||||
buffer/source-code-cycle-state)
|
||||
(cycle-from-list (buffer-source-code-buffers))
|
||||
buffer-source-code-cycle-state)
|
||||
(let ((cycle (source-code-cycle-cycle
|
||||
buffer/source-code-cycle-state)))
|
||||
buffer-source-code-cycle-state)))
|
||||
(funcall cycle-fn cycle)
|
||||
(switch-to-buffer (cycle/current cycle)))
|
||||
(switch-to-buffer (cycle-current cycle)))
|
||||
(struct-set! source-code-cycle
|
||||
last-called
|
||||
(ts-now)
|
||||
buffer/source-code-cycle-state))
|
||||
buffer-source-code-cycle-state))
|
||||
(progn
|
||||
(funcall cycle-fn cycle)
|
||||
(switch-to-buffer (cycle/current cycle))))))
|
||||
(switch-to-buffer (cycle-current cycle))))))
|
||||
|
||||
(defun buffer/cycle-next ()
|
||||
"Cycle forward through the `buffer/source-code-buffers'."
|
||||
(defun buffer-cycle-next ()
|
||||
"Cycle forward through the `buffer-source-code-buffers'."
|
||||
(interactive)
|
||||
(buffer/cycle #'cycle/next))
|
||||
(buffer-cycle #'cycle-next))
|
||||
|
||||
(defun buffer/cycle-prev ()
|
||||
"Cycle backward through the `buffer/source-code-buffers'."
|
||||
(defun buffer-cycle-prev ()
|
||||
"Cycle backward through the `buffer-source-code-buffers'."
|
||||
(interactive)
|
||||
(buffer/cycle #'cycle/prev))
|
||||
(buffer-cycle #'cycle-prev))
|
||||
|
||||
(defun buffer/ivy-source-code ()
|
||||
(defun buffer-ivy-source-code ()
|
||||
"Use `ivy-read' to choose among all open source code buffers."
|
||||
(interactive)
|
||||
(ivy-read "Source code buffer: "
|
||||
(-drop 1 (buffer/source-code-buffers))
|
||||
(-drop 1 (buffer-source-code-buffers))
|
||||
:sort nil
|
||||
:action #'switch-to-buffer))
|
||||
|
||||
(defun buffer/show-previous ()
|
||||
(defun buffer-show-previous ()
|
||||
"Call `switch-to-buffer' on the previously visited buffer.
|
||||
This function ignores Emacs-generated buffers, i.e. the ones that look like
|
||||
this: *Buffer*. It also ignores buffers that are `dired-mode' or `erc-mode'.
|
||||
This blacklist can easily be changed."
|
||||
(interactive)
|
||||
(let* ((xs (buffer/source-code-buffers))
|
||||
(candidate (list/get 1 xs)))
|
||||
(let* ((xs (buffer-source-code-buffers))
|
||||
(candidate (list-get 1 xs)))
|
||||
(prelude-assert (maybe-some? candidate))
|
||||
(switch-to-buffer candidate)))
|
||||
|
||||
(when buffer/install-kbds?
|
||||
(when buffer-install-kbds?
|
||||
(general-define-key
|
||||
:states '(normal)
|
||||
"C-f" #'buffer/cycle-next
|
||||
"C-b" #'buffer/cycle-prev)
|
||||
"C-f" #'buffer-cycle-next
|
||||
"C-b" #'buffer-cycle-prev)
|
||||
(general-define-key
|
||||
:prefix "<SPC>"
|
||||
:states '(normal)
|
||||
"b" #'buffer/ivy-source-code
|
||||
"<SPC>" #'buffer/show-previous
|
||||
"b" #'buffer-ivy-source-code
|
||||
"<SPC>" #'buffer-show-previous
|
||||
"k" #'kill-buffer))
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
;; Tests
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
(when buffer/enable-tests?
|
||||
(when buffer-enable-tests?
|
||||
(prelude-assert
|
||||
(list/all? #'buffer/emacs-generated?
|
||||
(list-all? #'buffer-emacs-generated?
|
||||
'("*scratch*"
|
||||
"*Messages*"
|
||||
"*shell*"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue