elvis_core (elvis_core v2.0.0)
Link to this section Summary
Functions
Used when starting the application on the shell.
Link to this section Types
Link to this type
rule/0
-type rule() :: {Module :: module(), Function :: atom(), RuleConfig :: rule_config()} | {Module :: module(), Function :: atom()}.
Link to this type
rule_config/0
-type rule_config() :: #{atom() => term()}.
Link to this type
source_filename/0
-type source_filename() :: nonempty_string().
Link to this type
target/0
-type target() :: source_filename() | module().
Link to this section Functions
Link to this function
do_rock(File, Config)
-spec do_rock(elvis_file:file(), elvis_config:configs() | elvis_config:config()) -> {ok, elvis_result:file()}.
Link to this function
rock(Config)
-spec rock(elvis_config:configs()) -> ok | {fail, [elvis_result:file()]}.
Link to this function
rock_this(Module, Config)
-spec rock_this(target(), elvis_config:configs()) -> ok | {fail, [elvis_result:file() | elvis_result:rule()]}.
Link to this function
start()
-spec start() -> ok.