View Source elvis_file (elvis_core v3.2.5)

Summary

Types

file/0

Functions

filter_files(Files, Dirs, Filter, IgnoreList)

Filter files based on the glob provided.

find_files(Dirs, Pattern)

Returns all files under the specified Path that match the pattern Name.

load_file_data(Config, File0)

Loads and adds all related file data.

module(_)

Return module name corresponding to a given .hrl/.erl/.beam file

parse_tree(Config, Target)

Add the root node of the parse tree to the file data.

parse_tree(Config, File, RuleConfig)

Add the root node of the parse tree to the file data, with filtering.

path(File)

Given a file() returns its path.

src(File)

Returns a tuple with the contents of the file and the file itself.

Types

file/0

-type file() :: #{path => string(), content => binary(), _ => _}.

Functions

filter_files(Files, Dirs, Filter, IgnoreList)

-spec filter_files([file()], [string()], string(), [string()]) -> [file()].

Filter files based on the glob provided.

find_files(Dirs, Pattern)

-spec find_files([string()], string()) -> [file()].

Returns all files under the specified Path that match the pattern Name.

load_file_data(Config, File0)

-spec load_file_data(elvis_config:configs() | elvis_config:config(), file()) -> file().

Loads and adds all related file data.

module(_)

-spec module(file()) -> module().

Return module name corresponding to a given .hrl/.erl/.beam file

parse_tree(Config, Target)

-spec parse_tree(elvis_config:configs() | elvis_config:config(), file()) ->
                    {ktn_code:tree_node(), file()}.

Add the root node of the parse tree to the file data.

parse_tree(Config, File, RuleConfig)

-spec parse_tree(elvis_config:configs() | elvis_config:config(), file(), elvis_core:rule_config()) ->
                    {ktn_code:tree_node(), file()}.

Add the root node of the parse tree to the file data, with filtering.

path(File)

-spec path(file()) -> string().

Given a file() returns its path.

src(File)

-spec src(file()) -> {binary(), file()} | {error, enoent}.

Returns a tuple with the contents of the file and the file itself.