emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/checkers/spell/config.el

225 lines
8 KiB
EmacsLisp
Raw Normal View History

Move :tools fly{check,spell} to :checkers {syntax,spell} These modules were renamed so we can later generalize their implementations, such as adding flymake support to the syntax checker.
2020-01-09 18:41:48 -05:00
;;; checkers/spell/config.el -*- lexical-binding: t; -*-
feature/{syntax-checker,spellcheck} -> tools/fly{check,spell}
2019-02-22 00:20:29 -05:00
checkers/spell: replace flyspell with spell-fu Spell-fu is significantly faster, but does produce more false positives (more faces must be added to spell-fu-faces-exclude to reduce these). Unfortunately, there is no fancy "correction" interface for spell-fu yet, so we'll have to resort to ispell-word (on z=) for now.
2020-08-21 02:41:41 -04:00
;;
checkers/spell: add +flyspell flag spell-fu lacks support for multiple dictionaries, affix expansion, and many non-English dictionaries, so I've added back flyspell support to the spell module, but opt-in, because it is still the significantly slower option and spell-fu may support them one day. If not, tlikonen/wcheck-mode is another alternative to consider. Fixes #3813
2020-08-23 18:48:50 -04:00
;;; Ispell
;; `elisp-mode' is loaded at startup. In order to lazy load its config we need
;; to pretend it isn't loaded
(delq! 'ispell features)
checkers/spell: replace flyspell with spell-fu Spell-fu is significantly faster, but does produce more false positives (more faces must be added to spell-fu-faces-exclude to reduce these). Unfortunately, there is no fancy "correction" interface for spell-fu yet, so we'll have to resort to ispell-word (on z=) for now.
2020-08-21 02:41:41 -04:00
(global-set-key [remap ispell-word] #'+spell/correct)
ispell-dictionary = en_US Set a default so we at least don't get stringp errors on startup.
2020-01-02 21:10:38 -05:00
feature/{syntax-checker,spellcheck} -> tools/fly{check,spell}
2019-02-22 00:20:29 -05:00
(after! ispell
tools/flyspell: don't spellcheck org blocks
2019-07-28 22:55:18 +02:00
;; Don't spellcheck org blocks
(pushnew! ispell-skip-region-alist
'(":\\(PROPERTIES\\|LOGBOOK\\):" . ":END:")
'("#\\+BEGIN_SRC" . "#\\+END_SRC")
'("#\\+BEGIN_EXAMPLE" . "#\\+END_EXAMPLE"))
Refactor aspell/hunspell initialization
2019-04-02 14:03:27 -04:00
;; Enable either aspell or hunspell.
;; If no module flags are given, enable either aspell or hunspell if their
;; binary is found.
;; If one of the flags `+aspell' or `+hunspell' is given, only enable that
;; spell checker.
(pcase (cond ((featurep! +aspell) 'aspell)
((featurep! +hunspell) 'hunspell)
((executable-find "aspell") 'aspell)
((executable-find "hunspell") 'hunspell))
(`aspell
(setq ispell-program-name "aspell"
checkers/spell: fix z=, zq, zw & personal dictionary + Fixes ispell not noticing allowed words in your personal dictionary. So +spell/correct would sometimes correct words that spell-fu wasn't highlighting as incorrect, and sometimes wouldn't correct words that were. + Fixes spell-fu refusing to read or write to the personal dictionary if the file didn't already exist beforehand (for zq and zw). + Change ispell-dictionary fallback from "en_US" (which aspell won't always recognize) to "en". + Moved ispell-personal-dictionary to ~/.emacs.d/.local/etc/ispell/ by default.
2020-08-23 02:32:58 -04:00
ispell-extra-args '("--sug-mode=ultra"
"--run-together"
"--dont-tex-check-comments"))
(unless ispell-dictionary
(setq ispell-dictionary "en"))
(unless ispell-aspell-dict-dir
(setq ispell-aspell-dict-dir
(ispell-get-aspell-config-value "dict-dir")))
(unless ispell-aspell-data-dir
(setq ispell-aspell-data-dir
(ispell-get-aspell-config-value "data-dir")))
(unless ispell-personal-dictionary
(setq ispell-personal-dictionary
(expand-file-name (concat "ispell/" ispell-dictionary ".pws")
doom-etc-dir)))
flyspell: allow enabling either aspell or hunspell * Previously, a user could not choose which spell checker to use. Instead, the first one found was used. * This PR adds the flags `+aspell` and `+hunspell` which allow a user to choose which spellchcker to use (even if both are installed). * Report an error if spell checking is enabled but no spell checker is found.
2019-03-18 15:52:32 +01:00
Correct last inline hook defuns See a3e262c7 for rationale
2019-07-28 14:52:59 +02:00
(add-hook! 'text-mode-hook
Move :tools fly{check,spell} to :checkers {syntax,spell} These modules were renamed so we can later generalize their implementations, such as adding flymake support to the syntax checker.
2020-01-09 18:41:48 -05:00
(defun +spell-remove-run-together-switch-for-aspell-h ()
tools/flyspell: conform to new conventions
2019-07-22 23:34:23 +02:00
(setq-local ispell-extra-args (remove "--run-together" ispell-extra-args))))
flyspell: allow enabling either aspell or hunspell * Previously, a user could not choose which spell checker to use. Instead, the first one found was used. * This PR adds the flags `+aspell` and `+hunspell` which allow a user to choose which spellchcker to use (even if both are installed). * Report an error if spell checking is enabled but no spell checker is found.
2019-03-18 15:52:32 +01:00
Move :tools fly{check,spell} to :checkers {syntax,spell} These modules were renamed so we can later generalize their implementations, such as adding flymake support to the syntax checker.
2020-01-09 18:41:48 -05:00
(defun +spell-init-ispell-extra-args-a (orig-fun &rest args)
tools/flyspell: conform to new conventions
2019-07-22 23:34:23 +02:00
:around '(ispell-word flyspell-auto-correct-word)
Refactor aspell/hunspell initialization
2019-04-02 14:03:27 -04:00
(let ((ispell-extra-args (remove "--run-together" ispell-extra-args)))
(ispell-kill-ispell t)
(apply orig-fun args)
tools/flyspell: conform to new conventions
2019-07-22 23:34:23 +02:00
(ispell-kill-ispell t))))
flyspell: allow enabling either aspell or hunspell * Previously, a user could not choose which spell checker to use. Instead, the first one found was used. * This PR adds the flags `+aspell` and `+hunspell` which allow a user to choose which spellchcker to use (even if both are installed). * Report an error if spell checking is enabled but no spell checker is found.
2019-03-18 15:52:32 +01:00
Refactor aspell/hunspell initialization
2019-04-02 14:03:27 -04:00
(`hunspell
tools/flyspell: reduce english-centric defaults Falls back to system defaults, which are a little more reliable.
2019-05-06 19:39:35 -04:00
(setq ispell-program-name "hunspell"))
feature/{syntax-checker,spellcheck} -> tools/fly{check,spell}
2019-02-22 00:20:29 -05:00
tools/flyspell: doom-log failed to find checker Instead of logging with message, which is more disruptive (appears in bin/doom output, for instance).
2019-06-18 17:30:26 +02:00
(_ (doom-log "Spell checker not found. Either install `aspell' or `hunspell'"))))
feature/{syntax-checker,spellcheck} -> tools/fly{check,spell}
2019-02-22 00:20:29 -05:00
checkers/spell: add +flyspell flag spell-fu lacks support for multiple dictionaries, affix expansion, and many non-English dictionaries, so I've added back flyspell support to the spell module, but opt-in, because it is still the significantly slower option and spell-fu may support them one day. If not, tlikonen/wcheck-mode is another alternative to consider. Fixes #3813
2020-08-23 18:48:50 -04:00
;;
;;; Implementations
Rename {if,when}! -> eval-{if,when}! To better represent its purpose, as extensions to Emacs' eval-when* API (for control flow at compile time).
2020-08-26 21:40:53 -04:00
(eval-if! (not (featurep! +flyspell))
checkers/spell: add +flyspell flag spell-fu lacks support for multiple dictionaries, affix expansion, and many non-English dictionaries, so I've added back flyspell support to the spell module, but opt-in, because it is still the significantly slower option and spell-fu may support them one day. If not, tlikonen/wcheck-mode is another alternative to consider. Fixes #3813
2020-08-23 18:48:50 -04:00
(use-package! spell-fu
:when (executable-find "aspell")
:hook (text-mode . spell-fu-mode)
:general ([remap ispell-word] #'+spell/correct)
:init
(defvar +spell-correct-interface
(cond ((featurep! :completion ivy)
#'+spell-correct-ivy-fn)
((featurep! :completion helm)
#'+spell-correct-helm-fn)
(#'+spell-correct-generic-fn))
"Function to use to display corrections.")
(defvar +spell-excluded-faces-alist
'((markdown-mode
. (markdown-code-face
markdown-html-attr-name-face
markdown-html-attr-value-face
markdown-html-tag-name-face
markdown-link-face
markdown-markup-face
markdown-reference-face
markdown-url-face))
(org-mode
. (org-block
org-block-begin-line
org-block-end-line
org-code
org-date
org-formula
org-latex-and-related
org-link
org-meta-line
org-property-value
org-ref-cite-face
org-special-keyword
org-tag
org-todo
org-todo-keyword-done
org-todo-keyword-habt
org-todo-keyword-kill
org-todo-keyword-outd
org-todo-keyword-todo
org-todo-keyword-wait
Add latex faces to +spell-excluded-faces-alist
2020-08-24 16:16:19 +03:00
org-verbatim))
(latex-mode
. (font-latex-math-face
font-latex-sedate-face
font-lock-function-name-face
font-lock-keyword-face
font-lock-variable-name-face)))
checkers/spell: add +flyspell flag spell-fu lacks support for multiple dictionaries, affix expansion, and many non-English dictionaries, so I've added back flyspell support to the spell module, but opt-in, because it is still the significantly slower option and spell-fu may support them one day. If not, tlikonen/wcheck-mode is another alternative to consider. Fixes #3813
2020-08-23 18:48:50 -04:00
"Faces in certain major modes that spell-fu will not spellcheck.")
(setq spell-fu-directory (concat doom-etc-dir "spell-fu"))
(when (featurep! +everywhere)
(add-hook! '(yaml-mode-hook
conf-mode-hook
prog-mode-hook)
#'spell-fu-mode))
:config
(map! :after spell-fu
:map override
:n [return]
(cmds! (memq 'spell-fu-incorrect-face (face-at-point nil t))
#'+spell/correct))
(defadvice! +spell--create-word-dict-a (_word words-file _action)
:before #'spell-fu--word-add-or-remove
(unless (file-exists-p words-file)
(make-directory (file-name-directory words-file) t)
(with-temp-file words-file
(insert (format "personal_ws-1.1 %s 0\n" ispell-dictionary)))))
(add-hook! 'spell-fu-mode-hook
(defun +spell-init-excluded-faces-h ()
"Set `spell-fu-faces-exclude' according to `+spell-excluded-faces-alist'."
(when-let (excluded (alist-get major-mode +spell-excluded-faces-alist))
(setq-local spell-fu-faces-exclude excluded))))
;; TODO custom `spell-fu-check-range' function to reduce false positives
;; more intelligently, or modify `spell-fu-word-regexp' to include
;; non-latin charactersets.
)
(use-package! flyspell ; built-in
:defer t
:preface
;; `flyspell' is loaded at startup. In order to lazy load its config we need
;; to pretend it isn't loaded.
(defer-feature! flyspell flyspell-mode flyspell-prog-mode)
:init
(add-hook! '(org-mode-hook
markdown-mode-hook
TeX-mode-hook
rst-mode-hook
mu4e-compose-mode-hook
message-mode-hook
git-commit-mode-hook)
#'flyspell-mode)
(when (featurep! +everywhere)
(add-hook! '(yaml-mode-hook
conf-mode-hook
prog-mode-hook)
#'flyspell-prog-mode))
:config
Fix #3863: "load" ispell after flyspell Emacs loads both ispell and flyspell at startup, so to lazy load user configuration to either package, we fool Emacs into thinking neither is loaded yet. However, this means we need a trigger to eventually "load" ispell, which we didn't have until now, causing #3863.
2020-08-31 23:19:31 -04:00
(provide 'ispell) ; forcibly load ispell configs
checkers/spell: add +flyspell flag spell-fu lacks support for multiple dictionaries, affix expansion, and many non-English dictionaries, so I've added back flyspell support to the spell module, but opt-in, because it is still the significantly slower option and spell-fu may support them one day. If not, tlikonen/wcheck-mode is another alternative to consider. Fixes #3813
2020-08-23 18:48:50 -04:00
(setq flyspell-issue-welcome-flag nil
;; Significantly speeds up flyspell, which would otherwise print
;; messages for every word when checking the entire buffer
flyspell-issue-message-flag nil)
(add-hook! 'flyspell-mode-hook
(defun +spell-inhibit-duplicate-detection-maybe-h ()
"Don't mark duplicates when style/grammar linters are present.
e.g. proselint and langtool."
(and (or (and (bound-and-true-p flycheck-mode)
(executable-find "proselint"))
(featurep 'langtool))
(setq-local flyspell-mark-duplications-flag nil))))
;; Ensure mode-local predicates declared with `set-flyspell-predicate!' are
;; used in their respective major modes.
(add-hook 'flyspell-mode-hook #'+spell-init-flyspell-predicate-h)
(let ((flyspell-correct
(cmds! (and (not (or mark-active (ignore-errors (evil-insert-state-p))))
(memq 'flyspell-incorrect (face-at-point nil t)))
#'flyspell-correct-at-point)))
(map! :map flyspell-mouse-map
"RET" flyspell-correct
[return] flyspell-correct
[mouse-1] #'flyspell-correct-at-point)))
(use-package! flyspell-correct
:commands flyspell-correct-previous
:general ([remap ispell-word] #'flyspell-correct-at-point)
:config
(cond ((and (featurep! :completion helm)
(require 'flyspell-correct-helm nil t)))
((and (featurep! :completion ivy)
(require 'flyspell-correct-ivy nil t)))
((require 'flyspell-correct-popup nil t)
(setq flyspell-popup-correct-delay 0.8)
(define-key popup-menu-keymap [escape] #'keyboard-quit))))
(use-package! flyspell-lazy
:after flyspell
:config
(setq flyspell-lazy-idle-seconds 1
flyspell-lazy-window-idle-seconds 3)
(flyspell-lazy-mode +1)))
Reference in a new issue Copy permalink