rebar3_sheldon

Hex.pm Version Hex.pm Downloads Build Status Erlang Versions

A rebar plugin for spellchecking.

Build

$ rebar3 compile

Use

Add the plugin to your rebar config:

{project_plugins, [{rebar3_sheldon, "~> 0.1.2"}]}.

Then just call your plugin directly in an existing application:

$ rebar3 spellcheck
===> Fetching rebar3_sheldon
===> Compiling rebar3_sheldon
===> Youre welcome. And if he has twins, we can do all kinds of neat experiments on them.:
test/test_SUITE.erl:1: The word "Speling" in string is unknown. Maybe you wanted to use "speeling" or "speiling" or ....?
test/test_SUITE.erl:2: The word "Commt" in string is unknown. Maybe you wanted to use "commit" or "commot" or "comdt" ...?
test/test_SUITE.erl:2: The word "fdfdf" in string is unknown.
test/test_SUITE.erl:3: The word "Unicode" in comment is unknown. Maybe you wanted to use "uncoded"?

Config

Example:

{spellcheck, [
{files, ["src/*.erl", "src/*/*.erl", "include/*.hrl"]},
{ignore, ["src/*_ignore.erl"]},
{ignore_regex, "[_@./#&+-=*]"},
{options, #{dummy => option}}
]}.