mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 06:45:44 +01:00
819d734a00When we change the contract of a validator, or create a new one, we need to ensure that the mixin for the validator is present and matches the validator's constructor. This commit changes the current class that generates those mixin classes, converting it into a linter so we can run it in the GitHub workflow to check for missing changes.
87 lines
2.3 KiB
PHP
87 lines
2.3 KiB
PHP
<?php
|
|
|
|
/*
|
|
* SPDX-License-Identifier: MIT
|
|
* SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
* SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Respect\Dev\Commands;
|
|
|
|
use Respect\Dev\Differ\ConsoleDiffer;
|
|
use Respect\Dev\Differ\Item;
|
|
use Respect\Dev\Markdown\File;
|
|
use Respect\Dev\Markdown\Linter;
|
|
use Symfony\Component\Console\Attribute\AsCommand;
|
|
use Symfony\Component\Console\Command\Command;
|
|
use Symfony\Component\Console\Input\InputInterface;
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
use Symfony\Component\Finder\Finder;
|
|
|
|
use function count;
|
|
use function dirname;
|
|
use function sprintf;
|
|
|
|
#[AsCommand(
|
|
name: 'lint:docs',
|
|
description: 'Apply documentation linters and optionally auto-fix issues',
|
|
)]
|
|
final class LintDocsCommand extends Command
|
|
{
|
|
public function __construct(
|
|
private readonly ConsoleDiffer $differ,
|
|
private readonly Linter $linter,
|
|
) {
|
|
parent::__construct();
|
|
}
|
|
|
|
protected function configure(): void
|
|
{
|
|
$this->addOption(
|
|
'fix',
|
|
null,
|
|
null,
|
|
'Automatically fix files with issues.',
|
|
);
|
|
}
|
|
|
|
protected function execute(InputInterface $input, OutputInterface $output): int
|
|
{
|
|
$finder = new Finder();
|
|
$finder->in(dirname(__DIR__, 2) . '/docs')->files()->name('*.md');
|
|
|
|
$lintedFiles = [];
|
|
foreach ($finder as $file) {
|
|
$original = File::from($file);
|
|
$linted = $this->linter->lint($original);
|
|
if ($linted === $original) {
|
|
continue;
|
|
}
|
|
|
|
$lintedFiles[] = $linted;
|
|
|
|
$output->writeln($this->differ->diff(
|
|
new Item($original->filename, $original->content->build()),
|
|
new Item($linted->filename, $linted->content->build()),
|
|
));
|
|
}
|
|
|
|
if ($lintedFiles === []) {
|
|
$output->writeln('<info>No changes needed.</info>');
|
|
} else {
|
|
$output->writeln(sprintf('<comment>Changes needed in %d files.</comment>', count($lintedFiles)));
|
|
}
|
|
|
|
if ($lintedFiles !== [] && !$input->getOption('fix')) {
|
|
return Command::FAILURE;
|
|
}
|
|
|
|
foreach ($lintedFiles as $linted) {
|
|
$linted->save();
|
|
}
|
|
|
|
return Command::SUCCESS;
|
|
}
|
|
}
|