Packages
credo
1.1.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/check/readability/string_sigils.ex
defmodule Credo.Check.Readability.StringSigils do
@moduledoc false
@checkdoc ~S"""
If you used quoted strings that contain quotes, you might want to consider
switching to the use of sigils instead.
# okay
"<a href=\"http://elixirweekly.net\">#\{text}</a>"
# not okay, lots of escaped quotes
"<a href=\"http://elixirweekly.net\" target=\"_blank\">#\{text}</a>"
# refactor to
~S(<a href="http://elixirweekly.net" target="_blank">#\{text}</a>)
This allows us to remove the noise which results from the need to escape
quotes within quotes.
"""
@explanation [
check: @checkdoc,
params: [
maximum_allowed_quotes: "The maximum amount of escaped quotes you want to tolerate."
]
]
@default_params [
maximum_allowed_quotes: 3
]
@quote_codepoint 34
alias Credo.SourceFile
alias Credo.Code.Heredocs
use Credo.Check, base_priority: :low
@doc false
def run(source_file, params \\ []) do
issue_meta = IssueMeta.for(source_file, params)
maximum_allowed_quotes = Params.get(params, :maximum_allowed_quotes, @default_params)
case remove_heredocs_and_convert_to_ast(source_file) do
{:ok, ast} ->
Credo.Code.prewalk(ast, &traverse(&1, &2, issue_meta, maximum_allowed_quotes))
{:error, errors} ->
IO.warn("Unexpected error while parsing #{source_file.filename}: #{inspect(errors)}")
[]
end
end
defp remove_heredocs_and_convert_to_ast(source_file) do
source_file
|> Heredocs.replace_with_spaces()
|> Credo.Code.ast()
end
defp traverse(
{maybe_sigil, meta, [str | rest_ast]} = ast,
issues,
issue_meta,
maximum_allowed_quotes
) do
line_no = meta[:line]
cond do
is_sigil(maybe_sigil) ->
{rest_ast, issues}
is_binary(str) ->
{
rest_ast,
issues_for_string_literal(
str,
maximum_allowed_quotes,
issues,
issue_meta,
line_no
)
}
true ->
{ast, issues}
end
end
defp traverse(ast, issues, _issue_meta, _maximum_allowed_quotes) do
{ast, issues}
end
defp is_sigil(maybe_sigil) when is_atom(maybe_sigil) do
maybe_sigil
|> Atom.to_string()
|> String.starts_with?("sigil_")
end
defp is_sigil(_), do: false
defp issues_for_string_literal(
string,
maximum_allowed_quotes,
issues,
issue_meta,
line_no
) do
if too_many_quotes?(string, maximum_allowed_quotes) do
[issue_for(issue_meta, line_no, string, maximum_allowed_quotes) | issues]
else
issues
end
end
defp too_many_quotes?(string, limit) do
too_many_quotes?(string, 0, limit)
end
defp too_many_quotes?(_string, count, limit) when count > limit do
true
end
defp too_many_quotes?(<<>>, _count, _limit) do
false
end
defp too_many_quotes?(<<c::utf8, rest::binary>>, count, limit)
when c == @quote_codepoint do
too_many_quotes?(rest, count + 1, limit)
end
defp too_many_quotes?(<<_::utf8, rest::binary>>, count, limit) do
too_many_quotes?(rest, count, limit)
end
defp too_many_quotes?(<<_::binary>>, _count, _limit) do
false
end
defp issue_for(issue_meta, line_no, trigger, maximum_allowed_quotes) do
format_issue(
issue_meta,
message:
"More than #{maximum_allowed_quotes} quotes found inside string literal, consider using a sigil instead.",
trigger: trigger,
line_no: line_no
)
end
end