Refactor markdown output paths in tests to align with updated directory structure

Author: yordis

lib/ex_doc/formatter/markdown.ex

@@ -39,11 +39,7 @@ defmodule ExDoc.Formatter.Markdown do
   end
 
   defp normalize_config(config) do
-    output =
-      config.output
-      |> Path.expand()
-      |> Path.join("markdown")
-
+    output = Path.expand(config.output)
     %{config | output: output}
   end
 

test/ex_doc/formatter/markdown_test.exs

@@ -24,34 +24,34 @@ defmodule ExDoc.Formatter.MarkdownTest do
 
   test "generates Markdown files in the default directory", %{tmp_dir: tmp_dir} = context do
     generate_docs(doc_config(context))
-    assert File.regular?(tmp_dir <> "/markdown/index.md")
-    assert File.regular?(tmp_dir <> "/markdown/CompiledWithDocs.md")
+    assert File.regular?(tmp_dir <> "/index.md")
+    assert File.regular?(tmp_dir <> "/CompiledWithDocs.md")
   end
 
   test "generates headers for module pages", %{tmp_dir: tmp_dir} = context do
     generate_docs(doc_config(context, main: "RandomError"))
 
-    content = File.read!(tmp_dir <> "/markdown/RandomError.md")
+    content = File.read!(tmp_dir <> "/RandomError.md")
     assert content =~ ~r{^# RandomError}m
     assert content =~ ~r{\(Elixir v1\.0\.1\)}
   end
 
   test "generates all listing files", %{tmp_dir: tmp_dir} = context do
     generate_docs(doc_config(context))
 
-    assert File.regular?(tmp_dir <> "/markdown/CompiledWithDocs.md")
-    assert File.regular?(tmp_dir <> "/markdown/CompiledWithDocs.Nested.md")
-    assert File.regular?(tmp_dir <> "/markdown/CustomBehaviourOne.md")
-    assert File.regular?(tmp_dir <> "/markdown/CustomBehaviourTwo.md")
-    assert File.regular?(tmp_dir <> "/markdown/RandomError.md")
-    assert File.regular?(tmp_dir <> "/markdown/CustomProtocol.md")
-    assert File.regular?(tmp_dir <> "/markdown/Mix.Tasks.TaskWithDocs.md")
+    assert File.regular?(tmp_dir <> "/CompiledWithDocs.md")
+    assert File.regular?(tmp_dir <> "/CompiledWithDocs.Nested.md")
+    assert File.regular?(tmp_dir <> "/CustomBehaviourOne.md")
+    assert File.regular?(tmp_dir <> "/CustomBehaviourTwo.md")
+    assert File.regular?(tmp_dir <> "/RandomError.md")
+    assert File.regular?(tmp_dir <> "/CustomProtocol.md")
+    assert File.regular?(tmp_dir <> "/Mix.Tasks.TaskWithDocs.md")
   end
 
   test "generates the index file", %{tmp_dir: tmp_dir} = context do
     generate_docs(doc_config(context))
 
-    content = File.read!(tmp_dir <> "/markdown/index.md")
+    content = File.read!(tmp_dir <> "/index.md")
     assert content =~ ~r{^# Elixir v1\.0\.1 - Documentation - Table of Contents$}m
     assert content =~ ~r{## Modules}
     assert content =~ ~r{- \[CompiledWithDocs\]\(CompiledWithDocs\.md\)}
@@ -61,7 +61,7 @@ defmodule ExDoc.Formatter.MarkdownTest do
   test "generates module with proper structure", %{tmp_dir: tmp_dir} = context do
     generate_docs(doc_config(context))
 
-    content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.md")
+    content = File.read!(tmp_dir <> "/CompiledWithDocs.md")
 
     # Header
     assert content =~ ~r{^# CompiledWithDocs  \(Elixir v1\.0\.1\)}m
@@ -81,7 +81,7 @@ defmodule ExDoc.Formatter.MarkdownTest do
   test "generates functions correctly", %{tmp_dir: tmp_dir} = context do
     generate_docs(doc_config(context))
 
-    content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.md")
+    content = File.read!(tmp_dir <> "/CompiledWithDocs.md")
 
     # Function in ToC
     assert content =~ ~r{####.*\[`example\(foo, bar}
@@ -116,14 +116,14 @@ defmodule ExDoc.Formatter.MarkdownTest do
 
       generate_docs(config)
 
-      refute File.exists?(tmp_dir <> "/markdown/elixir.md")
+      refute File.exists?(tmp_dir <> "/elixir.md")
     end
   end
 
   test "generates LLM index file", %{tmp_dir: tmp_dir} = context do
     generate_docs(doc_config(context))
 
-    content = File.read!(tmp_dir <> "/markdown/llms.txt")
+    content = File.read!(tmp_dir <> "/llms.txt")
 
     assert content =~ ~r{# Elixir 1\.0\.1}
     assert content =~ ~r{Elixir documentation index for Large Language Models}
@@ -134,7 +134,7 @@ defmodule ExDoc.Formatter.MarkdownTest do
   describe "markdown output validation" do
     test "generates proper markdown syntax", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
-      content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.md")
+      content = File.read!(tmp_dir <> "/CompiledWithDocs.md")
 
       assert content =~ ~r/^# CompiledWithDocs/m
       assert content =~ ~r/^## Table of Contents/m
@@ -147,7 +147,7 @@ defmodule ExDoc.Formatter.MarkdownTest do
 
     test "handles complex documentation elements", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
-      content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.md")
+      content = File.read!(tmp_dir <> "/CompiledWithDocs.md")
 
       assert content =~ ~r/#### `example\(foo, bar.*\)`/
       assert content =~ ~r/> This function is deprecated\./
@@ -156,7 +156,7 @@ defmodule ExDoc.Formatter.MarkdownTest do
 
     test "generates valid navigation structure", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
-      content = File.read!(tmp_dir <> "/markdown/index.md")
+      content = File.read!(tmp_dir <> "/index.md")
 
       assert content =~ ~r/^# Elixir v1\.0\.1 - Documentation - Table of Contents$/m
       assert content =~ ~r/- \[CompiledWithDocs\]\(CompiledWithDocs\.md\)/
@@ -168,7 +168,7 @@ defmodule ExDoc.Formatter.MarkdownTest do
 
     test "generates proper markdown escaping", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
-      content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.md")
+      content = File.read!(tmp_dir <> "/CompiledWithDocs.md")
 
       assert content =~ ~r/&lt;|&gt;|&amp;/ || !String.contains?(content, "<script>")
       assert content =~ ~r/#### `[^`]+`/
@@ -181,30 +181,30 @@ defmodule ExDoc.Formatter.MarkdownTest do
       config = doc_config(context, output: custom_output)
       generate_docs(config)
 
-      assert File.regular?(custom_output <> "/markdown/index.md")
-      assert File.regular?(custom_output <> "/markdown/CompiledWithDocs.md")
-      refute File.exists?(tmp_dir <> "/markdown/index.md")
+      assert File.regular?(custom_output <> "/index.md")
+      assert File.regular?(custom_output <> "/CompiledWithDocs.md")
+      refute File.exists?(tmp_dir <> "/index.md")
     end
 
     test "handles custom project name and version", %{tmp_dir: tmp_dir} = context do
       config = doc_config(context, project: "MyProject", version: "2.0.0")
       generate_docs(config)
 
-      content = File.read!(tmp_dir <> "/markdown/index.md")
+      content = File.read!(tmp_dir <> "/index.md")
       assert content =~ ~r/# MyProject v2\.0\.0 - Documentation/
 
-      content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.md")
+      content = File.read!(tmp_dir <> "/CompiledWithDocs.md")
       assert content =~ ~r/\(MyProject v2\.0\.0\)/
-      llm_content = File.read!(tmp_dir <> "/markdown/llms.txt")
+      llm_content = File.read!(tmp_dir <> "/llms.txt")
       assert llm_content =~ ~r/# MyProject 2\.0\.0/
     end
 
     test "processes source_url configuration", %{tmp_dir: tmp_dir} = context do
       config = doc_config(context, source_url: "https://github.com/example/project")
       generate_docs(config)
 
-      assert File.regular?(tmp_dir <> "/markdown/CompiledWithDocs.md")
-      assert File.regular?(tmp_dir <> "/markdown/index.md")
+      assert File.regular?(tmp_dir <> "/CompiledWithDocs.md")
+      assert File.regular?(tmp_dir <> "/index.md")
     end
   end
 
@@ -213,10 +213,10 @@ defmodule ExDoc.Formatter.MarkdownTest do
       config = doc_config(context, extras: ["test/fixtures/README.md"])
       generate_docs(config)
 
-      assert File.regular?(tmp_dir <> "/markdown/index.md")
-      nav_content = File.read!(tmp_dir <> "/markdown/index.md")
+      assert File.regular?(tmp_dir <> "/index.md")
+      nav_content = File.read!(tmp_dir <> "/index.md")
       assert nav_content =~ ~r/## Modules/
-      assert File.regular?(tmp_dir <> "/markdown/llms.txt")
+      assert File.regular?(tmp_dir <> "/llms.txt")
     end
 
     test "handles multiple extras with custom names", %{tmp_dir: tmp_dir} = context do
@@ -230,15 +230,15 @@ defmodule ExDoc.Formatter.MarkdownTest do
 
       generate_docs(config)
 
-      assert File.regular?(tmp_dir <> "/markdown/index.md")
-      assert File.regular?(tmp_dir <> "/markdown/llms.txt")
+      assert File.regular?(tmp_dir <> "/index.md")
+      assert File.regular?(tmp_dir <> "/llms.txt")
     end
 
     test "processes plain text files as extras", %{tmp_dir: tmp_dir} = context do
       config = doc_config(context, extras: ["test/fixtures/PlainText.txt"])
       generate_docs(config)
 
-      assert File.regular?(tmp_dir <> "/markdown/index.md")
+      assert File.regular?(tmp_dir <> "/index.md")
     end
 
     test "handles extras with custom titles", %{tmp_dir: tmp_dir} = context do
@@ -251,8 +251,8 @@ defmodule ExDoc.Formatter.MarkdownTest do
 
       generate_docs(config)
 
-      assert File.regular?(tmp_dir <> "/markdown/index.md")
-      assert File.regular?(tmp_dir <> "/markdown/llms.txt")
+      assert File.regular?(tmp_dir <> "/index.md")
+      assert File.regular?(tmp_dir <> "/llms.txt")
     end
 
     test "ignores external url extras", %{tmp_dir: tmp_dir} = context do
@@ -266,45 +266,45 @@ defmodule ExDoc.Formatter.MarkdownTest do
 
       generate_docs(config)
 
-      refute File.exists?(tmp_dir <> "/markdown/elixir.md")
-      assert File.regular?(tmp_dir <> "/markdown/index.md")
+      refute File.exists?(tmp_dir <> "/elixir.md")
+      assert File.regular?(tmp_dir <> "/index.md")
     end
   end
 
   describe "error scenarios" do
     test "handles modules with no documentation gracefully", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
 
-      assert File.regular?(tmp_dir <> "/markdown/CompiledWithoutDocs.md")
+      assert File.regular?(tmp_dir <> "/CompiledWithoutDocs.md")
 
-      content = File.read!(tmp_dir <> "/markdown/CompiledWithoutDocs.md")
+      content = File.read!(tmp_dir <> "/CompiledWithoutDocs.md")
       assert content =~ ~r/^# CompiledWithoutDocs/
     end
 
     test "handles missing source beam directory", %{tmp_dir: tmp_dir} = context do
       config = doc_config(context, source_beam: "nonexistent/path")
 
       generate_docs(config)
-      assert File.regular?(tmp_dir <> "/markdown/index.md")
+      assert File.regular?(tmp_dir <> "/index.md")
     end
 
     test "handles empty extras list", %{tmp_dir: tmp_dir} = context do
       config = doc_config(context, extras: [])
       generate_docs(config)
 
-      nav_content = File.read!(tmp_dir <> "/markdown/index.md")
+      nav_content = File.read!(tmp_dir <> "/index.md")
       refute nav_content =~ ~r/## Guides/
 
-      llm_content = File.read!(tmp_dir <> "/markdown/llms.txt")
+      llm_content = File.read!(tmp_dir <> "/llms.txt")
       refute llm_content =~ ~r/## Guides/
     end
 
     test "handles special characters in module names", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
 
-      assert File.regular?(tmp_dir <> "/markdown/CompiledWithDocs.Nested.md")
+      assert File.regular?(tmp_dir <> "/CompiledWithDocs.Nested.md")
 
-      content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.Nested.md")
+      content = File.read!(tmp_dir <> "/CompiledWithDocs.Nested.md")
       assert content =~ ~r/^# CompiledWithDocs\.Nested/
     end
   end
@@ -314,7 +314,7 @@ defmodule ExDoc.Formatter.MarkdownTest do
       config = doc_config(context, extras: ["test/fixtures/README.md"])
       generate_docs(config)
 
-      content = File.read!(tmp_dir <> "/markdown/llms.txt")
+      content = File.read!(tmp_dir <> "/llms.txt")
 
       assert content =~ ~r/# Elixir 1\.0\.1/
       assert content =~ ~r/documentation index for Large Language Models/
@@ -331,15 +331,15 @@ defmodule ExDoc.Formatter.MarkdownTest do
       config = doc_config(context, source_beam: "test/fixtures/beam_no_tasks")
       generate_docs(config)
 
-      content = File.read!(tmp_dir <> "/markdown/llms.txt")
+      content = File.read!(tmp_dir <> "/llms.txt")
 
       assert content =~ ~r/## Modules/
     end
 
     test "truncates long descriptions in llm index", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
 
-      content = File.read!(tmp_dir <> "/markdown/llms.txt")
+      content = File.read!(tmp_dir <> "/llms.txt")
 
       lines = String.split(content, "\n")
       module_lines = Enum.filter(lines, &String.starts_with?(&1, "- **"))
@@ -354,14 +354,14 @@ defmodule ExDoc.Formatter.MarkdownTest do
     test "generates proper internal links", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
 
-      content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.md")
+      content = File.read!(tmp_dir <> "/CompiledWithDocs.md")
 
       assert content =~ ~r/\[`[^`]+`\]\(#[^)]+\)/
     end
 
     test "handles function anchors correctly", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
-      content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.md")
+      content = File.read!(tmp_dir <> "/CompiledWithDocs.md")
 
       assert content =~ ~r/<a id="[^"]+"><\/a>/
 
@@ -379,7 +379,7 @@ defmodule ExDoc.Formatter.MarkdownTest do
   describe "output normalization" do
     test "normalizes line endings consistently", %{tmp_dir: tmp_dir} = context do
       generate_docs(doc_config(context))
-      content = File.read!(tmp_dir <> "/markdown/CompiledWithDocs.md")
+      content = File.read!(tmp_dir <> "/CompiledWithDocs.md")
 
       refute String.contains?(content, "\r\n")
       refute String.contains?(content, "\r")
@@ -391,8 +391,8 @@ defmodule ExDoc.Formatter.MarkdownTest do
       generate_docs(doc_config(context))
 
       files = [
-        tmp_dir <> "/markdown/index.md",
-        tmp_dir <> "/markdown/CompiledWithDocs.md"
+        tmp_dir <> "/index.md",
+        tmp_dir <> "/CompiledWithDocs.md"
       ]
 
       for file <- files do