spacemacs/layers/+spacemacs/spacemacs-defaults/packages.el
Keith Pinson b2a18301fa [defaults] Disable line numbers with SPC t n n
Toggles are great and all, but the trouble with the various toggles for line
numbers is that they force you to remember and think about the fact that there
are variant forms of line numbers. To beginners or forgetful people the various
combinations of behavior can be unintuitive here (e.g. toggling off relative
line numbers does nothing if you are actual in visual line numbers mode). Though
it doesn't fit exactly into the normal stuff we have for toggles, due to the
complexity of this situation I think it is good to just have a way to say "line
numbers be gone!"

Wasn't sure what keybinding to use, so used a double-tap mnemonic.

If this PR gets rejected, there are a couple minor fixes that should probably be
pulled out and submitted separately.
2021-07-30 16:57:27 +02:00

593 lines
23 KiB
EmacsLisp

;;; packages.el --- Spacemacs Defaults Layer packages File
;;
;; Copyright (c) 2012-2021 Sylvain Benner & Contributors
;;
;; Author: Sylvain Benner <sylvain.benner@gmail.com>
;; URL: https://github.com/syl20bnr/spacemacs
;;
;; This file is not part of GNU Emacs.
;;
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
(setq spacemacs-defaults-packages
'(
(abbrev :location built-in)
(archive-mode :location built-in)
(bookmark :location built-in)
(buffer-menu :location built-in)
(conf-mode :location built-in)
(cus-edit :location built-in
:toggle (or (eq 'vim dotspacemacs-editing-style)
(eq 'hybrid dotspacemacs-editing-style)))
(dired :location built-in)
(dired-x :location built-in)
(image-dired :location built-in)
(display-line-numbers :location built-in
:toggle (version<= "26" emacs-version))
(electric-indent-mode :location built-in)
(ediff :location built-in)
(eldoc :location built-in)
(help-fns+ :location local)
(hi-lock :location built-in)
(image-mode :location built-in)
(imenu :location built-in)
(occur-mode :location built-in)
(package-menu :location built-in)
;; page-break-lines is shipped with spacemacs core
(page-break-lines :location built-in)
(process-menu :location built-in)
quickrun
(recentf :location built-in)
(savehist :location built-in)
(saveplace :location built-in)
(subword :location built-in)
(tar-mode :location built-in)
(uniquify :location built-in)
(url :location built-in)
(visual-line-mode :location built-in)
(whitespace :location built-in)
(winner :location built-in)
(xref :location built-in)
(zone :location built-in)))
;; Initialization of packages
(defun spacemacs-defaults/init-abbrev ()
(spacemacs|hide-lighter abbrev-mode))
(defun spacemacs-defaults/init-archive-mode ()
(evilified-state-evilify-map archive-mode-map
:mode archive-mode
:eval-after-load archive-mode))
(defun spacemacs-defaults/init-buffer-menu ()
(with-eval-after-load 'evil-collection
(add-to-list
'spacemacs-evil-collection-allowed-list '(buff-menu "buff-menu"))))
(defun spacemacs-defaults/init-bookmark ()
(use-package bookmark
:defer t
:init
(progn
(setq bookmark-default-file (concat spacemacs-cache-directory "bookmarks")
;; autosave each change
bookmark-save-flag 1)
(spacemacs/set-leader-keys "fb" 'bookmark-jump))))
(defun spacemacs-defaults/init-conf-mode ()
:init
;; explicitly derive conf-mode from text-mode major-mode
(add-hook 'conf-mode-hook 'spacemacs/run-text-mode-hooks))
(defun spacemacs-defaults/init-cus-edit ()
;; Arguably a Vim user's first expectation for such a buffer would be a kind
;; of normal mode; besides, `evilified' conflicts with text insertion for
;; search.
(evil-set-initial-state 'Custom-mode 'normal)
;; Notes on how this effects the default `custom-mode-map':
;; - `TAB' works as `widget-forward' without modification
;; - `<S-TAB>' works as `widget-backward' without modification
;; - `n' as `widget-forward' is redundant with `TAB' and collides with the
;; - `evil-ex-search-next' mapping which is useful here. Omitting
;; intensionally.
;; - `p' doesn't make any sense without `n' and is redundant with `<S-TAB>'.
;; Omitting intensionally.
;; - `q' as `Custom-buffer-done' conflicts with the Evil record macro
;; binding, which is, however, of questionable value in a Custom buffer;
;; and there is precedent in many other Spacemacs contexts to bind it to
;; quit actions rather than default evil one; choosing to restore.
;; - `SPC' as `scroll-up-command' conflicts with the all-important Spacemacs
;; menu. Omitting intensionally. Evil `C-u' works instead.
;; - `S-SPC' as `scroll-down-command' makes no sense without `SPC' as
;; `scroll-up-command'. Evil `C-d' works instead.
;; - `C-x' as a prefix command still works.
;; - `C-c' as a prefix command still works.
;; - `u' as `Custom-goto-parent' conflicts with Evil undo. However it is
;; questionable whether this will work properly in a Custom buffer;
;; choosing to restore this binding.
(evil-define-key 'normal custom-mode-map (kbd "q") 'Custom-buffer-done)
(evil-define-key 'normal custom-mode-map (kbd "u") 'Custom-goto-parent)
;; `RET' does not work well in the search field. Fix:
(evil-define-key '(insert normal) custom-mode-map (kbd "RET") 'spacemacs/custom-newline)
;; There is a separate map for links, oddly enough. Separate it from the
;; `custom-mode-map' bindings, which is its parent by default.
(set-keymap-parent custom-mode-link-map nil)
;; Evil doesn't seem to be properly in control of what is going on in these
;; widget-induced keymaps, so just use base bindings to sort this out
(define-key custom-mode-link-map (kbd "q") 'Custom-buffer-done)
(define-key custom-mode-link-map (kbd "u") 'Custom-goto-parent))
(defun spacemacs-defaults/init-dired ()
(spacemacs/set-leader-keys
"ad" 'spacemacs/dired
"fj" 'dired-jump
"jd" 'dired-jump
"jD" 'dired-jump-other-window)
;; The search next/previous commands are different
;; because of the `evil-search-module' values:
;; vim = evil-search, hybrid = isearch
(when (eq 'vim dotspacemacs-editing-style)
(evil-define-key 'normal dired-mode-map (kbd "n") 'evil-ex-search-next)
(evil-define-key 'normal dired-mode-map (kbd "N") 'evil-ex-search-previous))
(when (eq 'hybrid dotspacemacs-editing-style)
(evil-define-key 'normal dired-mode-map (kbd "n") 'evil-search-next)
(evil-define-key 'normal dired-mode-map (kbd "N") 'evil-search-previous)))
(defun spacemacs-defaults/init-dired-x ()
(use-package dired-x
:commands (dired-jump
dired-jump-other-window
dired-omit-mode)))
(defun spacemacs-defaults/init-image-dired ()
(use-package image-dired
:defer t
:config
(evilified-state-evilify-map image-dired-thumbnail-mode-map
:mode image-dired-thumbnail-mode
:bindings
"j" 'image-dired-next-line
"k" 'image-dired-previous-line
"l" 'image-dired-forward-image
"h" 'image-dired-backward-image)
(evilified-state-evilify-map image-dired-display-image-mode-map
:mode image-dired-display-image-mode)))
(defun spacemacs-defaults/init-electric-indent-mode ()
(electric-indent-mode))
(defun spacemacs-defaults/init-visual-line-mode ()
(spacemacs|diminish visual-line-mode "" " L"))
;; notes from mijoharas
;; We currently just set a few variables to make it look nicer.
;; Here is my first attempt at evilifying the buffer, does not work correctly, help is very much welcome.
;; ```
;; (defun ediff/setup-ediff-keymaps ()
;; "setup the evil ediff keymap"
;; (progn
;; (add-to-list 'evil-emacs-state-modes 'Ediff)
;; (evilified-state-evilify ediff-mode-map)
;; (spacemacs/activate-evil-leader-for-map 'ediff-mode-map)
;; )
;; )
;; ;; inside the use-package function
;; (add-hook 'ediff-keymap-setup-hook 'ediff/setup-ediff-keymaps)
;; ```
(defun spacemacs-defaults/init-ediff ()
(use-package ediff
:defer t
:init
(progn
;; first we set some sane defaults
(setq-default
ediff-window-setup-function 'ediff-setup-windows-plain
;; emacs is evil and decrees that vertical shall henceforth be horizontal
ediff-split-window-function 'split-window-horizontally
ediff-merge-split-window-function 'split-window-horizontally)
;; show org ediffs unfolded
(require 'outline)
(add-hook 'ediff-prepare-buffer-hook #'show-all)
;; restore window layout when done
(add-hook 'ediff-quit-hook #'winner-undo))))
(defun spacemacs-defaults/init-eldoc ()
(use-package eldoc
:defer (spacemacs/defer)
:init (spacemacs|require-when-dumping 'eldoc)
:config
(progn
;; enable eldoc in `eval-expression'
(add-hook 'eval-expression-minibuffer-setup-hook #'eldoc-mode)
;; enable eldoc in IELM
(add-hook 'ielm-mode-hook #'eldoc-mode)
;; don't display eldoc on modeline
(spacemacs|hide-lighter eldoc-mode)
;; eldoc-message-commands
(eldoc-add-command #'evil-insert)
(eldoc-add-command #'evil-insert-line)
(eldoc-add-command #'evil-append)
(eldoc-add-command #'evil-append-line)
(eldoc-add-command #'evil-force-normal-state))))
(defun spacemacs-defaults/init-help-fns+ ()
(use-package help-fns+
:commands (describe-keymap)
:init (spacemacs/set-leader-keys "hdK" 'describe-keymap)))
(defun spacemacs-defaults/init-hi-lock ()
(with-eval-after-load 'hi-lock
(spacemacs|hide-lighter hi-lock-mode)))
(defun spacemacs-defaults/init-image-mode ()
(use-package image-mode
:defer t
:init
(progn
(setq image-animate-loop t)
(spacemacs/declare-prefix-for-mode 'image-mode "ma" "animate")
(spacemacs/declare-prefix-for-mode 'image-mode "mg" "goto file")
(spacemacs/declare-prefix-for-mode 'image-mode "mt" "transform/resize")
(spacemacs/set-leader-keys-for-major-mode 'image-mode
"aa" 'image-toggle-animation
"a+" 'image-increase-speed
"a-" 'image-decrease-speed
"ar" 'image-reset-speed
"gn" 'image-next-file
"gN" 'image-previous-file
"t+" 'image-increase-size
"t-" 'image-decrease-size
"tf" 'image-mode-fit-frame
"tr" 'image-transform-reset
"th" 'image-transform-fit-to-height
"tw" 'image-transform-fit-to-width
"ts" 'image-transform-set-scale
"tr" 'image-transform-rotation))
:config (evilified-state-evilify-map image-mode-map
:mode image-mode
:bindings
"h" 'image-backward-hscroll
"j" 'image-next-line
"k" 'image-previous-line
"l" 'image-forward-hscroll)))
(defun spacemacs-defaults/init-imenu ()
(use-package imenu
:defer t
:init (spacemacs/set-leader-keys "ji" 'imenu)))
(defun spacemacs-defaults/init-display-line-numbers ()
(use-package display-line-numbers
:defer t
:init
(progn
(cond ((spacemacs/visual-line-numbers-p)
(setq display-line-numbers-type 'visual))
((spacemacs/relative-line-numbers-p)
(setq display-line-numbers-type 'relative))
(t
(setq display-line-numbers-type t)))
(spacemacs/declare-prefix "tn" "line-numbers")
(spacemacs|add-toggle line-numbers
:status (and (featurep 'display-line-numbers)
display-line-numbers-mode
(eq display-line-numbers dotspacemacs-line-numbers))
:on (prog1 (display-line-numbers-mode)
(setq display-line-numbers dotspacemacs-line-numbers))
:off (display-line-numbers-mode -1)
:on-message "Line numbers enabled per dotspacemacs-line-numbers."
:off-message "Line numbers disabled."
:documentation "Show line numbers as configured in .spacemacs."
:evil-leader "tnn")
(spacemacs|add-toggle absolute-line-numbers
:status (and (featurep 'display-line-numbers)
display-line-numbers-mode
(eq display-line-numbers t))
:on (prog1 (display-line-numbers-mode)
(setq display-line-numbers t))
:off (display-line-numbers-mode -1)
:on-message "Absolute line numbers enabled."
:off-message "Line numbers disabled."
:documentation "Show absolute line numbers."
:evil-leader "tna")
(spacemacs|add-toggle relative-line-numbers
:status (and (featurep 'display-line-numbers)
display-line-numbers-mode
(eq display-line-numbers 'relative))
:on (prog1 (display-line-numbers-mode)
(setq display-line-numbers 'relative))
:off (display-line-numbers-mode -1)
:documentation "Show relative line numbers."
:on-message "Relative line numbers enabled."
:off-message "Line numbers disabled."
:evil-leader "tnr")
(spacemacs|add-toggle visual-line-numbers
:status (and (featurep 'display-line-numbers)
display-line-numbers-mode
(eq display-line-numbers 'visual))
:on (prog1 (display-line-numbers-mode)
(setq display-line-numbers 'visual))
:off (display-line-numbers-mode -1)
:documentation "Show relative visual line numbers."
:on-message "Visual line numbers enabled."
:off-message "Line numbers disabled."
:evil-leader "tnv")
(when (spacemacs//linum-backward-compabitility)
(add-hook 'prog-mode-hook 'display-line-numbers-mode)
(add-hook 'text-mode-hook 'display-line-numbers-mode))
;; it's ok to add an advice before the function is defined, and we must
;; add this advice before calling `global-display-line-numbers-mode'
(advice-add #'display-line-numbers--turn-on :around #'spacemacs//linum-on)
(when dotspacemacs-line-numbers
;; delay the initialization of number lines when opening Spacemacs
;; normally. If opened via the command line with a file to visit then
;; load it immediately
(add-hook 'emacs-startup-hook
(lambda ()
(if (string-equal "*scratch*" (buffer-name))
(spacemacs|add-transient-hook window-configuration-change-hook
(lambda ()
(global-display-line-numbers-mode))
lazy-loading-line-numbers)
(global-display-line-numbers-mode))))))))
(defun spacemacs-defaults/init-linum ()
(use-package linum
:init
(progn
(setq linum-format "%4d")
(spacemacs|add-toggle line-numbers
:mode linum-mode
:documentation "Show the line numbers."
:evil-leader "tn")
(advice-add #'linum-update-window
:after #'spacemacs//linum-update-window-scale-fix)
(advice-add #'linum-on
:around #'spacemacs//linum-on))
:config
(progn
(when (spacemacs//linum-backward-compabitility)
(add-hook 'prog-mode-hook 'linum-mode)
(add-hook 'text-mode-hook 'linum-mode))
(when dotspacemacs-line-numbers
(global-linum-mode)))))
(defun spacemacs-defaults/init-occur-mode ()
(evilified-state-evilify-map occur-mode-map
:mode occur-mode))
(defun spacemacs-defaults/init-package-menu ()
(evilified-state-evilify-map package-menu-mode-map
:mode package-menu-mode))
(defun spacemacs-defaults/init-page-break-lines ()
(require 'page-break-lines)
(global-page-break-lines-mode t)
(spacemacs|hide-lighter page-break-lines-mode))
(defun spacemacs-defaults/init-process-menu ()
(evilified-state-evilify process-menu-mode process-menu-mode-map))
(defun spacemacs-defaults/init-quickrun ()
(use-package quickrun
:defer t
:init
(setq quickrun-focus-p nil)
(spacemacs/set-leader-keys
"xx" 'spacemacs/quickrun)))
(defun spacemacs-defaults/init-recentf ()
(use-package recentf
:defer (spacemacs/defer)
:commands (recentf-save-list)
:init
(progn
(spacemacs|require-when-dumping 'recentf)
(when (spacemacs/defer)
(add-hook 'find-file-hook (lambda () (unless recentf-mode
(recentf-mode)
(recentf-track-opened-file)))))
(setq recentf-save-file (concat spacemacs-cache-directory "recentf")
recentf-max-saved-items 1000
recentf-auto-cleanup 'never
recentf-auto-save-timer (run-with-idle-timer 600 t
'recentf-save-list)))
:config
(progn
(add-to-list 'recentf-exclude
(recentf-expand-file-name spacemacs-cache-directory))
(add-to-list 'recentf-exclude (recentf-expand-file-name package-user-dir))
(add-to-list 'recentf-exclude "COMMIT_EDITMSG\\'")
(when custom-file
(add-to-list 'recentf-exclude custom-file)))))
(defun spacemacs-defaults/init-savehist ()
(use-package savehist
:init
(progn
;; Minibuffer history
(setq savehist-file (concat spacemacs-cache-directory "savehist")
enable-recursive-minibuffers t ; Allow commands in minibuffers
history-length 1000
savehist-additional-variables '(mark-ring
global-mark-ring
search-ring
regexp-search-ring
extended-command-history
kill-ring)
savehist-autosave-interval 60)
(savehist-mode t))))
(defun spacemacs-defaults/init-saveplace ()
(use-package saveplace
:init
(progn
(if (fboundp 'save-place-mode)
;; Emacs 25 has a proper mode for `save-place'
(save-place-mode)
(setq save-place t))
;; Save point position between sessions
(setq save-place-file (concat spacemacs-cache-directory "places")))))
(defun spacemacs-defaults/init-subword ()
(use-package subword
:defer t
:init
(progn
(unless (category-docstring ?U)
(define-category ?U "Uppercase")
(define-category ?u "Lowercase"))
(modify-category-entry (cons ?A ?Z) ?U)
(modify-category-entry (cons ?a ?z) ?u)
(make-variable-buffer-local 'evil-cjk-word-separating-categories)
(defun spacemacs//subword-enable-camel-case ()
"Add support for camel case to subword."
(if subword-mode
(push '(?u . ?U) evil-cjk-word-separating-categories)
(setq evil-cjk-word-separating-categories
(default-value 'evil-cjk-word-separating-categories))))
(add-hook 'subword-mode-hook 'spacemacs//subword-enable-camel-case)
(spacemacs|add-toggle camel-case-motion
:mode subword-mode
:documentation "Toggle CamelCase motions."
:evil-leader "tc")
(spacemacs|add-toggle camel-case-motion-globally
:mode global-subword-mode
:documentation "Globally toggle CamelCase motions."
:evil-leader "t C-c"))
:config
(spacemacs|diminish subword-mode "" " c")))
(defun spacemacs-defaults/init-tar-mode ()
(evilified-state-evilify-map tar-mode-map
:mode tar-mode
:eval-after-load tar-mode))
(defun spacemacs-defaults/init-uniquify ()
(require 'uniquify)
;; When having windows with repeated filenames, uniquify them
;; by the folder they are in rather those annoying <2>,<3>,.. etc
(setq uniquify-buffer-name-style 'post-forward-angle-brackets
;; don't screw special buffers
uniquify-ignore-buffers-re "^\\*"))
(defun spacemacs-defaults/init-url ()
;; gravatars from magit use this to store their cache
(setq url-configuration-directory (concat spacemacs-cache-directory "url/")))
(defun spacemacs-defaults/init-whitespace ()
(use-package whitespace
:defer t
:init
(progn
(when dotspacemacs-show-trailing-whitespace
(set-face-attribute
'trailing-whitespace nil
:background (face-attribute 'font-lock-comment-face :foreground)))
(add-hook 'prog-mode-hook 'spacemacs//trailing-whitespace)
(spacemacs|add-toggle whitespace
:mode whitespace-mode
:documentation "Display whitespace."
:evil-leader "tw")
(spacemacs|add-toggle whitespace-globally
:mode global-whitespace-mode
:documentation "Display whitespace globally."
:evil-leader "t C-w")
(add-hook 'diff-mode-hook 'whitespace-mode)
(add-hook 'diff-mode-hook 'spacemacs//set-whitespace-style-for-diff))
:config
(progn
(set-face-attribute 'whitespace-space nil
:background nil
:foreground (face-attribute 'font-lock-warning-face
:foreground))
(set-face-attribute 'whitespace-tab nil
:background nil)
(set-face-attribute 'whitespace-indentation nil
:background nil)
(spacemacs|diminish whitespace-mode "" " w")
(spacemacs|diminish global-whitespace-mode "" " w"))))
(defun spacemacs-defaults/init-winner ()
(use-package winner
:commands (winner-undo winner-redo)
:init
(with-eval-after-load 'winner
(setq spacemacs/winner-boring-buffers '("*Completions*"
"*Compile-Log*"
"*inferior-lisp*"
"*Fuzzy Completions*"
"*Apropos*"
"*Help*"
"*cvs*"
"*Buffer List*"
"*Ibuffer*"
"*esh command on file*"))
(setq winner-boring-buffers
(append winner-boring-buffers spacemacs/winner-boring-buffers)))))
(defun spacemacs-defaults/init-xref ()
(evilified-state-evilify-map xref--xref-buffer-mode-map
:mode xref--xref-buffer-mode
:eval-after-load xref))
(defun spacemacs-defaults/init-zone ()
(use-package zone
:commands (zone zone-when-idle)
:init
(progn
(when (and dotspacemacs-zone-out-when-idle
(numberp dotspacemacs-zone-out-when-idle))
(zone-when-idle dotspacemacs-zone-out-when-idle))
;; remove not interesting programs
(setq zone-programs [
;; zone-pgm-jitter
zone-pgm-putz-with-case
zone-pgm-dissolve
;; zone-pgm-explode
zone-pgm-whack-chars
zone-pgm-rotate
zone-pgm-rotate-LR-lockstep
zone-pgm-rotate-RL-lockstep
zone-pgm-rotate-LR-variable
zone-pgm-rotate-RL-variable
zone-pgm-drip
;; zone-pgm-drip-fretfully
;; zone-pgm-five-oclock-swan-dive
;; zone-pgm-martini-swan-dive
zone-pgm-rat-race
zone-pgm-paragraph-spaz])
;; zone-pgm-stress
;; zone-pgm-stress-destress
;; zone-pgm-random-life
(spacemacs/set-leader-keys "TZ" 'zone))
:config
;; be sure to disable running zone if the user does not want it
(unless dotspacemacs-zone-out-when-idle
(zone-leave-me-alone))))