phpstan strict rules

Règles extra strictes et opinionnées pour phpstan

PHPSTAN se concentre sur la recherche de bogues dans votre code. Mais en PHP, il y a beaucoup de latitude dans la façon dont les choses peuvent être écrites. Ce référentiel contient des règles supplémentaires qui tournent autour du code strictement et fortement dactylographié sans casting lâche pour ceux qui souhaitent une sécurité supplémentaire dans une programmation extrêmement défensive:

• Nécessitent des booléens dans l'opérateur de ternaire if , elseif , après ! , et des deux côtés de && et || .
• Exiger des opérandes ou des tableaux numériques dans les opérandes + et numériques dans - / * / / / ** / % .
• Exiger l'opérande numérique dans $var++ , $var-- , ++$var et --$var .
• Ces fonctions contiennent un paramètre $strict pour une meilleure sécurité de type, il doit être défini sur true :
  • in_array (3ème paramètre)
  • array_search (3ème paramètre)
  • array_keys (3ème paramètre; uniquement si le 2ème paramètre $search_value est fourni)
  • base64_decode (2ème paramètre)
• Les variables attribuées dans la condition de boucle while la boucle et for l'attribution initiale de la boucle ne peuvent pas être utilisées après la boucle.
• Les variables établies dans foreach qui sont toujours en boucle grâce à des tableaux non vides ne peuvent pas être utilisés après la boucle.
• Les types de l'état switch et la valeur case doivent correspondre. PHP les compare librement par défaut et cela peut conduire à des résultats inattendus.
• Vérifiez que les méthodes statistiquement déclarées sont appelées statiquement.
• Interdire empty() - C'est une comparaison très lâche (voir manuel), il est recommandé d'en utiliser un plus strict.
• Interdire l'opérateur ternaire court ( ?: :) - implique une comparaison faible, il est recommandé d'utiliser un opérateur de coalesce nul ( ?? ) ou un opérateur ternaire avec une condition stricte.
• Interdire les variables variables ( $$foo , $this->$method() etc.)
• Interdire les variables d'écrasement avec des variables de clé FOREACH et de valeur
• Toujours vrai instanceof , la vérification des types is_* Fonctions et comparaisons strictes === / !== . Ces vérifications peuvent être désactivées en définissant checkAlwaysTrueInstanceof Of / checkAlwaysTrueCheckTypeFunctionCall / checkAlwaysTrueStrictComparison à false.
• Affaire correcte pour les noms de fonction référencés et appelés.
• CORT CORRECT POUR LES NOMS DE MÉTHODES HÉRÉRITÉ ET IMPLETISSE.
• Ventelle pour les types de paramètres et la covariance pour les types de retour dans les méthodes héréditaires (également connues sous le nom de principe de substitution de Liskov - LSP)
• Vérifiez le LSP même pour les méthodes statiques
• Exiger d'appeler le constructeur parent
• Interdire l'utilisation de Backtick Operator ( $ls = `ls -la` )
• La fermeture doit $this utiliser directement au lieu d'utiliser $this variable indirectement

Des règles supplémentaires arrivent dans les versions ultérieures!

Installation

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

 composer require --dev phpstan/phpstan-strict-rules

Si vous installez également PhpStan / Extension-Installer, vous êtes tous réglés!

Installation manuelle

Si vous ne souhaitez pas utiliser phpstan/extension-installer , incluez des règles.neon dans la configuration phpstan de votre projet:

 includes:
    - vendor/phpstan/phpstan-strict-rules/rules.neon

Règles de désactivation

Vous pouvez désactiver les règles en utilisant les paramètres de configuration:

 parameters :
	strictRules :
		disallowedLooseComparison : false
		booleansInConditions : false
		uselessCast : false
		requireParentConstructorCall : false
		disallowedBacktick : false
		disallowedEmpty : false
		disallowedImplicitArrayCreation : false
		disallowedShortTernary : false
		overwriteVariablesWithLoop : false
		closureUsesThis : false
		matchingInheritedMethodNames : false
		numericOperandsInArithmeticOperators : false
		strictFunctionCalls : false
		dynamicCallOnStaticMethod : false
		switchConditionsMatchingType : false
		noVariableVariables : false
		strictArrayFilter : false
		illegalConstructorMethodCall : false

En plus d'introduire de nouvelles règles personnalisées, PhpStan-STRICT-RULES modifie également les valeurs par défaut de certains paramètres de configuration qui sont présents dans PHPSTAN lui-même. Ces paramètres sont documentés sur phpstan.org.

Permettre des règles un par un

Si vous ne voulez pas commencer à utiliser toutes les règles strictes disponibles à la fois mais seulement une ou deux, vous le pouvez!

Vous pouvez désactiver toutes les règles des rules.neon incluses.

 parameters :
	strictRules :
		allRules : false

Ensuite, vous pouvez réactiver les règles individuelles avec des paramètres de configuration:

 parameters :
	strictRules :
		allRules : false
		booleansInConditions : true

Même avec strictRules.allRules false En effet, PhpStan-STRICT-RULES modifie également les valeurs par défaut de certains paramètres de configuration qui sont présents dans PHPSTAN lui-même. Ces paramètres sont documentés sur phpstan.org.