phpstan strict rules

Regras extras rigorosas e opinativas para o Phpstan

O Phpstan se concentra em encontrar bugs em seu código. Mas no PHP, há muita margem de manobra em como as coisas podem ser escritas. Este repositório contém regras adicionais que giram em torno de código tigido estritamente e fortemente sem elenco solto para quem deseja segurança adicional em programação extremamente defensiva:

• Requer booleanos em if , elseif , operador ternário, depois ! , e nos dois lados de && e || .
• Requerem operando numéricos ou matrizes nos operando + e numéricos em - / * / / / ** / % .
• Requer operando numérico em $var++ , $var-- , ++$var --$var .
• Essas funções contêm um parâmetro $strict para melhor segurança do tipo, ele deve ser definido como true :
  • in_array (3º parâmetro)
  • array_search (3º parâmetro)
  • array_keys (3º parâmetro; somente se o 2º parâmetro $search_value for fornecido)
  • base64_decode (2º parâmetro)
• As variáveis ​​atribuídas while condição de loop e for a atribuição inicial de loop não podem ser usadas após o loop.
• As variáveis ​​definidas em foreach que sempre são ampliadas graças a matrizes não vazias não podem ser usadas após o loop.
• Tipos na condição de switch e valor case deve corresponder. O PHP os compara vagamente por padrão e isso pode levar a resultados inesperados.
• Verifique se os métodos declarados estaticamente são chamados estaticamente.
• NÃO empty() - É uma comparação muito frouxa (consulte Manual), é recomendável usar mais rigoroso.
• O operador ternário curto proibido ( ?: :) - implica comparação fraca, é recomendável usar o operador nulo de coalesce ( ?? ) ou operador ternário com condição estrita.
• Não permitir variáveis ​​variáveis ​​( $$foo , $this->$method() etc.)
• Proibir variáveis ​​de substituição com as variáveis ​​de chave e valor foreach
• Sempre true instanceof , Funções is_* de verificação de tipo e comparações rigorosas === / !== . Essas verificações podem ser desligadas definindo checkAlwaysTrueInstanceof / checkAlwaysTrueCheckTypeFunctionCall / checkAlwaysTrueStrictComparison para false.
• Caso correto para nomes de funções referenciados e chamados.
• Caso correto para nomes de métodos herdados e implementados.
• Contravariância para tipos de parâmetros e covariância para tipos de retorno em métodos herdados (também conhecido como Princípio de Substituição de Liskov - LSP)
• Verifique o LSP mesmo para métodos estáticos
• Requer chamar o construtor pai
• Não permitir o uso do operador de backtick ( $ls = `ls -la` )
• O fechamento deve usar $this diretamente em vez de usar $this variável indiretamente

Regras adicionais estão chegando em lançamentos subsequentes!

Instalação

Para usar esta extensão, requer no compositor:

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

Se você também instalar o Phpstan/Extension-Installer, está tudo pronto!

Instalação manual

Se você não quiser usar phpstan/extension-installer , inclua regras.neon na configuração do Phpstan do seu projeto:

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

Desativar regras

Você pode desativar as regras usando parâmetros de configuração:

 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

Além de introduzir novas regras personalizadas, o Phpstan-Strict-Rules também altera os valores padrão de alguns parâmetros de configuração presentes no próprio Phpstan. Esses parâmetros estão documentados em phpstan.org.

Permitindo as regras um por um

Se você não quiser começar a usar todas as regras estritas disponíveis de uma só vez, mas apenas uma ou duas, você pode!

Você pode desativar todas as regras das rules.neon incluídas.

 parameters :
	strictRules :
		allRules : false

Em seguida, você pode reativar regras individuais com parâmetros de configuração:

 parameters :
	strictRules :
		allRules : false
		booleansInConditions : true

Mesmo com strictRules.allRules definidos como false , parte deste pacote ainda está em vigor. Isso ocorre porque o Phpstan-Strict-Rules também altera os valores padrão de alguns parâmetros de configuração presentes no próprio Phpstan. Esses parâmetros estão documentados em phpstan.org.