Adding verbose formatting as an option

Author: mamazu

src/Error/Error.php

@@ -33,6 +33,11 @@ public function getMessage(): string
 		return "[{$this->type}] {$this->message}";
 	}
 
+	public function getRawMessage(): string
+	{
+		return $this->message;
+	}
+
 	public function getFileName(): string
 	{
 		return $this->fileName;

src/Output/VerboseFormatter.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mamazu\DocumentationParser\Output;
+
+use Mamazu\DocumentationParser\Error\Error;
+use Webmozart\Assert\Assert;
+
+class VerboseFormatter implements FormatterInterface
+{
+	public function format(array $output): string
+	{
+		return implode(
+			"\n",
+			array_map(fn (Error $error): string => $this->formatError($error), $output)
+		);
+	}
+
+	private function formatError(Error $error): string
+	{
+		$fileContents = file_get_contents($error->getFileName());
+		Assert::string($fileContents, 'Could not read file contents of ' . $fileContents);
+
+		$lines = explode("\n", $fileContents);
+
+		$seperator = '========== [' . $error->getType() . '@' . $error->getFileName() . ':' . $error->getLineNumber() . '] ==========';
+
+		$message = "\n${seperator}\n";
+		$message .= $lines[$error->getLineNumber() - 2] . "\n";
+		$message .= $lines[$error->getLineNumber() - 1] . "\n";
+		$message .= "^^^ \e[31m" . $error->getRawMessage() . "\e[0m ^^^\n";
+		$message .= ($lines[$error->getLineNumber()] ?? '$EOF$') . "\n";
+		$message .= str_repeat('=', strlen($seperator));
+
+		return $message;
+	}
+}

tests/Mamazu/DocumentationParser/Output/VerboseFormatterTest.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+namespace Tests\Mamazu\DocumentationParser\Output;
+
+use Mamazu\DocumentationParser\Error\Error;
+use Mamazu\DocumentationParser\Output\VerboseFormatter;
+use org\bovigo\vfs\vfsStream;
+use org\bovigo\vfs\vfsStreamDirectory;
+use PHPUnit\Framework\TestCase;
+
+class VerboseFormatterTest extends TestCase
+{
+	private const FILE_NAME = 'vfs://workDir/error.php';
+
+	private VerboseFormatter $verboseFormatter;
+
+	private vfsStreamDirectory $workDir;
+
+	protected function setUp(): void
+	{
+		parent::setUp();
+		$this->workDir = vfsStream::setup('workDir');
+		$this->verboseFormatter = new VerboseFormatter();
+
+		$file = vfsStream::newFile('error.php');
+		$file->setContent(<<<PHP
+<?php
+echo "Hello"
+\$a = 10;
+
+PHP);
+		$this->workDir->addChild($file);
+	}
+
+	public function testFormatsTheAnError(): void
+	{
+		$errors = [
+			new Error(self::FILE_NAME, 3, 'Expected ; got variable'),
+		];
+
+		$expected = <<<TXT
+
+========== [@vfs://workDir/error.php:3] ==========
+echo "Hello"
+\$a = 10;
+^^^ \e[31mExpected ; got variable\e[0m ^^^
+
+==================================================
+TXT;
+
+		$this->assertSame(
+			$expected,
+			$this->verboseFormatter->format($errors)
+		);
+	}
+
+	public function testFormatsTheMultipleErrors(): void
+	{
+		$errors = [
+			new Error(self::FILE_NAME, 3, 'Expected ; got variable'),
+			new Error(self::FILE_NAME, 4, 'Unexpected end of file'),
+		];
+
+		$expected = <<<TXT
+
+========== [@vfs://workDir/error.php:3] ==========
+echo "Hello"
+\$a = 10;
+^^^ \e[31mExpected ; got variable\e[0m ^^^
+
+==================================================
+
+========== [@vfs://workDir/error.php:4] ==========
+\$a = 10;
+
+^^^ \e[31mUnexpected end of file\e[0m ^^^
+\$EOF\$
+==================================================
+TXT;
+
+		$this->assertSame(
+			$expected,
+			$this->verboseFormatter->format($errors)
+		);
+	}
+}

tests/extensions/verbose.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+use Mamazu\DocumentationParser\Application;
+use Mamazu\DocumentationParser\FileList;
+use Mamazu\DocumentationParser\Output\FormatterInterface;
+use Mamazu\DocumentationParser\Output\VerboseFormatter;
+
+/**
+ * Here are the variables you can use to extend the application:
+ * @var FileList $fileList
+ * @var Application $application
+ * @var FormatterInterface $formatter
+ */
+
+$formatter = new VerboseFormatter();