phpstan extensions

Extensions de phpstan slam

Extensions pour phpstan

Installation

Pour utiliser cette extension, nécessitez-le dans le compositeur:

composer require --dev slam/phpstan-extensions

Usage

Lorsque vous utilisez phpstan/extension-installer , conf/slam-rules.neon sera automatiquement inclus.

Sinon, vous devez inclure conf/slam-rules.neon dans votre phpstan.neon :

 includes :
    - vendor/slam/phpstan-extensions/conf/slam-rules.neon 

Règles

1. SlamPhpStanUnusedVariableRule : Vérifiez les fonctions à l'intérieur de la variable jamais utilisées après l'attribution initiale
2. SlamPhpStanMissingClosureParameterTypehintRule : nécessite un type de paramètre pour les fermetures; AVERTISSEMENT: Aucun PHPDOC autorisé, voir phpstan/phpstan-strict-rules#87
3. SlamPhpStanStringToClassRule : nécessite des chaînes qui se réfèrent aux classes à exprimer avec ::class
4. SlamPhpStanGotoRule : pas de goto autorisé
5. SlamPhpStanClassNotationRule :
   1. Les interfaces doivent se terminer avec "interface"
   2. Les traits doivent se terminer par "trait"
   3. Les classes abstraites doivent commencer par "Résumé"
   4. Les exceptions doivent se terminer par "exception"
6. SlamPhpStanPhpUnitFqcnAnnotationRule : les classes trouvées dans les annotations phpunit suivantes doivent exister:
   1. @expectedException
   2. @covers
   3. @coversDefaultClass
   4. @uses
7. SlamPhpStanAccessGlobalVariableWithinContextRule : inhibe l'accès aux globaux au sein des classes qui étendent ou implémentent une certaine classe / interface
8. SlamPhpStanAccessStaticPropertyWithinModelContextRule : Inhibit l'accès aux attributs statiques d'une classe dans les classes qui étendent ou implémentent une certaine classe / interface, utile pour interdire l'utilisation des singletons dans les modèles

Pas de configuration

Une configuration not-now-rules.neon est présente pour interdire les appels du système de date bruts:

 includes :
    - vendor/slam/phpstan-extensions/conf/not-now-rules.neon

Ces règles interdisent:

1. new DateTimeImmutable()
2. new DateTime('yesterday')
3. date('Ym-d')
4. time()
5. strtotime('noon')

Vous devriez plutôt compter sur une abstraction d'horloge comme lcobucci/clock .

Avertissement: les règles ne sont pas parfaites, un utilisateur peut les tromper facilement; Ils sont destinés uniquement à aider à la transition vers une abstraction d'horloge appropriée.

Configuration spécifique à Symfony

Une configuration symfony-rules.neon est présente pour les projets Symfony:

 includes :
    - vendor/slam/phpstan-extensions/conf/symfony-rules.neon

Avec les configurations suivantes:

1. SlamPhpStanSymfonyFilesystemRule : Les appels interdits au système de fichiers bruts fonctionnent bien enveloppé par le composant symfony/filesystem
2. SlamPhpStanSymfonyProcessRule : les appels interdits aux fonctions du système brut bien enveloppés par le composant symfony/process

Configuration spécifique à Yii

Une configuration yii-rules.neon est présente pour les projets YII:

 includes :
    - vendor/slam/phpstan-extensions/conf/yii-rules.neon

Avec les configurations suivantes:

1. SlamPhpStanAccessGlobalVariableWithinContextRule pour nier l'utilisation de $_GET , $_POST et d'autres variables globales dans les modèles implémentant yiidbActiveRecordInterface : l'accès aux singletons dans les modèles est considéré
2. SlamPhpStanAccessStaticPropertyWithinModelContextRule pour nier l'utilisation de variables statiques yiiBaseYii comme $app dans les modèles implémentant yiidbActiveRecordInterface : l'accès aux singletons dans les modèles est considéré comme un anti-anti-antinal