Current section

Files

Jump to
credo lib credo check consistency line_endings.ex
Raw

lib/credo/check/consistency/line_endings.ex

defmodule Credo.Check.Consistency.LineEndings do
@moduledoc """
Windows and *nix systems use different line-endings in files.
While this is not necessarily a concern for the correctness of your code,
you should use a consistent style throughout your codebase.
"""
@explanation [check: @moduledoc]
@code_patterns [
Credo.Check.Consistency.LineEndings.Unix,
Credo.Check.Consistency.LineEndings.Windows
]
alias Credo.Check.Consistency.Helper
alias Credo.Check.PropertyValue
use Credo.Check, run_on_all: true, base_priority: :high
@doc false
def run(source_files, params \\ []) when is_list(source_files) do
source_files
|> Helper.run_code_patterns(@code_patterns, params)
|> Helper.add_issues_to_source_files(&issue_for/5, params)
end
defp issue_for(_issue_meta, _actual_props, nil, _picked_count, _total_count), do: nil
defp issue_for(_issue_meta, [], _expected_prop, _picked_count, _total_count), do: nil
defp issue_for(issue_meta, actual_prop, expected_prop, _picked_count, _total_count) do
actual_prop = PropertyValue.get(actual_prop)
format_issue issue_meta,
message: "File is using #{actual_prop} line endings while most of the files use #{expected_prop} line endings."
end
end