Misspell Fixer

--> <-- original developer :)

==============

Utility to fix common misspellings, typos in source code. There are lots of typical misspellings in program code. Typically they are more eye-catching in the living code but they can easily hide in comments, examples, samples, notes and documentation. With this utility you can fix a large number of them very quickly.

Be aware that the utility does not check or fix file names. It can easily happen that a misspelled word is fixed in a file name in a program's code, but the file itself will not be renamed by this utility.

And also important to note to be extra careful when fixing public APIs!

A manual review is always needed to verify that nothing has been broken.

Synopsis

misspell_fixer	[OPTION] target

Options, Arguments

target can be any file or directory.

• -d Debug mode: shows all steps of the core logic
• -v Verbose mode: shows the iterated files
• -o Verbose mode: show progress (print a dot for each file being processed)
• -r Real run mode: Overwrites the original files with the fixed one. Without this option the originals will be untouched.
• -f Fast mode: Faster mode with limited options. (-v, -s options are not supported) Works only with real run mode -r. This mode cannot make backups. (-n is also needed)
• -s Shows diffs of changes.
• -i Walk through source code management system's internal directories. (don't ignore *.svn*, *.git*)
• -b Process binary files. (don't ignore *.gif, *.jpg, *.png, *.zip, *.gz, *.bz2, *.rar)
• -n Disale backups. (By default the modified files' originals will be saved with the .$$.BAK suffix.)
• -N Enable file name filtering. For example: -N '*.cpp' -N '*.h'
• -P Enable parallelism. For example: -P 4 processes the files in 4 threads. (Supported only in fast mode.)
• -h Help. Displays this usage.

By default only a subset of rules are enabled (around 100). You can enable more rules with the following options:

• -u Enable less safe rules. (Manual revising is neededed to be more probable.) (Around ten rules.)
• -g Enable rules to convert British English to US English. (These rules aren't exactly typos but sometimes they can be useful.) (Around ten rules.)
• -R Enable rare rules. (Few hundred rules.)
• -V Enable very rare rules. (Mostly from the wikipedia article.) (More than four thousand rules.)
• -D Enable rules based on lintian.debian.org ( git:ebac9a7, ~2300 )
• -m Disable file size checks. default is to ignore files > 1MB. (usually csv, compressed JS, ..)

The processing speed decreases as you activate more rules.

Sample usage

By default nothing important will happen

$ misspell_fixer.sh target

What you can track with -v

$ misspell_fixer.sh -v target

A real usage:

$ misspell_fixer.sh -r -v target

Show only the diff, don't modify the files:

$ misspell_fixer.sh -s -v target

Show everything and fix the files:

$ misspell_fixer.sh -r -s -v target

Fast mode example:

$ misspell_fixer.sh -r -f -n target

Fast mode example with mass processing:

$ misspell_fixer.sh -frnR -P4 target

It is based on the following sources for common misspellings:

• http://www.how-do-you-spell.com/
• http://en.wikipedia.org/wiki/Commonly_misspelled_words
• http://www.wrongspelled.com/
• https://github.com/neleai/stylepp
• http://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines
• https://anonscm.debian.org/git/lintian/lintian.git ( /data/spelling/corrections)

Dependencies

• bash
• find
• sed
• diff
• xargs (for parallelism)

Author

Veres Lajos

Original source

https://github.com/vlajos/misspell_fixer

Feel free to use!