elvis_code (elvis_core v5.0.3)

View Source

Summary

Functions

Debugging utility function.

Debugging utility function.

Types

ancestors/0

-type ancestors() :: [tree_node()].

tree_node/0

-type tree_node() :: ktn_code:tree_node().

Functions

find(Options)

-spec find(Options) -> {nodes, [Node]} | {nodes_and_ancestors, [{Node, ancestors()}]}
              when
                  Options ::
                      #{of_types := [ktn_code:tree_node_type()] | undefined,
                        inside := Node,
                        filtered_by => fun((Node | {Node, ancestors()}) -> boolean()),
                        filtered_from => node | node_and_ancestors,
                        traverse => content | all},
                  Node :: tree_node().

root(Rule, ElvisConfig)

-spec root(Rule, ElvisConfig) -> Res
              when Rule :: elvis_rule:t(), ElvisConfig :: elvis_config:t(), Res :: ktn_code:tree_node().