This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+checkers/spell-checking
syl20bnr e2e532bb49 core: change <function>p to <function>-p suffixes for consistency
Also defined aliases for backward compatibility with `usedp` functions.
2017-07-02 10:09:39 -04:00
..
config.el Fix typo for spell-checking config 2017-05-18 18:11:02 +02:00
funcs.el Bump year in copyright headers 2017-01-05 23:08:17 -05:00
packages.el core: change <function>p to <function>-p suffixes for consistency 2017-07-02 10:09:39 -04:00
README.org update docs to the new toc-org format 2017-05-22 18:35:37 +03:00

Spell Checking layer

Description

This layer provides spell checking using Flyspell and auto-dictionary-mode.

Install

Layer

To use this configuration layer, add it to your ~/.spacemacs. You will need to add spell-checking to the existing dotspacemacs-configuration-layers list in this file.

Spell Checker Configuration

The built-in Emacs variable that controls which external spell-checking program is used is ispell-program-name, which can be set in your dotspacemacs/user-init function if you do not like the default. It will give priority to aspell if it is installed on your system. Another important variable to be aware of is ispell-dictionary which will control the default dictionary used by ispell-program-name (instead of using this variable you can also use the key binding SPC S d).

Disabling by default

By default, spell-checking is enabled in all available major modes and may be toggled off with SPC t S. You can default this to off by setting the variable spell-checking-enable-by-default to nil:

(setq-default dotspacemacs-configuration-layers
  '((spell-checking :variables spell-checking-enable-by-default nil)))

Enabling auto-dictionary-mode

auto-dictionary-mode tries to detect the current language from the buffer content, and activate the corresponding dictionary. You can enable it by setting the variable spell-checking-enable-auto-dictionary to something other than nil:

(setq-default dotspacemacs-configuration-layers
  '((spell-checking :variables spell-checking-enable-auto-dictionary t)))

Some people encountered bugs with auto-dictionary-mode, especially in daemon mode where new emacsclient open directly freezed. If so, no other workaround have been found yet than disabling auto-dictionary-mode completely.

Not all languages are supported by auto-dictionary-list. The supported languages are listed in the adict-language-list variable, that can be checked with spacemacs/describe-variable. For convenience, here is the list of currently supported language:

Language
catalan
classical greek
danish
english
esperanto
french
german
hindi
hungarian
modern greek
norwegian bokmål
norwegian nynorsk
portuguese
romanian
slovak
slovene
spanish
swedish

Enable auto-completion popup

To enable auto-completion popup when the point is idle on a misspelled word set the layer variable enable-flyspell-auto-completion to t:

(setq-default dotspacemacs-configuration-layers
  '((spell-checking :variables enable-flyspell-auto-completion t)))

Key Bindings

Key Binding Description
SPC S b flyspell whole buffer
SPC S c flyspell correct
SPC S d change dictionary
SPC S n flyspell goto next error
SPC t S toggle flyspell