Package: scspell
scspellis a spell checker for source code.  It does not try to be
particularly smart–rather, it does the simplest thing that can possibly work:All alphanumeric strings (strings of letters, numbers, and
underscores) are spell-checked tokens.Each token is split into one or more subtokens.  Underscores and digits
always divide tokens, and capital letters will begin new subtokens.  In
other words,some_variableandsomeVariablewill both generate
the subtoken list {some,variable}.All subtokens longer than three characters are matched against a set of
dictionaries, and a match failure prompts the user for action.  When
matching against the included English dictionary,prefix matchingis
employed; this choice permits the use of truncated words likedictas valid subtokens.When applied to code written in most popular programming languages while using
typical naming conventions, this algorithm will usually catch many errors
without an annoying false positive rate.In an effort to catch more spelling errors,scspellis able to check each
file against a set of dictionary words selectedspecifically for that file.  Up
to three different sub-dictionaries may be searched for any given file:A natural language dictionary.  (scspellprovides an American
English dictionary as the default.)A programming language-specific dictionary, intended to contain
oddly-spelled keywords and APIs associated with that language.
(scspellprovides small default dictionaries for a number of popular
programming languages.)A file-specific dictionary, intended to contain uncommon strings which
are not likely to be found in more than a handful of unique files.UsageTo begin the spell checker, run$ scspell source_file1 source_file2 ...For each spell check failure, you will see output much like this:filename.c:27: Unmatched 'someMispeldVaraible' -> {mispeld, varaible}In other words, the token “someMispeldVaraible” was found on line 27
offilename.c, and it contains subtokens “mispeld” and
“varaible” which both failed the spell-checking algorithm.  You will
be prompted for an action to take:(i)gnoreSkip to the next unmatched token, without taking any action.(I)gnore allSkip over this token every time it is encountered, for the
remainder of this spell check session.(r)eplaceEnter some text to use as a replacement for this token, and replace
only the token at this point in the file.(R)eplace allEnter some text to use as a replacement for this token, and replace
every occurrence of the token until the end of the current file.(a)dd to dictionaryAdd one or more tokens to one of the dictionaries (see below).show (c)ontextPrint out some lines of context surrounding the unmatched token.If you accidentally select a replacement operation, enter an empty
string to cancel.If you select the(a)dd to dictionaryoption, then you will be
prompted with the following options for every subtoken:(b)ackReturn to the previous menu, without taking any action.(i)gnoreSkip to the next subtoken, without taking any action.add to (p)rogramming language dictionaryAdd this subtoken to the dictionary associated with the
programming language of the current file.scspelluses the
file extension to determine the language, so you will only
see this option for files which have an extension.add to (f)ile-specific dictionaryAdd this subtoken to the dictionary associated with the
current file.scspellidentifies unique files by scanning
for an embedded ID string, so you will only see this option
for files which have such an ID.  SeeCreating File IDsfor details.add to (n)atural language dictionaryAdd this subtoken to the natural language dictionary.Creating File IDsIf you would likescspellto be able to uniquely identify a file, thus
enabling the creation of a file-specific dictionary, then you must insert a
unique ID somewhere in the contents of that file.scspellwill scan each
file for a string of the following form:scspell-id: <unique ID>The unique ID must consist only of letters, numbers, underscores, and dashes.scspellcan generate suitable unique ID strings using the--gen-idoption:$ scspell --gen-id
scspell-id: e497803c-523a-11de-ae42-0017f2ee0f37(Most likely you will want to place a file’s unique ID inside a source code comment.)Sharing a DictionaryA team of developers working on the same source tree may wish to share a common
dictionary.  You can permanently set the location of a shared dictionary by
executing$ scspell --set-dictionary=/path/to/dictionary_file.txtThe dictionary is formatted as a simple newline-separated list of words, so it
can easily be managed by a version control system if desired.The current dictionary can be saved to a file by executing$ scspell --export-dictionary=/path/to/output_file.txtYou can also override the dictionary location for a single spell check session,
by using the--override-dictionaryoption:$ scspell --override-dictionary=/path/to/dictionary_file.txt source_file1 ...InstallationIf you havesetuptoolsinstalled, then you can installscspellvia:$ easy_install scspellAlternatively, download and unpack the source archive, switch to the
archive root directory, and run the installation script:$ python setup.py installOn a UNIX-like system, you may need to usesudoif installing to a
directory that requires root privileges:$ sudo python setup.py installLicensescspellis Free Software, licensed under Version 2 of the GNU General
Public License; seeCOPYING.txtfor details.The English dictionary distributed with scspell is derived from theSCOWL word lists.  SeeSCOWL-LICENSE.txtfor the myriad licenses that apply to that dictionary.Bugs, etc.scspellishosted on Launchpad;
this would be a great place to file bug reports and feature requests or track
development viabzr.  If that’s not your style, just
send an email to Paul Pelzl <pelzlpj at gmail dot com> .Patches adding the most common keywords/APIs for popular programming languages
would be most welcome.