Add internal ExDoc.Utils.warn/2, closes #1762

Author: wojtekmach

lib/ex_doc/autolink.ex

@@ -514,29 +514,23 @@ defmodule ExDoc.Autolink do
 
   @doc false
   def warn(config, message) do
-    # TODO: Remove on Elixir v1.14
-    stacktrace_info =
-      if unquote(Version.match?(System.version(), ">= 1.14.0")) do
-        f =
-          case config.current_kfa do
-            {:function, f, a} ->
-              [function: {f, a}]
+    f =
+      case config.current_kfa do
+        {:function, f, a} ->
+          [function: {f, a}]
 
-            _ ->
-              []
-          end
-
-        [file: config.file, line: config.line, module: config.current_module] ++ f
-      else
-        []
+        _ ->
+          []
       end
 
+    stacktrace_info = [file: config.file, line: config.line, module: config.current_module] ++ f
+
     case config.warnings do
       :emit ->
-        IO.warn(message, stacktrace_info)
+        ExDoc.Utils.warn(message, stacktrace_info)
 
       :raise ->
-        IO.warn(message, stacktrace_info)
+        ExDoc.Utils.warn(message, stacktrace_info)
         raise "fail due to warnings"
 
       :send ->

lib/ex_doc/doc_ast.ex

@@ -177,14 +177,14 @@ defmodule ExDoc.DocAST do
         try do
           render_code(pre_attr, lang, lexer, opts, code, outer_opts)
         rescue
-          e ->
-            IO.puts(:stderr, [
-              IO.ANSI.format([:yellow, "warning: ", :reset]),
-              "crashed while highlighting #{lang} snippet:\n\n",
-              full_block,
-              "\nFull error message shown next:\n\n",
-              Exception.format(:error, e, __STACKTRACE__)
-            ])
+          _ ->
+            ExDoc.Utils.warn(
+              [
+                "crashed while highlighting #{lang} snippet:\n\n",
+                full_block
+              ],
+              __STACKTRACE__
+            )
 
             full_block
         end

lib/ex_doc/formatter/epub.ex

@@ -61,7 +61,7 @@ defmodule ExDoc.Formatter.EPUB do
         html = Templates.extra_template(config, title, title_content, content)
 
         if File.regular?(output) do
-          IO.puts(:stderr, "warning: file #{Path.relative_to_cwd(output)} already exists")
+          ExDoc.Utils.warn("file #{Path.relative_to_cwd(output)} already exists", [])
         end
 
         File.write!(output, html)

lib/ex_doc/formatter/html.ex

@@ -246,7 +246,7 @@ defmodule ExDoc.Formatter.HTML do
         html = Templates.extra_template(config, node, extra_type(extension), nodes_map, refs)
 
         if File.regular?(output) do
-          IO.puts(:stderr, "warning: file #{Path.relative_to_cwd(output)} already exists")
+          ExDoc.Utils.warn("warning: file #{Path.relative_to_cwd(output)} already exists", [])
         end
 
         File.write!(output, html)
@@ -541,7 +541,7 @@ defmodule ExDoc.Formatter.HTML do
 
   defp generate_redirect(filename, config, redirect_to) do
     unless case_sensitive_file_regular?("#{config.output}/#{redirect_to}") do
-      IO.puts(:stderr, "warning: #{filename} redirects to #{redirect_to}, which does not exist")
+      ExDoc.Utils.warn("#{filename} redirects to #{redirect_to}, which does not exist", [])
     end
 
     content = Templates.redirect_template(config, redirect_to)

lib/ex_doc/language.ex

@@ -180,7 +180,7 @@ defmodule ExDoc.Language do
   def get(:erlang, _module), do: {:ok, ExDoc.Language.Erlang}
 
   def get(language, module) when is_atom(language) and is_atom(module) do
-    IO.warn(
+    ExDoc.Utils.warn(
       "skipping module #{module}, reason: unsupported language (#{language})",
       []
     )

lib/ex_doc/language/elixir.ex

@@ -39,7 +39,10 @@ defmodule ExDoc.Language.Elixir do
         }
 
       true ->
-        IO.warn("skipping docs for module #{inspect(module)}, reason: :no_debug_info", [])
+        ExDoc.Utils.warn(
+          "skipping docs for module #{inspect(module)}, reason: :no_debug_info",
+          []
+        )
     end
   end
 

lib/ex_doc/language/erlang.ex

@@ -58,7 +58,7 @@ defmodule ExDoc.Language.Erlang do
         }
       }
     else
-      IO.warn("skipping docs for module #{inspect(module)}, reason: :no_debug_info", [])
+      ExDoc.Utils.warn("skipping docs for module #{inspect(module)}, reason: :no_debug_info", [])
     end
   end
 

lib/ex_doc/markdown/earmark.ex

@@ -47,15 +47,7 @@ defmodule ExDoc.Markdown.Earmark do
 
   defp print_messages(messages, options) do
     for {_severity, line, message} <- messages do
-      # TODO: Remove on Elixir v1.14
-      stacktrace_info =
-        if unquote(Version.match?(System.version(), ">= 1.14.0")) do
-          [file: options[:file], line: line]
-        else
-          []
-        end
-
-      IO.warn(message, stacktrace_info)
+      ExDoc.Utils.warn(message, file: options[:file], line: line)
     end
   end
 

lib/ex_doc/retriever.ex

@@ -104,7 +104,7 @@ defmodule ExDoc.Retriever do
             docs
 
           {:error, reason} ->
-            IO.warn("skipping docs for module #{inspect(module)}, reason: #{reason}", [])
+            ExDoc.Utils.warn("skipping docs for module #{inspect(module)}, reason: #{reason}", [])
             false
         end
 

lib/ex_doc/utils.ex

@@ -1,6 +1,19 @@
 defmodule ExDoc.Utils do
   @moduledoc false
 
+  @doc """
+  Emits a warning.
+  """
+  def warn(message, stacktrace_info) do
+    if unquote(Version.match?(System.version(), ">= 1.14.0")) do
+      stacktrace_info
+    else
+      []
+    end
+
+    IO.warn(message, stacktrace_info)
+  end
+
   @doc """
   Runs the `before_closing_head_tag` callback.
   """

test/ex_doc/formatter/html_test.exs

@@ -120,7 +120,7 @@ defmodule ExDoc.Formatter.HTMLTest do
         generate_docs(doc_config(context, main: "Randomerror"))
       end)
 
-    assert output =~ "warning: index.html redirects to Randomerror.html, which does not exist\n"
+    assert output =~ "index.html redirects to Randomerror.html, which does not exist\n"
     assert File.regular?(tmp_dir <> "/html/index.html")
     assert File.regular?(tmp_dir <> "/html/RandomError.html")
   end