Skip to content
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.

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

Add new html to markdown converter for strikethrough support #1275

Merged
merged 2 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions src/Service/ActivityPub/MarkdownConverter.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ public function convert(string $value): string
{
$converter = new HtmlConverter(['strip_tags' => true]);
$converter->getEnvironment()->addConverter(new TableConverter());
$converter->getEnvironment()->addConverter(new StrikethroughConverter());
$value = stripslashes($converter->convert($value));

preg_match_all('/\[([^]]*)\] *\(([^)]*)\)/i', $value, $matches, PREG_SET_ORDER);
Expand Down
48 changes: 48 additions & 0 deletions src/Service/ActivityPub/StrikethroughConverter.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?php

declare(strict_types=1);

namespace App\Service\ActivityPub;

use League\HTMLToMarkdown\Configuration;
use League\HTMLToMarkdown\ConfigurationAwareInterface;
use League\HTMLToMarkdown\Converter\ConverterInterface;
use League\HTMLToMarkdown\ElementInterface;

/**
* Inspired by https://github.com/thephpleague/html-to-markdown/blob/master/src/Converter/EmphasisConverter.php.
*/
class StrikethroughConverter implements ConverterInterface, ConfigurationAwareInterface
{
protected Configuration $config;

public function getSupportedTags(): array
{
return ['del', 'strike'];
}

public function setConfig(Configuration $config): void
{
$this->config = $config;
}

public function convert(ElementInterface $element): string
{
$value = $element->getValue();
if (!trim($value)) {
return $value;
}

$prefix = ltrim($value) !== $value ? ' ' : '';
$suffix = rtrim($value) !== $value ? ' ' : '';

/* If this node is immediately preceded or followed by one of the same type don't emit
* the start or end $style, respectively. This prevents <del>foo</del><del>bar</del> from
* being converted to ~~foo~~~~bar~~ which is incorrect. We want ~~foobar~~ instead.
*/
$preStyle = \in_array($element->getPreviousSibling()?->getTagName(), $this->getSupportedTags()) ? '' : '~~';
$postStyle = \in_array($element->getNextSibling()?->getTagName(), $this->getSupportedTags()) ? '' : '~~';

return $prefix.$preStyle.trim($value).$postStyle.$suffix;
}
}
Loading