https://github.com/rhcarvalho/typokiller
Exterminate typos in your code base
https://github.com/rhcarvalho/typokiller
asciidoc enchant go golang pyenchant python spell-checker spellcheck spelling-checker spelling-correction typo
Last synced: 2 months ago
JSON representation
Exterminate typos in your code base
- Host: GitHub
- URL: https://github.com/rhcarvalho/typokiller
- Owner: rhcarvalho
- Created: 2015-02-11T21:27:10.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-05T15:18:31.000Z (over 8 years ago)
- Last Synced: 2025-05-05T14:42:02.235Z (6 months ago)
- Topics: asciidoc, enchant, go, golang, pyenchant, python, spell-checker, spellcheck, spelling-checker, spelling-correction, typo
- Language: Go
- Size: 210 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
typokiller
==========
Exterminate typos. Now.
`typokiller` is a tool for finding and fixing typos in text files, from source
code comments to documentation.
Currently supported input formats:
- Go code
- AsciiDoc files
Planned formats:
- Pure text files
- Markdown
- Python docstrings and comments
- Wikipedia dumps
- Diff/patch files
## Project's Background Story
Since you're here, you might be interested to know how this project was born. Go
on and read [the story behind `typokiller`](STORY.md).
Hacking
-------
Clone the repository:
```bash
$ git clone https://github.com/rhcarvalho/typokiller.git
```
Build and runtime requirements:
* Proper [Go](http://golang.org/doc/install) [environment](http://golang.org/doc/code.html#GOPATH) (tested with Go 1.4.1, probably works with older versions)
* [Python](http://python.org/) 2.x (seems to work faster with [PyPy](http://pypy.org))
It's recommended to install PyPy and use it inside a [virtualenv](https://virtualenv.pypa.io/en/latest/).
Activate the virtualenv and run:
```bash
$ pip install -r requirements.txt
```
Build and install Go executable:
```bash
$ cd typokiller
$ go get ./...
```
Usage
-----
The shortcut:
```bash
$ ./killtypos PATH ...
```
This will build and install `typokiller`, read the documentation of the Go packages in PATH(s), spellcheck it all, and present a terminal-based UI for fixing typos.
Integrate with `find` for great profit:
```bash
$ ./killtypos $(find /PATH/TO/GIT/REPO -type d -not \( -name .git -prune -o -name Godeps -prune \))
```
This will find typos in all directories under `/PATH/TO/GIT/REPO` (inclusive), ignoring anything under `.git` and `Godeps`.
typokiller also supports an additional format: AsciiDoc. You can use it to fix
typos in documentation or generally files in the AsciiDoc format:
```bash
$ ./killtypos --format=adoc $(find /PATH/TO/GIT/REPO -type d -not \( -name .git -prune \))
```
You can also use the parts separately for debugging or integration with other UNIX tools:
```bash
# normal usage:
$ typokiller read /PATH/TO/GO/PKG | ./spellcheck.py | typokiller fix
# inspect spellcheck results manually:
$ typokiller read /PATH/TO/GO/PKG | ./spellcheck.py | ./pprint_json.py | less
# limit number of packages:
$ typokiller read /PATH/TO/GO/PKG | head -n 20 | ./spellcheck.py | ./pprint_json.py | less
```