Add columns to FIXME and TODO tag checks

lib/credo/check/design/tag_fixme.ex

@@ -40,11 +40,12 @@ defmodule Credo.Check.Design.TagFIXME do
     |> Enum.map(&issue_for(issue_meta, &1))
   end
 
-  defp issue_for(issue_meta, {line_no, _line, trigger}) do
+  defp issue_for(issue_meta, {line_no, column, _line, trigger}) do
     format_issue(
       issue_meta,
       message: "Found a #{@tag_name} tag in a comment: #{trigger}",
       line_no: line_no,
+      column: column,
       trigger: trigger
     )
   end

lib/credo/check/design/tag_helper.ex

@@ -29,8 +29,7 @@ defmodule Credo.Check.Design.TagHelper do
       |> Credo.Code.clean_charlists_strings_and_sigils()
       |> String.split("\n")
       |> Enum.with_index()
-      |> Enum.map(&find_tag_in_line(&1, regex))
-      |> Enum.filter(&tags?/1)
+      |> Enum.flat_map(&find_tag_in_line(&1, regex))
     else
       []
     end
@@ -41,7 +40,7 @@ defmodule Credo.Check.Design.TagHelper do
     if string =~ regex do
       trimmed = String.trim_trailing(string)
 
-      {nil, memo ++ [{meta[:line], trimmed, trimmed}]}
+      {nil, memo ++ [{meta[:line], meta[:column], trimmed, trimmed}]}
     else
       {ast, memo}
     end
@@ -58,9 +57,13 @@ defmodule Credo.Check.Design.TagHelper do
       |> List.wrap()
       |> Enum.map(&String.trim/1)
 
-    {index + 1, line, List.first(tag_list)}
-  end
+    if tag = List.first(tag_list) do
+      col =
+        Regex.run(~r"(.*)#"U, line) |> List.first("") |> String.length()
 
-  defp tags?({_line_no, _line, nil}), do: false
-  defp tags?({_line_no, _line, _tag}), do: true
+      [{index + 1, col, line, tag}]
+    else
+      []
+    end
+  end
 end

lib/credo/check/design/tag_todo.ex

@@ -39,11 +39,12 @@ defmodule Credo.Check.Design.TagTODO do
     |> Enum.map(&issue_for(issue_meta, &1))
   end
 
-  defp issue_for(issue_meta, {line_no, _line, trigger}) do
+  defp issue_for(issue_meta, {line_no, column, _line, trigger}) do
     format_issue(
       issue_meta,
       message: "Found a #{@tag_name} tag in a comment: #{trigger}",
       line_no: line_no,
+      column: column,
       trigger: trigger
     )
   end

test/credo/check/design/tag_fixme_test.exs

@@ -26,7 +26,7 @@
   # cases raising issues
   #
 
   test "it should report an issue" do
     """
     defmodule CredoSampleModule do
       use ExUnit.Case # TODO: this should not appear in the FIXME test
@@ -40,7 +40,10 @@
     """
     |> to_source_file
     |> run_check(@described_check)
-    |> assert_issue()
+    |> assert_issue(fn issue ->
+      assert issue.line_no == 4
+      assert issue.column == 3
+    end)
   end
 
   test "it should report an issue when lower case" do
@@ -84,7 +87,7 @@
     end)
   end
 
   test "it should report a couple of issues when including docstrings" do
     ~S'''
     defmodule CredoSampleModule do
       use ExUnit.Case # FIXME: this is the first

test/credo/check/design/tag_helper_test.exs

@@ -20,7 +20,7 @@
     assert [] == tags
   end
 
   test "it should return a tag with colon" do
     tags =
       """
       defmodule CredoSampleModule do
@@ -37,6 +37,7 @@
     expected = [
       {
         4,
+        19,
         "  def some_fun do # TODO: find a better name for this",
         "# TODO: find a better name for this"
       }
@@ -45,7 +46,7 @@
     assert expected == tags
   end
 
   test "it should return a tag without colon" do
     tags =
       """
       defmodule CredoSampleModule do
@@ -62,6 +63,7 @@
     expected = [
       {
         4,
+        19,
         "  def some_fun do # TODO find a better name for this",
         "# TODO find a better name for this"
       }
@@ -70,7 +72,7 @@
     assert expected == tags
   end
 
   test "it should report a violation when lower case" do
     tags =
       """
       defmodule CredoSampleModule do
@@ -88,6 +90,7 @@
     expected = [
       {
         4,
+        3,
         "  # todo find a better name for this",
         "# todo find a better name for this"
       }

test/credo/check/design/tag_todo_test.exs

@@ -73,7 +73,7 @@
   # cases raising issues
   #
 
   test "it should report an issue" do
     """
     defmodule CredoSampleModule do
       use ExUnit.Case # FIXME: this should not appear in the TODO test
@@ -87,10 +87,13 @@
     """
     |> to_source_file
     |> run_check(@described_check)
-    |> assert_issue()
+    |> assert_issue(fn issue ->
+      assert issue.line_no == 4
+      assert issue.column == 3
+    end)
   end
 
   test "it should report an issue for @doc tags" do
     """
     defmodule CredoSampleModule do
       @moduledoc \"\"\"
@@ -109,7 +112,7 @@
     |> assert_issue()
   end
 
   test "it should report an issue for @moduledoc tags" do
     """
     defmodule CredoSampleModule do
       @moduledoc \"\"\"
@@ -128,7 +131,7 @@
     |> assert_issue()
   end
 
   test "it should report an issue for @shortdoc tags" do
     """
     defmodule CredoSampleModule do
       @shortdoc \"\"\"
@@ -197,7 +200,7 @@
     |> assert_issue()
   end
 
   test "it should report an issue at the end of a line w/o space" do
     """
     defmodule CredoSampleModule do
       def some_fun do
@@ -251,7 +254,7 @@
     end)
   end
 
   test "it should report a couple of issues when including docs" do
     ~S'''
     defmodule CredoSampleModule do
       use ExUnit.Case # TODO: this is the first