elvis_code (elvis_core v5.0.1)

View Source

Summary

Types

tree_node/0

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

tree_node_zipper/0

-type tree_node_zipper() :: zipper:zipper(tree_node()).

Functions

find(Options)

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

root(Rule, ElvisConfig)

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

zipper(Root)

-spec zipper(tree_node()) -> tree_node_zipper().