*[Automatic Corrections](#correct)

*[Converting UK spellings to US](#locale)

*[Using pipes and stdin](#stdin)

*[Golang special support](#golang)

*[Go special support](#golang)

*[CSV Output](#csv)

*[Using SQLite3](#sqlite)

*[Changing output format](#output)

<aname="golang"></a>

yes, if you want to force a file to be checked as agolang source, use`-source=go` on the command line.

Conversely, you can check agolang source as if itwere pure text by using`-source=text`.

Yes, if you want to force a file to be checked as aGo source, use`-source=go` on the command line.

Conversely, you can check aGo source as if itwas pure text by using`-source=text`.

You might want to do this since many variable names have misspellings in them!

<aname="ignore"></a>

Using the`-i "comma,separated,rules"` flag you can specify corrections to ignore.

<aname="output"></a>

Using the`-f template` flag you can pass in a[golang text template](https://golang.org/pkg/text/template/) to format the output.

Using the`-f template` flag you can pass in a[Go text template](https://golang.org/pkg/text/template/) to format the output.

One can use`printf "%q" VALUE` to safely quote a value.

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.

They all work buthad problems that prevented me from using them at scale:

They all work buthave problems that prevented me from using them at scale:

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

* 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, GNU sed, etc.)

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

Misspell is easily 100x to 1000x faster than other spelling correctors.

You should be able to check and correct 1000 files in under 250ms.

This uses the mighty power ofgolang's[strings.Replacer](https://golang.org/pkg/strings/#Replacer)

This uses the mighty power ofGo's[strings.Replacer](https://golang.org/pkg/strings/#Replacer)

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*.

it can be non-obvious to determine exactly what word was corrected.

<aname="debug"></a>

Run using`-debug` flag on the file you want.

It should then print what word it is trying to correct.

Then[file a bug](https://github.com/golangci/misspell/issues) describing the problem.

Thanks!

<aname="missing"></a>

The matching function is*case-sensitive*,

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

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

Misspell also makesuses of theGolang standard library and contains a modified version ofGolang's[strings.Replacer](https://golang.org/pkg/strings/#Replacer)

Misspell also makesuse of theGo standard library and contains a modified version ofGo's[strings.Replacer](https://golang.org/pkg/strings/#Replacer)

which is covered under a[BSD License](https://github.com/golang/go/blob/head/LICENSE).

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

[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 based on mistakes on mechanical typewriters (I'm guessing).

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

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

Variations of UK and US spellings are based on many sources including:

Variations of UK and US spellings are based on many sources, including:

*[Comprehensive* list of American and British spelling differences (archive)](https://web.archive.org/web/20230326222449/http://tysto.com/uk-us-spelling-list.html) (with heavy editing, many are incorrect)

*[American and British spelling (archive)](https://web.archive.org/web/20160820231624/http://www.oxforddictionaries.com/us/words/american-and-british-spelling-american) (excellent site but incomplete)

Here are some ideas for enhancements:

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

*Opinionated US spellings* US English has a number of words with alternate spellings.

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

- Opinionated US spellings: US English has a number of words with alternate spellings.

Think[adviser vs. advisor](http://grammarist.com/spelling/adviser-advisor/).

While "advisor" is not wrong, the opinionated US locale would correct "advisor" to "adviser".

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

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

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

While "advisor" is not wrong, the opinionated US locale would correct "advisor" to "adviser".

- Versioning: Some type of versioning is needed, so reporting mistakes and errors is easier.

- Feedback: Mistakes would be sent to some server for aggregation and feedback review.

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