memio / linter
Memio's linter, a set of constraint that check models for syntax errors
Installs: 303 835
Dependents: 4
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 0
Requires
- php: ^7.2 || ^8.0
- memio/model: ^3.0
- memio/validator: ^3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.10
- phpspec/phpspec: ^6.1 || ^7.0
This package is auto-updated.
Last update: 2024-10-14 20:00:17 UTC
README
A set of Memio constraints that check Memio models for syntax errors and the likes.
Note: This package is part of Memio, a highly opinionated PHP code generator. Have a look at the main repository.
Installation
Install it using Composer:
$ composer require memio/linter:^3.0
Example
Usually we'd have to install Memio and use its
Build::linter()
method to get a linter validator.
The atlernative would be to build manually the validator as follow:
<?php require __DIR__.'/vendor/autoload.php'; use Memio\Validator\Constraint\ArgumentCannotBeScalar; use Memio\Validator\Constraint\CollectionCannotHaveNameDuplicates; use Memio\Validator\Constraint\ConcreteObjectMethodsCannotBeAbstract; use Memio\Validator\Constraint\ContractMethodsCanOnlyBePublic; use Memio\Validator\Constraint\ContractMethodsCannotBeFinal; use Memio\Validator\Constraint\ContractMethodsCannotBeStatic; use Memio\Validator\Constraint\ContractMethodsCannotHaveBody; use Memio\Validator\Constraint\MethodCannotBeAbstractAndHaveBody; use Memio\Validator\Constraint\MethodCannotBeBothAbstractAndFinal; use Memio\Validator\Constraint\MethodCannotBeBothAbstractAndPrivate; use Memio\Validator\Constraint\MethodCannotBeBothAbstractAndStatic; use Memio\Validator\Constraint\ObjectArgumentCanOnlyDefaultToNull; use Memio\Validator\ModelValidator\ArgumentValidator; use Memio\Validator\ModelValidator\CollectionValidator; use Memio\Validator\ModelValidator\MethodValidator; use Memio\Validator\ModelValidator\ContractValidator; use Memio\Validator\ModelValidator\ObjectValidator; use Memio\Validator\ModelValidator\FileValidator; use Memio\Validator\Validator; $argumentValidator = new ArgumentValidator(); $argumentValidator->add(new ArgumentCannotBeScalar()); $collectionValidator = new CollectionValidator(); $collectionValidator->add(new CollectionCannotHaveNameDuplicates()); $methodValidator = new MethodValidator($argumentValidator, $collectionValidator); $methodValidator->add(new MethodCannotBeAbstractAndHaveBody()); $methodValidator->add(new MethodCannotBeBothAbstractAndFinal()); $methodValidator->add(new MethodCannotBeBothAbstractAndPrivate()); $methodValidator->add(new MethodCannotBeBothAbstractAndStatic()); $contractValidator = new ContractValidator($collectionValidator, $methodValidator); $contractValidator->add(new ContractMethodsCanOnlyBePublic()); $contractValidator->add(new ContractMethodsCannotBeFinal()); $contractValidator->add(new ContractMethodsCannotBeStatic()); $contractValidator->add(new ContractMethodsCannotHaveBody()); $objectValidator = new ObjectValidator($collectionValidator, $methodValidator); $objectValidator->add(new ConcreteObjectMethodsCannotBeAbstract()); $objectValidator->add(new ObjectArgumentCanOnlyDefaultToNull()); $fileValidator = new FileValidator($contractValidator, $objectValidator); $linter = new Validator(); $linter->add($argumentValidator); $linter->add($collectionValidator); $linter->add($methodValidator); $linter->add($contractValidator); $linter->add($objectValidator); $linter->add($fileValidator); $linter->validator($anyModels);
Have a look at the main respository to discover the full power of Medio.
Want to know more?
Memio uses phpspec, which means the tests also provide the documentation. Not convinced? Then clone this repository and run the following commands:
$ composer install $ ./vendor/bin/phpspec run -n -f pretty
You can see the current and past versions using one of the following:
- the
git tag
command - the releases page on Github
- the file listing the changes between versions
And finally some meta documentation: