typos/docs/comparison.md

# Related Spell Checkers

|                | typos                 | [bloom42/misspell][misspell-rs] | [client9/misspell][misspell-go] | [codespell] | [scspell3k] |
|----------------|-----------------------|---------------------------------|---------------------------------|-------------|-------------|
| Runtime        | \-                    | \-                              | \-                              | Python      | Python      |
| [Approach](design.md) | Correction     | Correction                      | Correction                      | Correction  | Dictionary  |
| Custom Dict    | Yes                   | No                              | ?                               | Yes         | Yes         |
| Per-Lang Dict  | Yes                   | No                              | ?                               | No          | Yes         |
| CamelCase      | Yes                   | No                              | ?                               | No          | Yes         |
| snake_case     | Yes                   | No                              | ?                               | No          | Yes         |
| Ignore Hex     | Yes                   | No                              | ?                               | No          | Yes         |
| C-Escapes      | No ([#20][def-3])     | No                              | ?                               | No          | Yes         |
| Encodings      | UTF-8 / UTF-16        | UTF-8                           | ?                               | Auto        | Auto        |
| Whole-project  | Yes                   | Yes                             | Yes                             | Yes         | No          |
| Ignores hidden | Yes                   | Yes                             | ?                               | Yes         | No          |
| Respect gitignore | Yes                | Yes                             | ?                               | No          | No          |
| Checks filenames | Yes                 | No                              | ?                               | Yes         | No          |
| Status via exit code | Yes             | No                              | Yes                             | Yes         | Yes         |
| API            | Rust / [JSON Lines]   | Rust                            | ?                               | Python      | None        |
| License        | MIT or Apache         | AGPL                            | MIT                             | GPLv2       | GPLv2       |

See also [benchmarks](../benchsuite/runs).

[JSON Lines]: http://jsonlines.org/
[scspell3k]: https://github.com/myint/scspell
[misspell-rs]: https://gitlab.com/bloom42/misspell
[misspell-go]: https://github.com/client9/misspell
[codespell]: https://github.com/codespell-project/codespell
[def-9]: https://github.com/crate-ci/typos/issues/9
[def-14]: https://github.com/crate-ci/typos/issues/14
[def-17]: https://github.com/crate-ci/typos/issues/17
[def-18]: https://github.com/crate-ci/typos/issues/18
[def-3]: https://github.com/crate-ci/typos/issues/3
docs: Re-organize to clarify intent This is part of #237 2021-04-30 20:41:32 -05:00			`# Related Spell Checkers`
docs: Add link to benchmarks 2019-10-25 06:15:40 -06:00
docs: Compare with codespell Fixes #23 2019-07-13 18:45:36 -06:00			`\| \| typos \| [bloom42/misspell][misspell-rs] \| [client9/misspell][misspell-go] \| [codespell] \| [scspell3k] \|`
			`\|----------------\|-----------------------\|---------------------------------\|---------------------------------\|-------------\|-------------\|`
docs: Fix links 2019-10-25 08:06:05 -06:00			`\| Runtime \| \- \| \- \| \- \| Python \| Python \|`
docs: Switch from blacklist language 2021-04-30 20:49:01 -05:00			`\| [Approach](design.md) \| Correction \| Correction \| Correction \| Correction \| Dictionary \|`
docs: Note custom dicts is supported 2020-11-10 06:40:24 -06:00			`\| Custom Dict \| Yes \| No \| ? \| Yes \| Yes \|`
docs(about): Update comparison table 2021-04-06 21:18:56 -05:00			`\| Per-Lang Dict \| Yes \| No \| ? \| No \| Yes \|`
docs: Compare with codespell Fixes #23 2019-07-13 18:45:36 -06:00			`\| CamelCase \| Yes \| No \| ? \| No \| Yes \|`
			`\| snake_case \| Yes \| No \| ? \| No \| Yes \|`
feat(parser): Ignore hex literals Trying to avoid accidentally correcting something that looks like a word inside a hex number, like `0xBEAF`. Fixes #19 2019-07-13 19:24:27 -06:00			`\| Ignore Hex \| Yes \| No \| ? \| No \| Yes \|`
docs: Compare with codespell Fixes #23 2019-07-13 18:45:36 -06:00			`\| C-Escapes \| No ([#20][def-3]) \| No \| ? \| No \| Yes \|`
feat: Check and replace UTF-16 files We don't have good detection for non-UTF encodings and don't have encoding support for UTF-32, so limiting it to just UTF-16. Fixes #17 2020-11-03 19:52:39 -06:00			`\| Encodings \| UTF-8 / UTF-16 \| UTF-8 \| ? \| Auto \| Auto \|`
docs: Compare with codespell Fixes #23 2019-07-13 18:45:36 -06:00			`\| Whole-project \| Yes \| Yes \| Yes \| Yes \| No \|`
			`\| Ignores hidden \| Yes \| Yes \| ? \| Yes \| No \|`
docs: Add gitignore to comparison Fixes #25 2019-07-13 18:46:00 -06:00			`\| Respect gitignore \| Yes \| Yes \| ? \| No \| No \|`
feat: Check file names Fixes #24 2019-07-18 20:20:45 -06:00			`\| Checks filenames \| Yes \| No \| ? \| Yes \| No \|`
feat: Set exit code on typos being found Fixes #45 2019-07-22 14:33:39 -06:00			`\| Status via exit code \| Yes \| No \| Yes \| Yes \| Yes \|`
docs: Compare with codespell Fixes #23 2019-07-13 18:45:36 -06:00			`\| API \| Rust / [JSON Lines] \| Rust \| ? \| Python \| None \|`
			`\| License \| MIT or Apache \| AGPL \| MIT \| GPLv2 \| GPLv2 \|`
docs: Comparison with other tools Fixes #12 2019-06-26 21:46:14 -06:00
docs: Re-organize to clarify intent This is part of #237 2021-04-30 20:41:32 -05:00			`See also [benchmarks](../benchsuite/runs).`

docs: Comparison with other tools Fixes #12 2019-06-26 21:46:14 -06:00			`[JSON Lines]: http://jsonlines.org/`
			`[scspell3k]: https://github.com/myint/scspell`
			`[misspell-rs]: https://gitlab.com/bloom42/misspell`
			`[misspell-go]: https://github.com/client9/misspell`
docs: Compare with codespell Fixes #23 2019-07-13 18:45:36 -06:00			`[codespell]: https://github.com/codespell-project/codespell`
docs: Fix links 2019-10-25 08:06:05 -06:00			`[def-9]: https://github.com/crate-ci/typos/issues/9`
			`[def-14]: https://github.com/crate-ci/typos/issues/14`
			`[def-17]: https://github.com/crate-ci/typos/issues/17`
			`[def-18]: https://github.com/crate-ci/typos/issues/18`
			`[def-3]: https://github.com/crate-ci/typos/issues/3`