mirror of
https://github.com/HolgerHatGarKeineNode/einundzwanzig-nostr.git
synced 2026-04-10 14:38:41 +00:00
✨ Add rich Markdown normalization and paste handling.
- 🛠 Introduce `RichTextMarkdownNormalizer` to convert Markdown and mixed input to cleaner HTML. - 🗂 Include a new Blade partial to enable Markdown-on-paste behavior in rich-text editors. - 📋 Enhance `create` and `edit` forms to normalize descriptions and support Markdown conversion. - 🧪 Add test coverage for Markdown normalization scenarios. - 🛠 Add CLI command to normalize project proposal descriptions in bulk. - 🔧 Update `vite.config.js` for improved development setup (e.g., ignored paths).
This commit is contained in:
HolgerHatGarKeineNode
101
app/Console/Commands/NormalizeProjectProposalDescriptions.php
Normal file
101
app/Console/Commands/NormalizeProjectProposalDescriptions.php
Normal file
@@ -0,0 +1,101 @@
|
||||
<?php
|
||||
|
||||
namespace App\Console\Commands;
|
||||
|
||||
use App\Models\ProjectProposal;
|
||||
use App\Support\RichTextMarkdownNormalizer;
|
||||
use Illuminate\Console\Attributes\Description;
|
||||
use Illuminate\Console\Attributes\Signature;
|
||||
use Illuminate\Console\Command;
|
||||
|
||||
#[Signature('project-proposals:normalize-descriptions
|
||||
{--dry-run : Show what would change without writing to the database}
|
||||
{--id=* : Limit to specific proposal IDs}
|
||||
{--show-diff : Print a short before/after preview for every change}')]
|
||||
#[Description('Normalize project proposal descriptions so all rows contain clean HTML (converts legacy plain-text and mixed Markdown/HTML content).')]
|
||||
class NormalizeProjectProposalDescriptions extends Command
|
||||
{
|
||||
public function handle(): int
|
||||
{
|
||||
$dryRun = (bool) $this->option('dry-run');
|
||||
$showDiff = (bool) $this->option('show-diff');
|
||||
$ids = array_filter((array) $this->option('id'));
|
||||
|
||||
$normalizer = new RichTextMarkdownNormalizer;
|
||||
|
||||
$query = ProjectProposal::query()->orderBy('id');
|
||||
|
||||
if ($ids !== []) {
|
||||
$query->whereIn('id', $ids);
|
||||
}
|
||||
|
||||
$total = (clone $query)->count();
|
||||
|
||||
if ($total === 0) {
|
||||
$this->warn('No project proposals to process.');
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
$this->info(sprintf(
|
||||
'%s %d project proposal description(s)%s.',
|
||||
$dryRun ? 'Analyzing' : 'Normalizing',
|
||||
$total,
|
||||
$dryRun ? ' (dry-run)' : '',
|
||||
));
|
||||
|
||||
$changed = 0;
|
||||
$unchanged = 0;
|
||||
$failed = 0;
|
||||
|
||||
$query->lazy()->each(function (ProjectProposal $proposal) use ($normalizer, $dryRun, $showDiff, &$changed, &$unchanged, &$failed): void {
|
||||
$original = (string) ($proposal->description ?? '');
|
||||
|
||||
try {
|
||||
$normalized = (string) ($normalizer->normalize($original) ?? '');
|
||||
} catch (\Throwable $exception) {
|
||||
$failed++;
|
||||
$this->error(sprintf('#%d %s — normalization failed: %s', $proposal->id, $proposal->name, $exception->getMessage()));
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if ($original === $normalized) {
|
||||
$unchanged++;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$changed++;
|
||||
$this->line(sprintf('<fg=yellow>~</> #%d %s', $proposal->id, $proposal->name));
|
||||
|
||||
if ($showDiff) {
|
||||
$this->line(' <fg=red>- '.$this->preview($original).'</>');
|
||||
$this->line(' <fg=green>+ '.$this->preview($normalized).'</>');
|
||||
}
|
||||
|
||||
if (! $dryRun) {
|
||||
$proposal->description = $normalized;
|
||||
$proposal->saveQuietly();
|
||||
}
|
||||
});
|
||||
|
||||
$this->newLine();
|
||||
$this->info(sprintf(
|
||||
'Done. Changed: %d, unchanged: %d, failed: %d%s',
|
||||
$changed,
|
||||
$unchanged,
|
||||
$failed,
|
||||
$dryRun ? ' (no writes performed)' : '',
|
||||
));
|
||||
|
||||
return $failed > 0 ? self::FAILURE : self::SUCCESS;
|
||||
}
|
||||
|
||||
private function preview(string $value): string
|
||||
{
|
||||
$collapsed = preg_replace('/\s+/', ' ', trim($value)) ?? '';
|
||||
|
||||
return mb_strimwidth($collapsed, 0, 140, '…');
|
||||
}
|
||||
}
|
||||
238
app/Support/RichTextMarkdownNormalizer.php
Normal file
238
app/Support/RichTextMarkdownNormalizer.php
Normal file
@@ -0,0 +1,238 @@
|
||||
<?php
|
||||
|
||||
namespace App\Support;
|
||||
|
||||
use DOMDocument;
|
||||
use Spatie\LaravelMarkdown\MarkdownRenderer;
|
||||
|
||||
/**
|
||||
* Converts Tiptap/flux:editor HTML that contains literal Markdown syntax
|
||||
* (e.g. from a plain-text paste) into proper structured HTML.
|
||||
*
|
||||
* The flux:editor wraps pasted plain text in <p> tags line by line, so
|
||||
* pasted Markdown like `# Heading` ends up as `<p># Heading</p>` and never
|
||||
* gets rendered as a real heading. This normalizer detects that situation
|
||||
* and runs the extracted text through a Markdown renderer.
|
||||
*
|
||||
* If the HTML already contains structural elements produced by the editor
|
||||
* toolbar (headings, lists, blockquotes, code blocks), the content is left
|
||||
* untouched so real rich-text edits are preserved.
|
||||
*/
|
||||
class RichTextMarkdownNormalizer
|
||||
{
|
||||
/**
|
||||
* @var array<int, string> HTML tags that indicate the user already
|
||||
* used the editor toolbar for structure.
|
||||
*/
|
||||
private const STRUCTURAL_TAGS = [
|
||||
'h1', 'h2', 'h3', 'h4', 'h5', 'h6',
|
||||
'ul', 'ol', 'blockquote', 'pre', 'table',
|
||||
];
|
||||
|
||||
/**
|
||||
* Regex fragments that indicate plain-text Markdown syntax.
|
||||
*
|
||||
* @var array<int, string>
|
||||
*/
|
||||
private const MARKDOWN_LINE_PATTERNS = [
|
||||
'/^\s{0,3}#{1,6}\s+\S/m', // ATX headings
|
||||
'/^\s{0,3}[-*+]\s+\S/m', // bullet list
|
||||
'/^\s{0,3}\d{1,9}[.)]\s+\S/m', // ordered list
|
||||
'/^\s{0,3}>\s?/m', // blockquote
|
||||
'/^\s{0,3}```/m', // fenced code block
|
||||
];
|
||||
|
||||
/**
|
||||
* Render a raw Markdown string directly to HTML using the same
|
||||
* configuration as normalize().
|
||||
*/
|
||||
public function toHtml(string $markdown): string
|
||||
{
|
||||
return trim($this->renderer()->toHtml($markdown));
|
||||
}
|
||||
|
||||
public function normalize(?string $html): ?string
|
||||
{
|
||||
if ($html === null || trim($html) === '') {
|
||||
return $html;
|
||||
}
|
||||
|
||||
// Pure plain text (no HTML tags at all): render directly as Markdown
|
||||
// so newline-separated paragraphs, headings, links, etc. become HTML.
|
||||
if (! $this->containsHtmlTags($html)) {
|
||||
$rendered = trim($this->renderer()->toHtml($html));
|
||||
|
||||
return $rendered === '' ? $html : $rendered;
|
||||
}
|
||||
|
||||
// Already structured via the editor toolbar: leave untouched.
|
||||
if ($this->containsStructuralHtml($html)) {
|
||||
return $html;
|
||||
}
|
||||
|
||||
// Paragraph-only HTML: if the inner text looks like Markdown
|
||||
// (pasted plain text wrapped in <p> by Tiptap), extract and render.
|
||||
$plainText = $this->extractPlainTextPreservingLineBreaks($html);
|
||||
|
||||
if (! $this->looksLikeMarkdown($plainText)) {
|
||||
return $html;
|
||||
}
|
||||
|
||||
$rendered = trim($this->renderer()->toHtml($plainText));
|
||||
|
||||
return $rendered === '' ? $html : $rendered;
|
||||
}
|
||||
|
||||
private function containsHtmlTags(string $input): bool
|
||||
{
|
||||
return preg_match('/<[a-z!\/][^>]*>/i', $input) === 1;
|
||||
}
|
||||
|
||||
private function renderer(): MarkdownRenderer
|
||||
{
|
||||
$config = config('markdown');
|
||||
|
||||
return new MarkdownRenderer(
|
||||
commonmarkOptions: $config['commonmark_options'] ?? [],
|
||||
highlightCode: $config['code_highlighting']['enabled'] ?? false,
|
||||
highlightTheme: $config['code_highlighting']['theme'] ?? 'github-light',
|
||||
cacheStoreName: $config['cache_store'] ?? null,
|
||||
renderAnchors: $config['add_anchors_to_headings'] ?? false,
|
||||
renderAnchorsAsLinks: $config['render_anchors_as_links'] ?? false,
|
||||
extensions: $config['extensions'] ?? [],
|
||||
blockRenderers: $config['block_renderers'] ?? [],
|
||||
inlineRenderers: $config['inline_renderers'] ?? [],
|
||||
inlineParsers: $config['inline_parsers'] ?? [],
|
||||
cacheDuration: $config['cache_duration'] ?? null,
|
||||
);
|
||||
}
|
||||
|
||||
private function containsStructuralHtml(string $html): bool
|
||||
{
|
||||
foreach (self::STRUCTURAL_TAGS as $tag) {
|
||||
if (stripos($html, '<'.$tag) !== false) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private function looksLikeMarkdown(string $text): bool
|
||||
{
|
||||
foreach (self::MARKDOWN_LINE_PATTERNS as $pattern) {
|
||||
if (preg_match($pattern, $text) === 1) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private function extractPlainTextPreservingLineBreaks(string $html): string
|
||||
{
|
||||
$dom = new DOMDocument;
|
||||
$previous = libxml_use_internal_errors(true);
|
||||
$dom->loadHTML('<?xml encoding="UTF-8"?><div>'.$html.'</div>', LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
|
||||
libxml_clear_errors();
|
||||
libxml_use_internal_errors($previous);
|
||||
|
||||
$root = $dom->getElementsByTagName('div')->item(0);
|
||||
|
||||
if ($root === null) {
|
||||
return html_entity_decode(strip_tags($html), ENT_QUOTES | ENT_HTML5);
|
||||
}
|
||||
|
||||
$blocks = [];
|
||||
|
||||
foreach ($root->childNodes as $child) {
|
||||
if ($child->nodeType === XML_ELEMENT_NODE && strtolower($child->nodeName) === 'p') {
|
||||
$blocks[] = $this->nodeToMarkdown($child);
|
||||
} else {
|
||||
$blocks[] = trim($this->nodeToMarkdown($child));
|
||||
}
|
||||
}
|
||||
|
||||
return trim(implode("\n\n", array_filter($blocks, static fn ($line) => $line !== '')));
|
||||
}
|
||||
|
||||
/**
|
||||
* Walk a DOM node and produce a Markdown-equivalent string for its
|
||||
* contents, preserving inline formatting (strong, em, code, links,
|
||||
* images) and converting <br> to newlines.
|
||||
*/
|
||||
private function nodeToMarkdown(\DOMNode $node): string
|
||||
{
|
||||
$buffer = '';
|
||||
|
||||
foreach ($node->childNodes as $child) {
|
||||
if ($child->nodeType === XML_TEXT_NODE) {
|
||||
$buffer .= $child->textContent ?? '';
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($child->nodeType !== XML_ELEMENT_NODE) {
|
||||
continue;
|
||||
}
|
||||
|
||||
/** @var \DOMElement $child */
|
||||
$tag = strtolower($child->nodeName);
|
||||
|
||||
switch ($tag) {
|
||||
case 'br':
|
||||
$buffer .= "\n";
|
||||
break;
|
||||
|
||||
case 'strong':
|
||||
case 'b':
|
||||
$inner = $this->nodeToMarkdown($child);
|
||||
$buffer .= $inner === '' ? '' : '**'.$inner.'**';
|
||||
break;
|
||||
|
||||
case 'em':
|
||||
case 'i':
|
||||
$inner = $this->nodeToMarkdown($child);
|
||||
$buffer .= $inner === '' ? '' : '*'.$inner.'*';
|
||||
break;
|
||||
|
||||
case 's':
|
||||
case 'del':
|
||||
case 'strike':
|
||||
$inner = $this->nodeToMarkdown($child);
|
||||
$buffer .= $inner === '' ? '' : '~~'.$inner.'~~';
|
||||
break;
|
||||
|
||||
case 'code':
|
||||
$buffer .= '`'.($child->textContent ?? '').'`';
|
||||
break;
|
||||
|
||||
case 'a':
|
||||
$text = $this->nodeToMarkdown($child);
|
||||
$href = $child->getAttribute('href');
|
||||
if ($href === '') {
|
||||
$buffer .= $text;
|
||||
} elseif (trim($text) === '' || $text === $href) {
|
||||
$buffer .= $href;
|
||||
} else {
|
||||
$buffer .= '['.$text.']('.$href.')';
|
||||
}
|
||||
break;
|
||||
|
||||
case 'img':
|
||||
$src = $child->getAttribute('src');
|
||||
$alt = $child->getAttribute('alt');
|
||||
if ($src !== '') {
|
||||
$buffer .= '';
|
||||
}
|
||||
break;
|
||||
|
||||
default:
|
||||
$buffer .= $this->nodeToMarkdown($child);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return $buffer;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user