Skip to content
This repository

A program to check source code for mispelings...

branch: master

Add new words from Wikipedia.

Ville added the new words.
I removed dumb tests.

A double win!
latest commit 347dcdd08a
Ville Skyttä scop authored September 12, 2013 lyda committed September 12, 2013
Octocat-spinner-32 doc Manpage edits and installer. May 27, 2012
Octocat-spinner-32 tests
Octocat-spinner-32 utils Manual pages. May 26, 2012
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .pylintrc
Octocat-spinner-32 .travis.yml Add CPython 3.3 to Travis February 18, 2013
Octocat-spinner-32 LICENSE
Octocat-spinner-32 MANIFEST.in
Octocat-spinner-32 README.rst
Octocat-spinner-32 misspell-check-logo.png
Octocat-spinner-32 misspellings
Octocat-spinner-32 misspellings_lib.py
Octocat-spinner-32 setup.py
Octocat-spinner-32 tox.ini Enable python 3.3 for tox. February 18, 2013
README.rst

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

Something went wrong with that request. Please try again.