Packages
credo
1.2.1
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.7-rc.0
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.2-rc.4
1.7.2-rc.3
1.7.2-rc.2
1.7.2-rc.1
1.7.2-rc.0
1.7.1
1.7.0
1.7.0-rc.2
1.7.0-rc.1
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.5
1.5.0-rc.4
1.5.0-rc.3
1.5.0-rc.2
1.5.0-rc.1
1.4.1
1.4.0
1.4.0-rc.2
1.4.0-rc.1
1.3.2
1.3.1
1.3.0
1.3.0-rc3
1.3.0-rc2
1.3.0-rc1
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc4
1.2.0-rc3
1.2.0-rc2
1.2.0-rc1
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc3
1.1.0-rc2
1.1.0-rc1
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.1-rc1
1.0.0
1.0.0-rc1
0.10.2
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.9.0-rc8
0.9.0-rc7
0.9.0-rc6
0.9.0-rc5
0.9.0-rc4
0.9.0-rc3
0.9.0-rc2
0.9.0-rc1
0.8.10
0.8.9
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.8.0-rc7
0.8.0-rc6
0.8.0-rc5
0.8.0-rc4
0.8.0-rc3
0.8.0-rc2
0.8.0-rc1
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.6.0-rc2
0.6.0-rc1
0.5.3
0.5.2
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.10-dev
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-beta5
0.4.0-beta4
0.4.0-beta3
0.4.0-beta2
0.4.0-beta1
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.3.0-dev2
0.3.0-dev
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.1-dev
A static code analysis tool with a focus on code consistency and teaching.
Current section
Files
Jump to
Current section
Files
lib/credo/source_file.ex
defmodule Credo.SourceFile do
@moduledoc """
`SourceFile` structs represent a source file in the codebase.
"""
@type t :: %__MODULE__{
filename: nil | String.t(),
status: :valid | :invalid | :timed_out
}
alias Credo.Service.SourceFileAST
alias Credo.Service.SourceFileLines
alias Credo.Service.SourceFileSource
defstruct filename: nil,
status: nil
defimpl Inspect, for: __MODULE__ do
def inspect(source_file, _opts) do
"%SourceFile<#{source_file.filename}>"
end
end
@doc """
Returns a `SourceFile` struct for the given `source` code and `filename`.
"""
def parse(source, filename) do
filename = Path.relative_to_cwd(filename)
lines = Credo.Code.to_lines(source)
{valid, ast} =
case Credo.Code.ast(source) do
{:ok, ast} ->
{true, ast}
{:error, _errors} ->
{false, []}
end
SourceFileAST.put(filename, ast)
SourceFileLines.put(filename, lines)
SourceFileSource.put(filename, source)
%Credo.SourceFile{
filename: filename,
status: if(valid, do: :valid, else: :invalid)
}
end
@spec timed_out(String.t()) :: t
def timed_out(filename) do
filename = Path.relative_to_cwd(filename)
%Credo.SourceFile{
filename: filename,
status: :timed_out
}
end
@doc "Returns the AST for the given `source_file`."
def ast(source_file)
def ast(%__MODULE__{filename: filename}) do
case SourceFileAST.get(filename) do
{:ok, ast} ->
ast
_ ->
raise "Could not get source from ETS: #{filename}"
end
end
@doc "Returns the lines of source code for the given `source_file`."
def lines(source_file)
def lines(%__MODULE__{filename: filename}) do
case SourceFileLines.get(filename) do
{:ok, lines} ->
lines
_ ->
raise "Could not get source from ETS: #{filename}"
end
end
@doc "Returns the source code for the given `source_file`."
def source(source_file)
def source(%__MODULE__{filename: filename}) do
case SourceFileSource.get(filename) do
{:ok, source} ->
source
_ ->
raise "Could not get source from ETS: #{filename}"
end
end
@doc "Returns the source code and filename for the given `source_file_or_source`."
def source_and_filename(source_file_or_source, default_filename \\ "nofilename")
def source_and_filename(%__MODULE__{filename: filename} = source_file, _default_filename) do
{source(source_file), filename}
end
def source_and_filename(source, default_filename) when is_binary(source) do
{source, default_filename}
end
@doc """
Returns the line at the given `line_no`.
NOTE: `line_no` is a 1-based index.
"""
def line_at(%__MODULE__{} = source_file, line_no) do
source_file
|> lines()
|> Enum.find_value(&find_line_at(&1, line_no))
end
defp find_line_at({line_no, text}, line_no), do: text
defp find_line_at(_, _), do: nil
@doc """
Returns the snippet at the given `line_no` between `column1` and `column2`.
NOTE: `line_no` is a 1-based index.
"""
def line_at(%__MODULE__{} = source_file, line_no, column1, column2) do
source_file
|> line_at(line_no)
|> String.slice(column1 - 1, column2 - column1)
end
@doc """
Returns the column of the given `trigger` inside the given line.
NOTE: Both `line_no` and the returned index are 1-based.
"""
def column(source_file, line_no, trigger)
def column(%__MODULE__{} = source_file, line_no, trigger)
when is_binary(trigger) or is_atom(trigger) do
line = line_at(source_file, line_no)
regexed =
trigger
|> to_string
|> Regex.escape()
case Regex.run(~r/\b#{regexed}\b/, line, return: :index) do
nil ->
nil
result ->
{col, _} = List.first(result)
col + 1
end
end
def column(_, _, _), do: nil
end