Add doc linter to check validator constructors

When we make changes to the code, renaming variables, or adding
parameters to a validator, it's easy to forget to update the
documentation.

With this change, we avoid having a disparity between the documentation
and the code.

Author: henriquemoody

bin/console

@@ -17,6 +17,7 @@ use Respect\Dev\Commands\UpdateDomainToplevelCommand;
 use Respect\Dev\Commands\UpdatePostalCodesCommand;
 use Respect\Dev\Markdown\CompositeLinter;
 use Respect\Dev\Markdown\Differ as MarkdownDiffer;
+use Respect\Dev\Markdown\Linters\ValidatorHeaderLinter;
 use Respect\Dev\Markdown\Linters\ValidatorIndexLinter;
 use SebastianBergmann\Diff\Differ;
 use SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder;
@@ -29,6 +30,7 @@ return (static function () {
     $application->addCommand(new CreateMixinCommand());
     $application->addCommand(new DocsLinterCommand($differ, new CompositeLinter(
         new ValidatorIndexLinter(),
+        new ValidatorHeaderLinter(),
     )));
     $application->addCommand(new UpdateDomainSuffixesCommand());
     $application->addCommand(new UpdateDomainToplevelCommand());

composer.json

@@ -72,13 +72,15 @@
         }
     },
     "scripts": {
+        "docs:validators:headers": "bin/console docs:validators:headers",
         "docs:validators:index": "bin/console docs:validators:index",
         "docheader": "vendor/bin/docheader check library/ tests/",
         "phpcs": "vendor/bin/phpcs",
         "phpstan": "vendor/bin/phpstan analyze",
         "phpunit": "vendor/bin/phpunit --testsuite=unit",
         "pest": "vendor/bin/pest --testsuite=feature --compact",
         "docs": [
+            "@docs:validators:headers",
             "@docs:validators:index"
         ],
         "qa": [

docs/validators/AllOf.md

@@ -1,6 +1,7 @@
 # AllOf
 
-- `AllOf(Validator $validator1, Validator $validator2, Validator ...$validator)`
+- `AllOf(Validator $validator1, Validator $validator2)`
+- `AllOf(Validator $validator1, Validator $validator2, Validator ...$validators)`
 
 Will validate if all inner validators validates.
 

docs/validators/AnyOf.md

@@ -1,6 +1,7 @@
 # AnyOf
 
-- `AnyOf(Validator $validator1, Validator $validator2, Validator ...$validator)`
+- `AnyOf(Validator $validator1, Validator $validator2)`
+- `AnyOf(Validator $validator1, Validator $validator2, Validator ...$validators)`
 
 This is a group validator that acts as an OR operator.
 

docs/validators/Base.md

@@ -1,6 +1,7 @@
 # Base
 
-- `Base(string $base)`
+- `Base(int $base)`
+- `Base(int $base, string $chars)`
 
 Validate numbers in any base, even with non regular bases.
 

docs/validators/Between.md

@@ -1,6 +1,6 @@
 # Between
 
-- `Between(mixed $minimum, mixed $maximum)`
+- `Between(mixed $minValue, mixed $maxValue)`
 
 Validates whether the input is between two other values.
 

docs/validators/Callback.md

@@ -1,6 +1,7 @@
 # Callback
 
 - `Callback(callable $callback)`
+- `Callback(callable $callback, mixed ...$arguments)`
 
 Validates the input using the return of a given callable.
 

docs/validators/Charset.md

@@ -1,6 +1,7 @@
 # Charset
 
-- `Charset(string ...$charset)`
+- `Charset(string $charset)`
+- `Charset(string $charset, string ...$charsets)`
 
 Validates if a string is in a specific charset.
 

docs/validators/Circuit.md

@@ -1,6 +1,7 @@
 # Circuit
 
-- `Circuit(Validator $validator1, Validator $validator2, Validator ...$validator)`
+- `Circuit(Validator $validator1, Validator $validator2)`
+- `Circuit(Validator $validator1, Validator $validator2, Validator ...$validators)`
 
 Validates the input against a series of validators until the first fails.
 

docs/validators/Contains.md

@@ -1,7 +1,7 @@
 # Contains
 
-- `Contains(mixed $expectedValue)`
-- `Contains(mixed $expectedValue, bool $identical)`
+- `Contains(mixed $containsValue)`
+- `Contains(mixed $containsValue, bool $identical)`
 
 Validates if the input contains some value.