Module elvis_core

Data Types
Function Index
Function Details

Data Types

rule()

rule() = {Module::module(), Function::atom(), RuleConfig::rule_config()} | {Module::module(), Function::atom()}

rule_config()

rule_config() = #{atom() => term()}

source_filename()

source_filename() = nonempty_string()

target()

target() = source_filename() | module()

Function Index

apply_rule/2
do_rock/2
rock/1
rock_this/2
start/0	Used when starting the application on the shell.

Function Details

apply_rule/2

apply_rule(X1::{Mod, Fun} | {Mod, Fun, RuleCfg}, X2::{Results, ElvisCfg, File}) -> Result

Mod = module()
Fun = atom()
RuleCfg = rule_config()
Results = [elvis_result:rule()]
ElvisCfg = elvis_config:config()
File = elvis_file:file()
Result = {Results, ElvisCfg, File}

do_rock/2

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

rock/1

rock(Config::elvis_config:configs()) -> ok | {fail, [elvis_result:file()]}

rock_this/2

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

start/0

start() -> ok

Used when starting the application on the shell.

Generated by EDoc