Spellcheck Processor

Purpose

Checks documentation files for spelling errors using Hunspell-compatible dictionaries (via the zspell crate, pure Rust).

How It Works

Discovers files matching the configured extensions, extracts words from markdown content (stripping code blocks, inline code, URLs, and HTML tags), and checks each word against the system Hunspell dictionary and a custom words file (if it exists). Creates a stub file on success; fails with a list of misspelled words on error.

Dictionaries are read from /usr/share/hunspell/.

This processor supports batch mode when auto_add_words is enabled, collecting all misspelled words across files and writing them to the words file at the end.

Source Files

• Input: **/*{extensions} (default: **/*.md)
• Output: out/spellcheck/{flat_name}.spellcheck

Custom Words File

The processor loads custom words from the file specified by words_file (default: .spellcheck-words) if the file exists. Format: one word per line, # comments supported, blank lines ignored.

The words file is also auto-detected as an input via auto_inputs, so changes to it invalidate all spellcheck products. To disable words file detection, set auto_inputs = [].

Configuration

[processor.spellcheck]
extensions = [".md"]                  # File extensions to check (default: [".md"])
language = "en_US"                    # Hunspell dictionary language (default: "en_US")
words_file = ".spellcheck-words"      # Path to custom words file (default: ".spellcheck-words")
auto_add_words = false                # Auto-add misspelled words to words_file (default: false)
auto_inputs = [".spellcheck-words"]   # Auto-detected config files (default: [".spellcheck-words"])
extra_inputs = []                     # Additional files that trigger rebuilds when changed