View Source Credo.Code.Module (Credo v1.7.2-rc.4)

This module provides helper functions to analyse modules, return the defined functions or module attributes.

Summary

Types

location()
module_part()

Functions

aliases(ast)

Returns the list of aliases defined in a given module source code.

analyze(ast)
attribute(ast, attr_name)

Reads an attribute from a module's ast

def_arity(ast)

Returns the arity of the given function definition ast

def_count(ast)

Returns the function/macro count for the given module's AST

def_name(arg1)

Returns the name of the function/macro defined in the given ast

def_name_with_op(ast)

Returns the {fun_name, op} tuple of the function/macro defined in the given ast

def_name_with_op(ast, arity)
def_names(ast)

Returns the name of the functions/macros for the given module's ast

def_names_with_op(ast)

Returns the name of the functions/macros for the given module's ast

def_names_with_op(ast, arity)

Returns the name of the functions/macros for the given module's ast if it has the given arity.

defs(ast)
exception?(arg1)
modules(ast)

Returns the list of modules used in a given module source code.

name(ast)

Returns the name of a module's given ast node.

Types

Link to this type

location()

View Source 
@type location() :: [line: pos_integer(), column: pos_integer()]
Link to this type

module_part()

View Source 
@type module_part() ::
  :moduledoc
  | :shortdoc
  | :behaviour
  | :use
  | :import
  | :alias
  | :require
  | :module_attribute
  | :defstruct
  | :opaque
  | :type
  | :typep
  | :callback
  | :macrocallback
  | :optional_callbacks
  | :public_fun
  | :private_fun
  | :public_macro
  | :private_macro
  | :public_guard
  | :private_guard
  | :callback_fun
  | :callback_macro
  | :module

Functions

Link to this function

aliases(ast)

View Source

Returns the list of aliases defined in a given module source code.

Link to this function

analyze(ast)

View Source 
@spec analyze(Macro.t()) :: [{module(), [{module_part(), location()}]}]
Link to this function

attribute(ast, attr_name)

View Source

Reads an attribute from a module's ast

Link to this function

def_arity(ast)

View Source

Returns the arity of the given function definition ast

Link to this function

def_count(ast)

View Source

Returns the function/macro count for the given module's AST

Link to this function

def_name(arg1)

View Source

Returns the name of the function/macro defined in the given ast

Link to this function

def_name_with_op(ast)

View Source

Returns the {fun_name, op} tuple of the function/macro defined in the given ast

Link to this function

def_name_with_op(ast, arity)

View Source
Link to this function

def_names(ast)

View Source

Returns the name of the functions/macros for the given module's ast

Link to this function

def_names_with_op(ast)

View Source

Returns the name of the functions/macros for the given module's ast

Link to this function

def_names_with_op(ast, arity)

View Source

Returns the name of the functions/macros for the given module's ast if it has the given arity.

Link to this function

defs(ast)

View Source
Link to this function

exception?(arg1)

View Source
Link to this function

modules(ast)

View Source

Returns the list of modules used in a given module source code.

Link to this function

name(ast)

View Source

Returns the name of a module's given ast node.