rule() = {Module::module(), Function::atom(), RuleConfig::rule_config()} | {Module::module(), Function::atom()}
rule_config() = #{atom() => term()}
source_filename() = nonempty_string()
target() = source_filename() | module()
apply_rule/2 | |
do_rock/2 | |
rock/1 | |
rock_this/2 | |
start/0 | Used when starting the application on the shell. |
apply_rule(X1::{Mod, Fun} | {Mod, Fun, RuleCfg}, X2::{Results, ElvisCfg, File}) -> Result
do_rock(File::elvis_file:file(), Config::elvis_config:configs() | elvis_config:config()) -> {ok, elvis_result:file()}
rock(Config::elvis_config:configs()) -> ok | {fail, [elvis_result:file()]}
rock_this(Module::target(), Config::elvis_config:configs()) -> ok | {fail, [elvis_result:file() | elvis_result:rule()]}
start() -> ok
Used when starting the application on the shell.
Generated by EDoc