Unify warnings under ExDoc.Utils.warn/1

Author: eksperimental

lib/ex_doc/autolink.ex

@@ -131,14 +131,12 @@ defmodule ExDoc.Autolink do
   end
 
   defp warn(message, {file, line}, id) do
-    warning = IO.ANSI.format([:yellow, "warning: ", :reset])
-
     stacktrace =
       "  #{file}" <>
         if(line, do: ":#{line}", else: "") <>
         if(id, do: ": #{id}", else: "")
 
-    IO.puts(:stderr, [warning, message, ?\n, stacktrace, ?\n])
+    ExDoc.Utils.warning([message, ?\n, stacktrace, ?\n])
   end
 
   defp warn(ref, file_line, id, visibility, metadata)

lib/ex_doc/formatter/epub.ex

@@ -75,7 +75,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.warning("file #{Path.relative_to_cwd(output)} already exists")
         end
 
         File.write!(output, html)

lib/ex_doc/formatter/html.ex

@@ -161,7 +161,7 @@ defmodule ExDoc.Formatter.HTML do
         :ok
 
       true ->
-        IO.warn(
+        ExDoc.Utils.warning(
           "ExDoc is outputting to an existing directory. " <>
             "Beware documentation output may be mixed with other entries"
         )
@@ -263,7 +263,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.warning("file #{Path.relative_to_cwd(output)} already exists")
         end
 
         File.write!(output, html)
@@ -556,7 +556,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.warning("#{filename} redirects to #{redirect_to}, which does not exist")
     end
 
     content = Templates.redirect_template(config, redirect_to)

lib/ex_doc/language.ex

@@ -142,12 +142,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
-    ExDoc.WarningCounter.increment()
-
-    IO.warn(
-      "skipping module #{module}, reason: unsupported language (#{language})",
-      []
-    )
+    ExDoc.Utils.warning("skipping module #{module}, reason: unsupported language (#{language})")
 
     :error
   end

lib/ex_doc/language/elixir.ex

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

lib/ex_doc/language/erlang.ex

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

lib/ex_doc/markdown/earmark.ex

@@ -48,8 +48,7 @@ defmodule ExDoc.Markdown.Earmark do
   defp print_messages(messages, options) do
     for {severity, line, message} <- messages do
       file = options[:file]
-      ExDoc.WarningCounter.increment()
-      IO.warn("#{inspect(__MODULE__)} (#{severity}) #{file}:#{line} #{message}", [])
+      ExDoc.Utils.warning("#{inspect(__MODULE__)} (#{severity}) #{file}:#{line} #{message}")
     end
   end
 

lib/ex_doc/retriever.ex

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

lib/ex_doc/utils.ex

@@ -147,4 +147,17 @@ defmodule ExDoc.Utils do
         nil
     end
   end
+
+  @doc """
+  Prints `message` as a warning in :stderr.
+
+  It automatically increases the counter in `ExDoc.WarningCounter`.
+  """
+  def warning(message) do
+    ExDoc.WarningCounter.increment()
+
+    prefix = IO.ANSI.format([:yellow, "warning: ", :reset])
+
+    IO.puts(:stderr, [prefix, message])
+  end
 end