elvis_core (elvis_core v4.2.0)

View Source

Summary

Types

source_filename/0

-type source_filename() :: nonempty_string().

target/0

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

Functions

do_rock(File, ElvisConfig)

-spec do_rock(elvis_file:t(), [elvis_config:t()] | elvis_config:t()) -> {ok, elvis_result:file()}.

main(_)

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

rock(ElvisConfig)

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

rock_this(Module, ElvisConfig)

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

start()

-spec start() -> ok.

Used when starting the application on the shell.