Tree [347dcd] master /
History



File Date Author Commit
doc 2012-05-27 Kevin Lyda Kevin Lyda [d825df] Manpage edits and installer.
tests 2013-09-12 Ville Skyttä Ville Skyttä [347dcd] Add new words from Wikipedia.
utils 2012-05-26 Kevin Lyda Kevin Lyda [503649] Manual pages.
.gitignore 2012-05-20 Kevin Lyda Kevin Lyda [ded0da] Merge myint's travis branch.
.pylintrc 2012-06-16 Kevin Lyda Kevin Lyda [1db031] Hush pylint.
.travis.yml 2013-02-18 Kevin Lyda Kevin Lyda [e64409] Merge pull request #17 from myint/travis
LICENSE 2011-10-03 Kevin Lyda Kevin Lyda [8953de] Add a license.
MANIFEST.in 2012-06-18 Kevin Lyda Kevin Lyda [6230c6] Quick script to run pylint and coverage.
README.rst 2013-03-03 Kevin Lyda Kevin Lyda [c77732] Update TODO list.
misspell-check-logo.png 2013-04-07 Kevin Lyda Kevin Lyda [9b9996] Add logo.
misspellings 2013-08-14 Kevin Lyda Kevin Lyda [89d565] Add a better description of the tool.
misspellings_lib.py 2013-09-12 Ville Skyttä Ville Skyttä [347dcd] Add new words from Wikipedia.
setup.py 2013-09-12 Ville Skyttä Ville Skyttä [347dcd] Add new words from Wikipedia.
tox.ini 2013-02-18 Kevin Lyda Kevin Lyda [1e40e4] Enable python 3.3 for tox.

Read Me

misspellings

Build status

Spell checker for code

This is a Python library and tool to check for misspelled words in source code. It does this by looking for words from a list of common misspellings. The dictionary it uses to do this is based on the Wikipedia list of common misspellings.

The list has been slightly modified to remove some changes that cause a number of false positives. In particular ok->OK was removed (ok is frequently used in perl tests for instance).

Example

To try it out, merely run the following (using an old coreutils source tree as an example):

$ git clone git://git.sv.gnu.org/coreutils -b v8.10 coreutils
$ find coreutils -name '*.c' | misspellings -f -
coreutils/src/cat.c:754: efficency -> "efficiency"
coreutils/src/comm.c:198: funtion -> "function"
coreutils/src/expr.c:21: seperate -> "separate"
coreutils/src/pr.c:1417: accomodate -> "accommodate"
coreutils/src/tac.c:342: unneccessary -> "unnecessary"
coreutils/src/test.c:91: supressed -> "suppressed"

Contributions

Contributions are welcome! Please add unit tests for new features or bug fixes. To run all the unit tests run ./setup.py test. If you have tox installed, just run tox.

You can review coverage of added tests by running coverage run setup.py test and then running coverage report -m.

Note that tests are run on Travis for all supported python versions whenever the tree on github is pushed to.

The packaged version is available via pip or easy_install as misspellings. The project page is on pypi:

The source code is available in the following locations:

Pull requests on any of those platforms or emailed patches are fine.

TODO

Some items on the TODO list:

  • Implement option to interactively fix files.
  • Give some thought to supporting multiple languages?
  • Might a "common misspellings" list be different for different English users - might an American make one set of mistakes while a German writing English make another? Source of this data?
  • Fix sed flag. Have it support sed -i optionally, have it output all unambiguous sed commands, have it be more careful on what it replaces. It might also be an idea to have a perl output option.
  • Use generators to allow finding errors as you go. Currently misspellings grabs all files first, then checks them, which can take a while.
  • Lacking tests for misspellings cli.
  • Support UTF8: https://github.com/lyda/misspell-check/issues/16

Credits