Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Simple tool for fixing common misspellings, typos
Shell Makefile Perl
branch: master

README.md

Misspell Fixer

Build Status Coverage Status Circle CI Build Status

Utility to fix common misspellings, typos in source codes. There are lots of typical misspellings in program codes. Typically they are more eye-catching in the living code but they can easily hide in comments, examples, samples, notes and documentations. 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 directories...

Options

  • -d Debug mode: shows the core logics all steps
  • -v Verbose mode: shows the iterated files
  • -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 Disabling 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 thread. (Supported only in fast mode.)
  • -h Help. Displays this page.

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

  • -u Enabling less safe rules. (Manual revise's need will be more probable.) (Around ten rules.)
  • -g Enabling rules to convert British English to US English. (These rules aren't exactly typos but sometimes they can be useful.) (Around ten rules.)
  • -R Enabling rare rules. (Few hundred rules.)
  • -V Enabling very rare rules. (Mostly from the wikipedia article.) (More than four thousand rules.)

The processing speed decreases as you activate more rules.

Sample usages

By default nothing important will happen

$ misspell_fixer.sh targetdir

What you can track with -v

$ misspell_fixer.sh -v targetdir

A real usage:

$ misspell_fixer.sh -r -v targetdir

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

$ misspell_fixer.sh -s -v targetdir

Show everything and fix the files:

$ misspell_fixer.sh -r -s -v targetdir

Fast mode example:

$ misspell_fixer.sh -r -f -n targetdir

Fast mode example with mass processing:

$ misspell_fixer.sh -frnR -P4 targetdir

It is based on the following sources for common misspellings:

Dependencies

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

Author

Veres Lajos

Original source

https://github.com/vlajos/misspell_fixer

Feel free to use!

Something went wrong with that request. Please try again.