Summary

Types

rule/0

rule_config/0

target/0

rock(Config)

start()

Used when starting the application on the shell.

-type rule() ::
    {Module :: module(), Function :: atom(), RuleConfig :: rule_config()} |
    {Module :: module(), Function :: atom()}.

-type rule_config() :: #{atom() => term()}.

-type source_filename() :: nonempty_string().

-type target() :: source_filename() | module().

-spec do_rock(elvis_file:file(), elvis_config:configs() | elvis_config:config()) ->
           {ok, elvis_result:file()}.

-spec rock(elvis_config:configs()) ->
        ok | {fail, [{throw, term()} | elvis_result:file() | elvis_result:rule()]}.

-spec rock_this(target(), elvis_config:configs()) ->
             ok | {fail, [elvis_result:file() | elvis_result:rule()]}.

-spec start() -> ok.

Used when starting the application on the shell.