elvis_core (elvis_core v4.1.0)

View Source

Summary

Functions

Used when starting the application on the shell.

Types

rule/0

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

rule_config/0

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

source_filename/0

-type source_filename() :: nonempty_string().

target/0

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

Functions

do_rock(File, Config)

main(_)

-spec main([]) -> true | no_return().

rock(Config)

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

rock_this(Module, Config)

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

start()

-spec start() -> ok.

Used when starting the application on the shell.