Packages
credo
0.7.4
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/cli/output/categories.ex
defmodule Credo.CLI.Output.Categories do
alias Credo.CLI.Output
alias Credo.CLI.Output.UI
@order [:readability, :design, :refactor, :warning, :consistency]
@category_colors [
design: :olive,
readability: :blue,
refactor: :yellow,
warning: :red,
consistency: :cyan,
]
@category_titles [
design: "Software Design",
readability: "Code Readability",
refactor: "Refactoring opportunities",
warning: "Warnings - please take a look",
consistency: "Consistency",
]
@category_texts [
consistency: """
These checks take a look at your code and ensure a consistent coding style.
Using tabs or spaces? Both is fine, just don't mix them or Credo will tell
you.
""",
readability: """
Readability checks do not concern themselves with the technical correctness
of your code, but how easy it is to digest.
""",
refactor: """
The Refactor checks show you opportunities to avoid future problems and
technical debt.
""",
design: """
While refactor checks show you possible problems, these checks try to
highlight possibilities, like - potentially intended - duplicated code or
TODO and FIXME comments.
""",
warning: """
These checks warn you about things that are potentially dangerous, like a
missed call to `IEx.pry` you put in during a debugging session or a call
to String.downcase without using the result.
""",
]
def print do
@order
|> Enum.each(&print_category/1)
end
defp print_category(category) do
term_width = Output.term_columns
color = @category_colors[category]
title = @category_titles[category]
UI.puts
[
:bright, "#{color}_background" |> String.to_atom, color, " ",
Output.foreground_color(color), :normal,
" #{title}" |> String.ljust(term_width - 1),
]
|> UI.puts
color
|> UI.edge
|> UI.puts
@category_texts[category]
|> String.split("\n")
|> Enum.each(&print_line(&1, color))
end
defp print_line(line, color) do
[UI.edge(color), " ", :reset, line]
|> UI.puts
end
end