Credo Plus v1.0.1 Credo.SourceFile View Source

SourceFile structs represent a source file in the codebase.

Link to this section Summary

t()

Retuns the AST for the given source_file

Returns the column of the given trigger inside the given line

Returns the line at the given line_no

Returns the snippet at the given line_no between column1 and column2

Retuns the lines of source code for the given source_file

Retuns a SourceFile struct for the given source code and filename

Retuns the source code for the given source_file

t()

t() :: %Credo.SourceFile{
  filename: nil | String.t(),
  status: :valid | :invalid | :timed_out
}

ast(source_file)

Retuns the AST for the given source_file.

column(source_file, line_no, trigger)

Returns the column of the given trigger inside the given line.

NOTE: Both line_no and the returned index are 1-based.

line_at(source_file, line_no)

Returns the line at the given line_no.

NOTE: line_no is a 1-based index.

line_at(source_file, line_no, column1, column2)

Returns the snippet at the given line_no between column1 and column2.

NOTE: line_no is a 1-based index.

lines(source_file)

Retuns the lines of source code for the given source_file.

parse(source, filename)

Retuns a SourceFile struct for the given source code and filename.

source(source_file)

Retuns the source code for the given source_file.

timed_out(filename)

timed_out(String.t()) :: t()