View Source elvis_core (elvis_core v3.1.0)

Link to this section Summary

Functions

Used when starting the application on the shell.

Link to this section Types

-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().

Link to this section Functions

-spec rock(elvis_config:configs()) -> ok | {fail, [elvis_result:file()]}.
Link to this function

rock_this(Module, Config)

View Source
-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.