Packages
credo
0.8.9
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/check/readability/max_line_length.ex
defmodule Credo.Check.Readability.MaxLineLength do
@moduledoc """
Checks for the length of lines.
Ignores function definitions and (multi-)line strings by default.
"""
@explanation [
check: @moduledoc,
params: [
max_length: "The maximum number of characters a line may consist of.",
ignore_definitions: "Set to `true` to ignore lines including function definitions.",
ignore_specs: "Set to `true` to ignore lines including `@spec`s.",
ignore_strings: "Set to `true` to ignore lines that are strings or in heredocs",
]
]
@default_params [
max_length: 80,
ignore_definitions: true,
ignore_specs: false,
ignore_strings: true
]
@def_ops [:def, :defp, :defmacro]
use Credo.Check, base_priority: :low
@doc false
def run(source_file, params \\ []) do
issue_meta = IssueMeta.for(source_file, params)
max_length = Params.get(params, :max_length, @default_params)
ignore_definitions = Params.get(params, :ignore_definitions, @default_params)
ignore_specs = Params.get(params, :ignore_specs, @default_params)
ignore_strings = Params.get(params, :ignore_strings, @default_params)
# TODO v1.0: this should be two different params
ignore_heredocs = ignore_strings
definitions = Credo.Code.prewalk(source_file, &find_definitions/2)
specs = Credo.Code.prewalk(source_file, &find_specs/2)
source = SourceFile.source(source_file)
source =
if ignore_heredocs do
Credo.Code.Heredocs.replace_with_spaces(source, "")
else
source
end
lines = Credo.Code.to_lines(source)
Enum.reduce(lines, [], fn({line_no, line}, issues) ->
line_for_comparison =
if ignore_strings do
Credo.Code.Strings.replace_with_spaces(line, "")
else
line
end
if String.length(line_for_comparison) > max_length do
if refute_issue?(line_no, definitions, ignore_definitions, specs, ignore_specs) do
issues
else
[issue_for(line_no, max_length, line, issue_meta) | issues]
end
else
issues
end
end)
end
for op <- @def_ops do
defp find_definitions({unquote(op), meta, arguments} = ast, definitions) when is_list(arguments) do
{ast, [meta[:line] | definitions]}
end
end
defp find_definitions(ast, definitions) do
{ast, definitions}
end
defp find_specs({:spec, meta, arguments} = ast, specs) when is_list(arguments) do
{ast, [meta[:line] | specs]}
end
defp find_specs(ast, specs) do
{ast, specs}
end
defp refute_issue?(line_no, definitions, ignore_definitions, specs, ignore_specs) do
ignore_definitions? =
if ignore_definitions do
Enum.member?(definitions, line_no)
else
false
end
ignore_specs? =
if ignore_specs do
Enum.member?(specs, line_no)
else
false
end
ignore_definitions? || ignore_specs?
end
defp issue_for(line_no, max_length, line, issue_meta) do
line_length = String.length(line)
column = max_length + 1
trigger = String.slice(line, max_length, line_length - max_length)
format_issue issue_meta,
message: "Line is too long (max is #{max_length}, was #{line_length}).",
line_no: line_no,
column: column,
trigger: trigger
end
end