elvis_core (elvis_core v5.0.3)

View Source

Summary

Types

error/0
rock_result/0
source_filename/0
target/0
warning/0

Functions

do_rock(File, ElvisConfig)
main(_)
rock()
rock(FileOrConfig)
rock(FileOrConfig, Files)
start()

Used when starting the application on the shell.

Types

error/0

-type error() :: _.

rock_result/0

-type rock_result() :: ok | {errors, [error()]} | {warnings, [warning()]}.

source_filename/0

-type source_filename() :: nonempty_string().

target/0

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

warning/0

-type warning() :: _.

Functions

do_rock(File, ElvisConfig)

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

main(_)

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

rock()

-spec rock() -> rock_result().

rock(FileOrConfig)

-spec rock(FileOrConfig) -> rock_result()
              when FileOrConfig :: {config_file, default | string()} | {config, [elvis_config:t()]}.

rock(FileOrConfig, Files)

-spec rock(FileOrConfig, Files) -> rock_result()
              when
                  FileOrConfig :: {config_file, default | string()} | {config, [elvis_config:t()]},
                  Files :: {files, undefined | [string()]}.

start()

-spec start() -> ok.

Used when starting the application on the shell.