samuelpordeus / typo_killer

qu'est que ce 🎶 – Killing typos with style (and Elixir!)

Typo Killer

qu'est que ce

Building

With elixir installed, open typo_killer folder and use the following commands on your terminal:

mix deps.get
mix compile

Simple Usage

Using iex

Open an iex session:

iex -S mix

Then just: TypoKiller.find_typos("path/to/folder")

Using mix

Just run mix typo_killer path/to/folder

Creating a binary

This will create a self contained executable file which will include everything that you need to run TypoKiller. This file can be distributed to other people and they don't need to have an Erlang runtime installed - it's all in the binary file.

To create it, run:

mix escript.build

This will generate an executable file bin/typokiller. Now run ./bin/typokiller --help for more information.

Installing on a POSIX system

$ make
$ sudo make install

Then you can use it like:

$ typokiller --help

Typo Killer on the wild

Are you using Typo Killer on big repos? Send a PR adding it here! 🙂

• Elixir
• Ecto
• Phoenix
• Devise
• Simple Form
• Rails

Documentation

You can generate the documentation using command mix docs

Contributing

Feel free to suggest some new features or report bugs creating a new issue. Or even better, you can open a pull request! 😄