Packages
credo
1.2.0
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/command/gen.check.ex
defmodule Credo.CLI.Command.GenCheck do
@moduledoc false
@shortdoc "Create a new custom check"
@check_template_filename ".template.check.ex"
@default_check_template_file File.read!(@check_template_filename)
use Credo.CLI.Command
alias Credo.CLI.Output.UI
@doc false
def call(exec, _opts) do
exec.cli_options.args
|> List.first()
|> create_check_file
exec
end
defp create_check_file(nil) do
output = [
:red,
:bright,
"Please provide a filename:",
"\n\n",
" mix credo gen.check lib/my_first_credo_check.ex",
"\n"
]
UI.puts(output)
end
defp create_check_file(filename) do
check_name = check_name_for(filename)
if File.exists?(filename) do
UI.puts([:red, :bright, "File exists: #{filename}, aborted."])
else
write_template_file(filename, check_name)
UI.puts([:green, "* creating ", :reset, "#{filename}"])
UI.puts()
print_config_instructions(filename, check_name)
end
end
def check_name_for(filename) do
filename
|> String.replace(~r/(\A|(.+)\/)(lib|web)\//, "")
|> String.replace(~r/\.ex$/, "")
|> Macro.camelize()
|> String.replace(~r/\_/, "")
end
defp write_template_file(filename, check_name) do
filename
|> Path.dirname()
|> File.mkdir_p!()
assigns = [check_name: check_name]
contents = EEx.eval_string(@default_check_template_file, assigns: assigns)
File.write!(filename, contents)
end
defp print_config_instructions(filename, check_name) do
UI.puts("Add the generated file to the list of `requires` in `.credo.exs`:")
UI.puts()
UI.puts([
" requires: [",
:green,
"\"",
filename,
"\"",
:reset,
"], ",
:faint,
"# <-- add file here"
])
UI.puts()
UI.puts("Remember to add the generated module to the list of `checks`:")
UI.puts()
UI.puts([" checks: ["])
UI.puts([
" {",
:green,
check_name,
:reset,
"}, ",
:faint,
"# <-- add check here"
])
UI.puts([" ]"])
UI.puts()
UI.puts(["If you do not have a exec file yet, use `mix credo gen.config`"])
end
end