GNU ELPA - jit-spell

jit-spell

Description
Just-in-time spell checking
Latest
jit-spell-0.4.tar (.sig), 2024-Mar-31, 40.0 KiB
Maintainer
Augusto Stoffel <[email protected]>
Atom feed
jit-spell.xml
Website
https://github.com/astoff/jit-spell
Browse ELPA's repository
CGit or Gitweb
Badge

To install this package from Emacs, use package-install or list-packages.

Full description

GNU ELPA

jit-spell is a spell-checking package for Emacs. It highlights all misspelled words in a window, just like a word processor or web browser does.

screenshot.png

Figure 1: Correcting a misspelling with jit-spell

This behavior is different from the built-in Flyspell package, which only checks words as the cursor moves over them. Moreover, unlike Flyspell, jit-spell communicates with the spell-checking subprocess entirely asynchronously, which can lead to a noticeable performance improvement.

jit-spell is part of GNU ELPA and can be installed with M-x package-install RET jit-spell RET.

1. Usage

To enable spell checking in a buffer, type M-x jit-spell-mode RET. To correct a misspelling, you can right-click the word (assuming you have context-menu-mode activated) or call the command jit-spell-correct-word, which uses the minibuffer to read a correction or accept the word.

To make your settings permanent, you may wish to add some variant of the following to your init file:

(add-hook 'text-mode-hook 'jit-spell-mode)
(add-hook 'prog-mode-hook 'jit-spell-mode)
(with-eval-after-load 'jit-spell
  (define-key jit-spell-mode-map (kbd "C-;") 'jit-spell-correct-word))

To pick a spell checker and dictionaries, jit-spell uses Emacs's built-in ispell support code. For instance, ispell-change-dictionary temporarily changes the dictionary of the current buffer. Try also M-x customize-group RET ispell RET to see a listing of all possible settings.

2. Major mode support

Often there are regions of the buffer that should be ignored for spell-checking purposes. In most cases, no additional configuration is necessary.

The simplest mechanism to make adjustments is the user option jit-spell-ignored-faces. Any word fontified with one of these faces in this list ignored by jit-spell. To find out which faces are present on a given character, you can use the describe-char command.

In all programming language modes, spell checking is restricted to comments, docstrings and strings. This can be modified by customizing the variable jit-spell-prog-mode-faces.

3. Contributing

Discussions, suggestions and code contributions are welcome! Since this package is part of GNU ELPA, contributions require a copyright assignment to the FSF.

Old versions

jit-spell-0.3.tar.lz2023-Mar-308.70 KiB
jit-spell-0.2.tar.lz2023-Mar-118.52 KiB
jit-spell-0.1.tar.lz2023-Mar-057.55 KiB