<aname="problem"></a>

This corrects commonly misspelled English words in computer source code, and other text-based formats (`.txt`,`.md`, etc).

This corrects commonly misspelled English words in computer source code, and other text-based formats (`.txt`,`.md`, etc.).

It is designed to run quickly,

so it can be used as a[pre-commit hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) with minimal burden on the developer.

It does not work with binary formats (e.g. Word, etc).

It does not work with binary formats (e.g. Word, etc.).

It is not a complete spell-checking program nor a grammar checker.

* slow, all of the above check one misspelling at a time (i.e. linear) using regexps

* not MIT/Apache2 licensed (or equivalent)

* have dependencies that don't work for me (python3, bash, linux sed, etc)

* have dependencies that don't work for me (python3, bash, linux sed, etc.)

* don't understand American vs. British English and sometimes makes unwelcome "corrections"

That said, they might be perfect for you and many have more features than this project!

which is an implementation or variation of the[Aho–Corasick algorithm](https://en.wikipedia.org/wiki/Aho–Corasick_algorithm).

This makes multiple substring matches*simultaneously*.

In addition, thisuses multiple CPU cores to work on multiple files.

It alsouses multiple CPU cores to work on multiple files concurrently.

<aname="issues"></a>

The matching function is*case-sensitive*,

so variable names that are multiple worlds either in all-upper or all-lower case sometimes can cause false positives.

so variable names that are multiple worlds either in all-uppercase or all-lowercase case sometimes can cause false positives.

For instance a variable named`bodyreader` could trigger a false positive since`yrea` is in the middle that could be corrected to`year`.

Other problems happen if the variable name usesa English contraction that should use an apostrophe.

Other problems happen if the variable name usesan English contraction that should use an apostrophe.

The best way of fixing this is to use the[Effective Go naming conventions](https://golang.org/doc/effective_go.html#mixed-caps)

and use[camelCase](https://en.wikipedia.org/wiki/CamelCase) for variable names.

You can check your code using[golint](https://github.com/golang/lint)

The main code is[MIT](https://github.com/golangci/misspell/blob/master/LICENSE).

Misspell also makes uses of the Golang standard library and contains a modified version of Golang's[strings.Replacer](https://golang.org/pkg/strings/#Replacer)

whichare covered under a[BSD License](https://github.com/golang/go/blob/master/LICENSE).

whichis covered under a[BSD License](https://github.com/golang/go/blob/master/LICENSE).

Type`misspell -legal` for more details or see[legal.go](https://github.com/golangci/misspell/blob/master/legal.go)

<aname="words"></a>

It started with a word list from

[Wikipedia](https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines).

Unfortunately, this list had to be highly edited as many of the words are obsolete or basedfrom mistakes on mechanical typewriters (I'm guessing).

Unfortunately, this list had to be highly edited as many of the words are obsolete or basedon mistakes on mechanical typewriters (I'm guessing).

Additional words were added based on actually mistakes seen in the wild (meaning self-generated).

<aname="otherideas"></a>

Here's some ideas for enhancements:

Here are some ideas for enhancements:

*Capitalization of proper nouns* could be done (e.g. weekday and month names, country names, language names)

*Versioning* Some type of versioning is needed so reporting mistakes and errors is easier.

*Feedback* Mistakes would be sent to some server foragregation and feedback review.

*Feedback* Mistakes would be sent to some server foraggregation and feedback review.

*Contractions and Apostrophes* This would optionally correct "isnt" to "isn't", etc.

quietFlag=flag.Bool("q",false,"Do not emit misspelling output")

outFlag=flag.String("o","stdout","output file or [stderr|stdout|]")

format=flag.String("f","","'csv', 'sqlite3' or custom Golang template for output")

ignores=flag.String("i","","ignore the following corrections, commaseparated")

ignores=flag.String("i","","ignore the following corrections, comma-separated")

locale=flag.String("locale","","Correct spellings using locale preferences for US or UK. Default is to use a neutral variety of English. Setting locale to US will correct the British spelling of 'colour' to 'color'")

mode=flag.String("source","text","Source mode: text (default), go (comments only)")

debugFlag=flag.Bool("debug",false,"Debug matching, very slow")