View Source elvis_file (elvis_core v3.2.2)
Summary
Functions
Filter files based on the glob provided.
Returns all files under the specified Path that match the pattern Name.
Loads and adds all related file data.
Return module name corresponding to a given .hrl/.erl/.beam file
Add the root node of the parse tree to the file data.
Add the root node of the parse tree to the file data, with filtering.
Given a file() returns its path.
Returns a tuple with the contents of the file and the file itself.
Types
-type file() :: #{path => string(), content => binary(), _ => _}.
Functions
-spec find_files([string()], string()) -> [file()].
-spec load_file_data(elvis_config:configs() | elvis_config:config(), file()) -> file().
-spec module(file()) -> module().
-spec parse_tree(elvis_config:configs() | elvis_config:config(), file()) -> {ktn_code:tree_node(), file()}.
-spec parse_tree(elvis_config:configs() | elvis_config:config(), file(), elvis_core:rule_config()) -> {ktn_code:tree_node(), file()}.
-spec path(file()) -> string().