Clarify :trigger for issues

rrrene · Dec 14, 2023 · 0f4393f · 0f4393f
1 parent 14aaf35
commit 0f4393f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/lib/credo/check.ex b/lib/credo/check.ex
@@ -634,7 +634,7 @@ defmodule Credo.Check do
   options to `format_issue/2`:
 
   - `:priority`     Sets the issue's priority.
-  - `:trigger`      Sets the issue's trigger.
+  - `:trigger`      Sets the issue's trigger, i.e. the text causing the issue (see `Credo.Check.Warning.IoInspect`).
   - `:line_no`      Sets the issue's line number. Tries to find `column` if `:trigger` is supplied.
   - `:column`       Sets the issue's column.
   - `:exit_status`  Sets the issue's exit_status.

diff --git a/lib/credo/check/refactor/negated_is_nil.ex b/lib/credo/check/refactor/negated_is_nil.ex
@@ -53,11 +53,13 @@ defmodule Credo.Check.Refactor.NegatedIsNil do
 
   defp traverse({:when, meta, [_, {negation, _, [{:is_nil, _, _}]}]} = ast, issues, issue_meta)
        when negation in [:!, :not] do
+    trigger = to_string(negation)
+
     issue =
       format_issue(
         issue_meta,
         message: "Negated is_nil in guard clause found",
-        trigger: "when !/not is_nil",
+        trigger: trigger,
         line_no: meta[:line]
       )