improvement: Publish related_packages as part of the searchNodes var.

Author: jimsynz

lib/ex_doc/config.ex

@@ -44,6 +44,7 @@ defmodule ExDoc.Config do
             proglang: :elixir,
             project: nil,
             redirects: %{},
+            related_packages: [],
             retriever: ExDoc.Retriever,
             skip_undefined_reference_warnings_on:
               &__MODULE__.skip_undefined_reference_warnings_on/1,
@@ -87,6 +88,7 @@ defmodule ExDoc.Config do
           package: :atom | nil,
           project: nil | String.t(),
           redirects: %{optional(String.t()) => String.t()} | [{String.t(), String.t()}],
+          related_packages: [:atom | %{name: :atom, version: Version.t()}],
           retriever: atom(),
           skip_undefined_reference_warnings_on: (String.t() -> boolean),
           skip_code_autolink_to: (String.t() -> boolean),

lib/ex_doc/formatter/html.ex

@@ -193,7 +193,7 @@ defmodule ExDoc.Formatter.HTML do
   end
 
   defp generate_search_data(linked, extras, config) do
-    content = SearchData.create(linked, extras, config.proglang)
+    content = SearchData.create(linked, extras, config)
     path = "dist/search_data-#{digest(content)}.js"
     File.write!(Path.join(config.output, path), content)
     [path]

lib/ex_doc/formatter/html/search_data.ex

@@ -2,22 +2,51 @@ defmodule ExDoc.Formatter.HTML.SearchData do
   @moduledoc false
   alias ExDoc.Utils
 
-  def create(nodes, extras, proglang) do
+  def create(nodes, extras, config) do
     items = Enum.flat_map(nodes, &module/1) ++ Enum.flat_map(extras, &extra/1)
 
-    data = %{
-      items: items,
-      content_type: "text/markdown",
-      proglang: proglang,
-      producer: %{
-        name: "ex_doc",
-        version: to_string(Application.spec(:ex_doc)[:vsn])
+    search_data =
+      %{
+        items: items,
+        content_type: "text/markdown",
+        proglang: config.proglang,
+        producer: %{
+          name: "ex_doc",
+          version: to_string(Application.spec(:ex_doc)[:vsn])
+        }
       }
-    }
 
-    ["searchData=" | ExDoc.Utils.to_json(data)]
+    search_nodes =
+      [
+        %{name: config.package, version: config.version}
+      ]
+      |> maybe_append_related_packages(config.related_packages)
+
+    [
+      "searchData=",
+      ExDoc.Utils.to_json(search_data),
+      "\nsearchNodes=",
+      ExDoc.Utils.to_json(search_nodes)
+    ]
+  end
+
+  defp maybe_append_related_packages(search_nodes, related_packages)
+       when length(related_packages) > 0 do
+    related_packages =
+      related_packages
+      |> Enum.map(fn
+        %{name: name, version: version} ->
+          %{name: name, version: to_string(version)}
+
+        name when is_atom(name) ->
+          %{name: name, version: "*"}
+      end)
+
+    Enum.concat(search_nodes, related_packages)
   end
 
+  defp maybe_append_related_packages(search_nodes, _related_packages), do: search_nodes
+
   defp extra(map) do
     if custom_search_data = map[:search_data] do
       extra_search_data(map, custom_search_data)

lib/ex_doc/formatter/html/templates/head_template.eex

@@ -21,7 +21,7 @@
       <link rel="canonical" href="<%= config.canonical %>" />
     <% end %>
     <script defer src="<%= Assets.rev config.output, "dist/sidebar_items-*.js" %>"></script>
-    <script defer src="docs_config.js"></script>
+    <script defer src="<%= Assets.rev config.output, "dist/search_data-*.js" %>"></script>
     <script defer src="dist/<%= Assets.js_filename() %>"></script>
     <%= before_closing_head_tag(config, :html) %>
   </head>