Skip to content

kkuprikov/forspell

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
exe
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Forspell

Gem Version Build Status

Forspell is spellchecker for code and documentation. It uses well-known hunspell tool and dictionary, provides customizable output, and could be easily integrated into CI pipeline.

Example of output:

Features

  • Able to check Markdown files and comments inside Ruby, C and C++ source code;
  • Correctly skips over code examples and identifiers inside comments and Markdown most of the time;
  • Distributed with latest en-US hunspell dictionaries, but can be set to use any other dictionary;
  • Includes by default custom Ruby ecosystem-related dictionary (so it will not report as misspelled words like "Gemfile", "args", "middleware" and alike);
  • It is easy to create custom dictionary for your project, so your internal terms would not be reported as misspellings;
  • Option to auto-generate initial custom dictionary;
  • Several output formats, including pretty colorized human-readable, YAML and JSON.

Installation

gem install forspell

forspell requires libhunspell >= 1.2.0 to be installed, see hunspell site for installation instructions (it is probably as easy as <yourpackagemanager> install hunspell on most of Linuxes and MacOS).

Usage

$ forspell --help
Usage: forspell [list of files and folders] [options]

Options:
    -e, --exclude paths        List of paths to exclude
    -d, --dictionary path      Path to main hunspell dictionary to use (by default, forspell's en_US)
    -c, --custom paths         Paths to custom dictionaries
    -f, --format format_name   Output formats: readable (default), json, yaml
    --gen-dictionary           Generate custom dictionary
    -l, --logfile path         Log to specified path
    -v, --verbose              Verbose mode
    --help

forspell automatically loads command-line arguments from .forspell file in current folder, if it is present. Arguments for forspell command are directories or separate files you want to check. If no arguments provided, current directory will be processed. Supported file extensions are .rb, .c, .cpp, .md.

Dictionaries

As already said, forspell uses hunspell dictionaries to check spelling. By default, it is en_US modern dictionary, distributed with forspell itself, but you can specify any other with -d option. If you have /some/custom/path/fr_FR.aff and /some/custom/path/fr_FR.dic, than you can use it instead of en_US with -d /some/custom/path/fr_FR.

In addition to the main dictionary, forspell also includes (and always uses) small auxiliary dictionary with words specific for Ruby ecosystem, you can review it in forspell repo.

You can also add your project's custom dictionary with internal terms, for them not to obstruct spellchecker's output. Custom dictionary (or several) can be passed with -c option. Also, forspell.dict would be automatically read, if present in current directory. Format of custom dictionary:

  • Each word on its own line.
  • Line contains either just word (means only this word in this form).
  • ...or word: example -- in this case, "example" should be existing word from the main dictionary, and it means your custom term can have the same forms as example word. For example, "subclass: class" will mean that "subclass", "subclasses" and "subclass'" should be considered correct.
  • # marks comments.

For larger projects, it is handy to generate custom dictionary with forspell your,project,pathes --gen-dictionary. This will create forspell.dict with all misspelling found in your project, you can proceed by deleting genuine errors and leave what should be considered correct internal terms.

Integration with CI

Forspell return codes:

  • 0 - when no errors found
  • 1 - when there are any errors
  • 2 - when it could not process with provided options, i.e. no dictionary found, no directories for checking supplied.

To integrate forspell with, say, TravisCI, you would add to .travis.yml:

  • sudo apt-get install hunspell into before_install section
  • Just forspell into script section (given you have proper .forspell file with all options what to check and how to output)

Authors

License

MIT

Contributing

Feel free to create an issue or open a pull request!

About

Smart spellchecker for Ruby code and docs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published