flymake-cspell.el

A Flymake backend for CSpell – A Spell Checker for Code! by Street Side Software. ❤️

Requires cspell version 6.21.0 or higher.

Installation

If you use MELPA, an easy way to install this package is via package-install. Alternatively, download flymake-cspell.el, put it in your load-path and require it.

If you use both MELPA and use-package, you can use this, too:

(use-package flymake-cspell
  :ensure)

To enable CSpell for a major mode, add flymake-cspell-setup to that mode’s hook:

(add-hook 'python-mode-hook #'flymake-cspell-setup)

Or, alternatively, with use-package:

(use-package python
  :ensure nil
  :hook (python-mode . flymake-cspell-setup))

Customization Options

The cspell process is executed in the default-directory of the checked buffer, so will pick up the nearest cspell configuration file. CSpell offers a bunch of customization options (custom words per project, excluding files from spell checks, etc.) – best see the related section in the official docs for details.

Screenshot

A Ruby buffer with various spelling errors in both code and comments.