Skip to content

Add frontmatter support for docs formatting, format docs #875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanielBadura merged 1 commit into from
Jul 17, 2026
+31 −5
Merged

Add frontmatter support for docs formatting, format docs #875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions bin/docs-extract-php-code
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
use League\CommonMark\Extension\FrontMatter\Data\FrontMatterDataParserInterface;
use League\CommonMark\Extension\FrontMatter\FrontMatterExtension;
use League\CommonMark\Node\Query;
use League\CommonMark\Parser\MarkdownParser;
use Wnx\CommonmarkMarkdownRenderer\MarkdownRendererExtension;
Expand All @@ -11,6 +13,15 @@ require __DIR__ . '/../vendor/autoload.php';

$environment = new Environment([]);
$environment->addExtension(new MarkdownRendererExtension());
$environment->addExtension(new FrontMatterExtension(
// keep the raw YAML string so it round-trips byte-identically
new class implements FrontMatterDataParserInterface {
public function parse(string $frontMatter): string
{
return $frontMatter;
}
},
));

$parser = new MarkdownParser($environment);

Expand Down
21 changes: 20 additions & 1 deletion bin/docs-inject-php-code
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
use League\CommonMark\Extension\FrontMatter\Data\FrontMatterDataParserInterface;
use League\CommonMark\Extension\FrontMatter\FrontMatterExtension;
use League\CommonMark\Extension\FrontMatter\Output\RenderedContentWithFrontMatter;
use League\CommonMark\Node\Query;
use League\CommonMark\Parser\MarkdownParser;
use Wnx\CommonmarkMarkdownRenderer\MarkdownRendererExtension;
Expand All @@ -14,6 +17,15 @@ require __DIR__ . '/../vendor/autoload.php';

$environment = new Environment([]);
$environment->addExtension(new MarkdownRendererExtension());
$environment->addExtension(new FrontMatterExtension(
// keep the raw YAML string so it round-trips byte-identically
new class implements FrontMatterDataParserInterface {
public function parse(string $frontMatter): string
{
return $frontMatter;
}
},
));

$parser = new MarkdownParser($environment);
$markdownRenderer = new MarkdownRenderer($environment);
Expand Down Expand Up @@ -62,7 +74,14 @@ foreach ($finder as $file) {
$node->setLiteral(trim($code));
}

file_put_contents($file->getPathname(), $markdownRenderer->renderDocument($document));
$rendered = $markdownRenderer->renderDocument($document);
$output = $rendered->getContent();

if ($rendered instanceof RenderedContentWithFrontMatter) {
$output = $rendered->getFrontMatter() . "---\n" . $output;
}

file_put_contents($file->getPathname(), $output);
}

if (file_exists($targetDir)) {
Expand Down
4 changes: 0 additions & 4 deletions docs/message.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ use Patchlevel\EventSourcing\Message\Message;
/** @var Message $message */
$message->header(ApplicationHeader::class);
```

## Missing headers

When a message is deserialized, every header name is resolved to its registered header class.
Expand All @@ -117,7 +116,6 @@ $serializer = DefaultHeadersSerializer::createFromPaths(
['legacyApplication', 'legacyTenant'],
);
```

You can access the collected headers via the `MissingHeaders` object:

```php
Expand All @@ -127,7 +125,6 @@ use Patchlevel\EventSourcing\Message\MissingHeaders;
$missingHeaders = $message->header(MissingHeaders::class);
$missingHeaders->headers; // ['legacyApplication' => [...], 'legacyTenant' => [...]]
```

:::warning
Only the header names you list are handled gracefully. If a message contains an unregistered header
whose name is **not** in the list, deserialization still throws `HeaderNameNotRegistered`.
Expand All @@ -143,7 +140,6 @@ $serializer = DefaultHeadersSerializer::createFromPaths(
['*'],
);
```

## Pipe

The `Pipe` is a construct that allows you to chain multiple translators.
Expand Down
Loading