README.md

![](http://i.giphy.com/M3EZtLUDLsYP6.gif)

# Sheldon

Very Simple Erlang Spell Checker.

## Contact Us
For **questions** or **general comments** regarding the use of this library,
please use our public [hipchat room](http://inaka.net/hipchat).

If you find any **bugs** or have a **problem** while using this library, please
[open an issue](https://github.com/inaka/sheldon/issues/new) in this repo
(or a pull request :)).

And you can check all of our open-source projects at [inaka.github.io](http://inaka.github.io).

## Installation

1. Clone the repo
2. `rebar3 compile`

## Usage

### Erlang Shell

First of all Sheldon is an application and it needs to be started. You can use `rebar3 shell` to set the necessary paths, then use `sheldon:start/0` or `application:ensure_all_started(sheldon)` in order to start Sheldon but if you are using Sheldon as a dependency you can let OTP starts it from your_app.app file too.

Sheldon only has two main methods, `sheldon:check/1` and `sheldon:check/2`. As a user, you just need to use those.

```erlang
1> sheldon:check("I want to check this correct text").
ok
2> sheldon:check("I want to check this misspellllled text").
#{bazinga => "Too bad, I'll have a virgin Cuba Libre.",
  misspelled_words => [#{line_number => 1,word => "misspellllled"}]}
```

## Configuration

`sheldon:check/2` works like `sheldon:check/1` but it accepts a Configuration parameter.
With this Conf parameter we can apply some rules to the text we want to check. Those rules are ignore words, ignore patterns and ignore blocks.

This is the format (see [sheldon_config.erl](https://github.com/inaka/sheldon/blob/master/src/sheldon_config.erl)), no key is required:

```erlang
#{ ignore_words    => [string()]
 , ignore_patterns => [regex()]
 , ignore_blocks   => [ignore_block()]
 }.
```
Then, if we call the previous `sheldon:check/1` but with configuration we can skip the error

```erlang
3> sheldon:check("I want to check this misspellllled text", #{ignore_words => ["misspellllled"]}).
ok
```

## Results

`sheldon:check/1` and `sheldon:check/2` have the same result type, you can see [sheldon_result.erl](https://github.com/inaka/sheldon/blob/master/src/sheldon_result.erl). Sheldon will return the `ok` atom if the check went well else it'll return
```erlang
    #{ misspelled_words := [misspelled_word()]
     , bazinga          := string()
     }.
```

## Dependencies

- Erlang/OTP 19+ in order to use it.
- Erlang/OTP 19.0.2+ in order to test it.