mirror of
https://github.com/Respect/Validation.git
synced 2026-03-16 15:25:45 +01:00
bd48bdcda4
Introduces a Markdown linter for checking the Changelog format. "See Also" was transformed into a section to make it easier to handle it with the `Content` class. The "Related" linter was simplified to reflect that change too. An additional "alignment" parameter was added to markdown table generators, allowing the padding and headers to be explicitly marked with a specific left (-1), middle (0) or right(1) alignment. Existing files were fixed using the `fix` option after the changes.
66 lines
1.7 KiB
PHP
66 lines
1.7 KiB
PHP
<?php
|
|
|
|
/*
|
|
* SPDX-License-Identifier: MIT
|
|
* SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Respect\Dev\Markdown\Linters;
|
|
|
|
use Respect\Dev\Markdown\Content;
|
|
use Respect\Dev\Markdown\File;
|
|
use Respect\Dev\Markdown\Linter;
|
|
use UnexpectedValueException;
|
|
|
|
use function count;
|
|
use function explode;
|
|
use function is_numeric;
|
|
use function str_contains;
|
|
use function str_replace;
|
|
use function trim;
|
|
|
|
final readonly class ValidatorChangelogLinter implements Linter
|
|
{
|
|
public function lint(File $file): File
|
|
{
|
|
if (!str_contains($file->filename, '/validators/')) {
|
|
return $file;
|
|
}
|
|
|
|
$changeLogItems = $this->getChangelogItems($file);
|
|
|
|
$content = new Content();
|
|
$content->h2('Changelog');
|
|
$content->table(['Version', 'Description'], $changeLogItems, alignment: [1, -1]);
|
|
|
|
return $file->withContent($file->content->withSection($content));
|
|
}
|
|
|
|
/** @return array<int, array<int, string>> */
|
|
private function getChangelogItems(File $validator): array
|
|
{
|
|
try {
|
|
$changeLog = $validator->content->getSection('## Changelog');
|
|
} catch (UnexpectedValueException) {
|
|
return [];
|
|
}
|
|
|
|
$changeLogEntries = [];
|
|
foreach ($changeLog->toArray() as $line) {
|
|
$lineParts = explode('|', $line);
|
|
if (count($lineParts) < 3) {
|
|
continue;
|
|
}
|
|
|
|
if (!is_numeric(str_replace('.', '', trim($lineParts[1])))) {
|
|
continue;
|
|
}
|
|
|
|
$changeLogEntries[] = [trim($lineParts[1]), trim($lineParts[2])];
|
|
}
|
|
|
|
return $changeLogEntries;
|
|
}
|
|
}
|