Merge pull request #600 from phpDocumentor/task/markdown

jaapio · web-flow · commit 3b68ddd019ae · 2023-09-26T21:03:11.000+02:00
[TASK] Make Markdown availible in integration tests
diff --git a/composer.json b/composer.json
@@ -37,6 +37,7 @@
         "phpdocumentor/guides": "@dev",
         "phpdocumentor/guides-cli": "@dev",
         "phpdocumentor/guides-graphs": "@dev",
+        "phpdocumentor/guides-markdown": "@dev",
         "phpdocumentor/guides-restructured-text": "@dev",
         "phpdocumentor/guides-theme-bootstrap": "@dev",
         "psr/event-dispatcher": "^1.0",
diff --git a/composer.lock b/composer.lock
diff --git a/packages/guides-markdown/resources/config/guides-markdown.php b/packages/guides-markdown/resources/config/guides-markdown.php
@@ -2,11 +2,15 @@
 
 declare(strict_types=1);
 
+use phpDocumentor\Guides\Markdown\MarkupLanguageParser;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
 return static function (ContainerConfigurator $container): void {
     $container->services()
         ->defaults()
         ->autowire()
-        ->autoconfigure();
+        ->autoconfigure()
+
+        ->set(MarkupLanguageParser::class)
+        ->tag('phpdoc.guides.parser.markupLanguageParser');
 };
diff --git a/tests/ApplicationTestCase.php b/tests/ApplicationTestCase.php
@@ -7,6 +7,7 @@
 use phpDocumentor\Guides\Cli\DependencyInjection\ApplicationExtension;
 use phpDocumentor\Guides\Cli\DependencyInjection\ContainerFactory;
 use phpDocumentor\Guides\DependencyInjection\TestExtension;
+use phpDocumentor\Guides\Markdown\DependencyInjection\MarkdownExtension;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
@@ -37,6 +38,7 @@ protected function prepareContainer(string|null $configurationFile = null, array
         $containerFactory = new ContainerFactory([
             new ApplicationExtension(),
             new TestExtension(),
+            new MarkdownExtension(),
             ...$extraExtensions,
         ]);
 
diff --git a/tests/Integration/tests/markdown/index-md/expected/index.html b/tests/Integration/tests/markdown/index-md/expected/index.html
@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Project Title</title>
+
+</head>
+<body>
+    <h1>Markdown Example</h1>
+    <p>This is a Markdown document with some basic formatting.</p>
+
+<h2>Headings</h2>
+
+    <p>You can create headings using hash symbols.</p>
+
+</body>
+</html>
diff --git a/tests/Integration/tests/markdown/index-md/input/guides.xml b/tests/Integration/tests/markdown/index-md/input/guides.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<guides
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        input-format="md"
+>
+    <project title="Project Title" version="6.4"/>
+</guides>
diff --git a/tests/Integration/tests/markdown/index-md/input/index.md b/tests/Integration/tests/markdown/index-md/input/index.md
@@ -0,0 +1,7 @@
+# Markdown Example
+
+This is a Markdown document with some basic formatting.
+
+## Headings
+
+You can create headings using hash symbols.
diff --git a/tests/Integration/tests/markdown/index-md/input/skip b/tests/Integration/tests/markdown/index-md/input/skip
@@ -0,0 +1 @@
+Paragraph text is missing in output, there is a warning about the document having no title even though it has a title

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Paragraph text is missing in output, there is a warning about the document having no title even though it has a title`