Page d'accueil>Code source PHP>Autres catégories
Télécharger

Norme de codage Slevomat

Statut de construction

Slevomat Coding Standard pour PHP_CodeSniffer fournit des sniffs qui se répartissent en trois catégories :

  • Fonctionnel - améliorer la sécurité et le comportement du code
  • Nettoyage - détection du code mort
  • Formatage - règles pour une apparence de code cohérente

Table des matières

  1. Liste alphabétique des reniflements
  2. Installation
  3. Comment exécuter les reniflements
  • Choisissez les reniflements à exécuter
  • Excluez les reniflements que vous ne souhaitez pas exécuter
  1. Correction automatique des erreurs
  2. Suppression des reniflements localement
  3. Contribuer

Liste alphabétique des reniflements

= Correction automatique des erreurs

= Le contrôle Sniff peut être supprimé localement

  • SlevomatCodingStandard.Arrays.AlphabeicallySortedByKeys
  • SlevomatCodingStandard.Arrays.DisallowImplicitArrayCreation
  • SlevomatCodingStandard.Arrays.DisallowPartiallyKeyed
  • SlevomatCodingStandard.Arrays.MultiLineArrayEndBracketPlacement
  • SlevomatCodingStandard.Arrays.ArrayAccessSniff.php
  • SlevomatCodingStandard.Arrays.SingleLineArrayWhitespace
  • SlevomatCodingStandard.Arrays.TrailingArrayComma
  • SlevomatCodingStandard.Attributes.AttributeAndTargetSpacing
  • SlevomatCodingStandard.Attributes.AttributesOrder
  • SlevomatCodingStandard.Attributes.DisallowAttributesJoining
  • SlevomatCodingStandard.Attributes.DisallowMultipleAttributesPerLine
  • SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment
  • SlevomatCodingStandard.Classes.BackedEnumTypeSpacing
  • SlevomatCodingStandard.Classes.ClassConstantVisibility
  • SlevomatCodingStandard.Classes.ClassLength
  • SlevomatCodingStandard.Classes.ClassMemberSpacing
  • SlevomatCodingStandard.Classes.ClassStructure
  • SlevomatCodingStandard.Classes.ConstantSpacing
  • SlevomatCodingStandard.Classes.DisallowConstructorPropertyPromotion
  • SlevomatCodingStandard.Classes.DisallowLateStaticBindingForConstants
  • SlevomatCodingStandard.Classes.DisallowMultiConstantDefinition
  • SlevomatCodingStandard.Classes.DisallowMultiPropertyDefinition
  • SlevomatCodingStandard.Classes.DisallowStringExpressionPropertyFetch
  • SlevomatCodingStandard.Classes.EmptyLinesAroundClassBraces
  • SlevomatCodingStandard.Classes.EnumCaseSpacing
  • SlevomatCodingStandard.Classes.ForbiddenPublicProperty
  • SlevomatCodingStandard.Classes.MethodSpacing
  • SlevomatCodingStandard.Classes.ModernClassNameReference
  • SlevomatCodingStandard.Classes.ParentCallSpacing
  • SlevomatCodingStandard.Classes.PropertyDeclaration
  • SlevomatCodingStandard.Classes.PropertySpacing
  • SlevomatCodingStandard.Classes.RequireAbstractOrFinal
  • SlevomatCodingStandard.Classes.RequireConstructorPropertyPromotion
  • SlevomatCodingStandard.Classes.RequireMultiLineMethodSignature
  • SlevomatCodingStandard.Classes.RequireSelfReference
  • SlevomatCodingStandard.Classes.RequireSingleLineMethodSignature
  • SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming
  • SlevomatCodingStandard.Classes.SuperfluousErrorNaming
  • SlevomatCodingStandard.Classes.SuperfluousExceptionNaming
  • SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming
  • SlevomatCodingStandard.Classes.SuperfluousTraitNaming
  • SlevomatCodingStandard.Classes.TraitUseDeclaration
  • SlevomatCodingStandard.Classes.TraitUseSpacing
  • SlevomatCodingStandard.Classes.UselessLateStaticBinding
  • SlevomatCodingStandard.Commenting.AnnotationName
  • SlevomatCodingStandard.Commenting.DeprecatedAnnotationDeclaration
  • SlevomatCodingStandard.Commenting.DisallowCommentAfterCode
  • SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment
  • SlevomatCodingStandard.Commenting.DocCommentSpacing
  • SlevomatCodingStandard.Commenting.EmptyComment
  • SlevomatCodingStandard.Commenting.ForbiddenAnnotations
  • SlevomatCodingStandard.Commenting.ForbiddenComments
  • SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration
  • SlevomatCodingStandard.Commenting.RequireOneLineDocComment
  • SlevomatCodingStandard.Commenting.RequireOneLinePropertyDocComment
  • SlevomatCodingStandard.Commenting.UselessFunctionDocComment
  • SlevomatCodingStandard.Commenting.UselessInheritDocComment
  • SlevomatCodingStandard.Complexité.Cognitive
  • SlevomatCodingStandard.ControlStructures.AssignmentInCondition
  • SlevomatCodingStandard.ControlStructures.BlockControlStructureSpacing
  • SlevomatCodingStandard.ControlStructures.DisallowContinueWithoutIntegerOperandInSwitch
  • SlevomatCodingStandard.ControlStructures.DisallowEmpty
  • SlevomatCodingStandard.ControlStructures.DisallowNullSafeObjectOperator
  • SlevomatCodingStandard.ControlStructures.DisallowShortTernaryOperator
  • SlevomatCodingStandard.ControlStructures.DisallowTrailingMultiLineTernaryOperatorSniff
  • SlevomatCodingStandard.ControlStructures.DisallowYodaComparison
  • SlevomatCodingStandard.ControlStructures.EarlyExit
  • SlevomatCodingStandard.ControlStructures.JumpStatementsSpacing
  • SlevomatCodingStandard.ControlStructures.LanguageConstructWithParentheses
  • SlevomatCodingStandard.ControlStructures.NewWithParentheses
  • SlevomatCodingStandard.ControlStructures.NewWithoutParentheses
  • SlevomatCodingStandard.ControlStructures.RequireMultiLineCondition
  • SlevomatCodingStandard.ControlStructures.RequireMultiLineTernaryOperator
  • SlevomatCodingStandard.ControlStructures.RequireNullCoalesceEqualOperator
  • SlevomatCodingStandard.ControlStructures.RequireNullCoalesceOperator
  • SlevomatCodingStandard.ControlStructures.RequireNullSafeObjectOperator
  • SlevomatCodingStandard.ControlStructures.RequireShortTernaryOperator
  • SlevomatCodingStandard.ControlStructures.RequireSingleLineCondition
  • SlevomatCodingStandard.ControlStructures.RequireTernaryOperator
  • SlevomatCodingStandard.ControlStructures.RequireYodaComparison
  • SlevomatCodingStandard.ControlStructures.UselessIfConditionWithReturn
  • SlevomatCodingStandard.ControlStructures.UselessTernaryOperator
  • SlevomatCodingStandard.Exceptions.DeadCatch
  • SlevomatCodingStandard.Exceptions.DisallowNonCapturingCatch
  • SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly
  • SlevomatCodingStandard.Exceptions.RequireNonCapturingCatch
  • SlevomatCodingStandard.Files.FileLength
  • SlevomatCodingStandard.Files.LineLength
  • SlevomatCodingStandard.Files.TypeNameMatchesFileName
  • SlevomatCodingStandard.Functions.ArrowFunctionDeclaration
  • SlevomatCodingStandard.Functions.DisallowArrowFunction
  • SlevomatCodingStandard.Functions.DisallowEmptyFunction
  • SlevomatCodingStandard.Functions.DisallowNamedArguments
  • SlevomatCodingStandard.Functions.DisallowTrailingCommaInCall
  • SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse
  • SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration
  • SlevomatCodingStandard.Functions.FunctionLength
  • SlevomatCodingStandard.Functions.NamedArgumentSpacing
  • SlevomatCodingStandard.Functions.RequireArrowFunction
  • SlevomatCodingStandard.Functions.RequireMultiLineCall
  • SlevomatCodingStandard.Functions.RequireSingleLineCall
  • SlevomatCodingStandard.Functions.RequireTrailingCommaInCall
  • SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse
  • SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration
  • SlevomatCodingStandard.Functions.StaticClosure
  • SlevomatCodingStandard.Functions.StrictCall
  • SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure
  • SlevomatCodingStandard.Functions.UnusedParameter
  • SlevomatCodingStandard.Functions.UselessParameterDefaultValue
  • SlevomatCodingStandard.Namespaces.AlphabeicallySortedUses
  • SlevomatCodingStandard.Namespaces.DisallowGroupUse
  • SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation
  • SlevomatCodingStandard.Namespaces.FullyQualifiedExceptions
  • SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalConstants
  • SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalFunctions
  • SlevomatCodingStandard.Namespaces.MultipleUsesPerLine
  • SlevomatCodingStandard.Namespaces.NamespaceDeclaration
  • SlevomatCodingStandard.Namespaces.NamespaceSpacing
  • SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
  • SlevomatCodingStandard.Namespaces.RequireOneNamespaceInFile
  • SlevomatCodingStandard.Namespaces.UnusedUses
  • SlevomatCodingStandard.Namespaces.UseDoesNotStartWithBackslash
  • SlevomatCodingStandard.Namespaces.UseFromSameNamespace
  • SlevomatCodingStandard.Namespaces.UseOnlyWhitelistedNamespaces
  • SlevomatCodingStandard.Namespaces.UseSpacing
  • SlevomatCodingStandard.Namespaces.UselessAlias
  • SlevomatCodingStandard.Numbers.DisallowNumericLiteralSeparator
  • SlevomatCodingStandard.Numbers.RequireNumericLiteralSeparator
  • SlevomatCodingStandard.Operators.DisallowEqualOperators
  • SlevomatCodingStandard.Operators.DisallowIncrementAndDecrementOperators
  • SlevomatCodingStandard.Operators.NegationOperatorSpacing
  • SlevomatCodingStandard.Operators.RequireCombinedAssignmentOperator
  • SlevomatCodingStandard.Operators.RequireOnlyStandaloneIncrementAndDecrementOperators
  • SlevomatCodingStandard.Operators.SpreadOperatorSpacing
  • SlevomatCodingStandard.PHP.DisallowDirectMagicInvokeCall
  • SlevomatCodingStandard.PHP.DisallowReference
  • SlevomatCodingStandard.PHP.ForbiddenClasses
  • SlevomatCodingStandard.PHP.OptimizedFunctionsWithoutUnpacking
  • SlevomatCodingStandard.PHP.ReferenceSpacing
  • SlevomatCodingStandard.PHP.RequireExplicitAssertion
  • SlevomatCodingStandard.PHP.RequireNowdoc
  • SlevomatCodingStandard.PHP.ShortList
  • SlevomatCodingStandard.PHP.TypeCast
  • SlevomatCodingStandard.PHP.UselessParentheses
  • SlevomatCodingStandard.PHP.UselessSemicolon
  • SlevomatCodingStandard.Strings.DisallowVariableParsing
  • SlevomatCodingStandard.TypeHints.DeclareStrictTypes
  • SlevomatCodingStandard.TypeHints.DisallowArrayTypeHintSyntaxe
  • SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint
  • SlevomatCodingStandard.TypeHints.LongTypeHints
  • SlevomatCodingStandard.TypeHints.NullTypeHintOnLastPosition
  • SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue
  • SlevomatCodingStandard.TypeHints.ParameterTypeHint
  • SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing
  • SlevomatCodingStandard.TypeHints.PropertyTypeHint
  • SlevomatCodingStandard.TypeHints.ReturnTypeHint
  • SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing
  • SlevomatCodingStandard.TypeHints.UnionTypeHintFormat
  • SlevomatCodingStandard.TypeHints.UselessConstantTypeHint
  • SlevomatCodingStandard.Variables.DisallowVariableVariable
  • SlevomatCodingStandard.Variables.DisallowSuperGlobalVariable
  • SlevomatCodingStandard.Variables.DuplicateAssignmentToVariable
  • SlevomatCodingStandard.Variables.UnusedVariable
  • SlevomatCodingStandard.Variables.UselessVariable
  • SlevomatCodingStandard.Whitespaces.DuplicateSpaces

Installation

La méthode recommandée pour installer Slevomat Coding Standard consiste à utiliser Composer. 

{
	"require-dev" : {
		"slevomat/coding-standard" : " ~8.0 "
	}
}

Il est également recommandé d'installer php-parallel-lint/php-parallel-lint qui vérifie le code source pour les erreurs de syntaxe. Les sniffs comptent sur le code traité pour être syntaxiquement valide (pas d'erreurs d'analyse), sinon ils peuvent se comporter de manière inattendue. Il est conseillé d'exécuter PHP-Parallel-Lint dans votre outil de build avant d'exécuter PHP_CodeSniffer et de quitter le processus de build plus tôt si PHP-Parallel-Lint échoue.

Comment exécuter les reniflements

Vous pouvez choisir l'une des deux manières d'exécuter uniquement les sniffs sélectionnés à partir de la norme sur votre base de code :

Choisissez les reniflements à exécuter

La méthode recommandée consiste à écrire votre propre fichier Ruleset.xml en référençant uniquement les sniffs sélectionnés. Voici un exemple de jeu de règles.xml : 

<? xml version = " 1.0 " ?>
< ruleset name = " AcmeProject " >
	< config name = " installed_paths " value = " ../../slevomat/coding-standard " /> <!-- relative path from PHPCS source location -->
	< rule ref = " SlevomatCodingStandard.Arrays.TrailingArrayComma " />
	<!-- other sniffs to include -->
</ ruleset >

Ensuite, lancez l'exécutable phpcs de la manière habituelle : 

 vendor/bin/phpcs --standard=ruleset.xml --extensions=php --tab-width=4 -sp src tests

Excluez les reniflements que vous ne souhaitez pas exécuter

Vous pouvez également mentionner Slevomat Coding Standard dans ruleset.xml de votre projet et exclure uniquement certains sniffs : 

<? xml version = " 1.0 " ?>
< ruleset name = " AcmeProject " >
	< rule ref = " vendor/slevomat/coding-standard/SlevomatCodingStandard/ruleset.xml " > <!-- relative path to your ruleset.xml -->
		<!-- sniffs to exclude -->
	</ rule >
</ ruleset >

Cependant, ce n'est pas une manière recommandée d'utiliser Slevomat Coding Standard, car votre build peut s'interrompre lors du déplacement entre des versions mineures du standard (ce qui peut arriver si vous utilisez la contrainte de version ^ ou ~ dans composer.json ). Nous ajoutons régulièrement de nouveaux sniffs, même dans les versions mineures, ce qui signifie que votre code ne sera probablement pas conforme aux nouvelles versions mineures du package.

Correction automatique des erreurs

Les sniffs dans cette norme marqués du symbole prennent en charge la correction automatique des violations des normes de codage. Pour corriger votre code automatiquement, exécutez phpcbf au lieu de phpcs : 

 vendor/bin/phpcbf --standard=ruleset.xml --extensions=php --tab-width=4 -sp src tests

N'oubliez pas de sauvegarder votre code avant d'effectuer des correctifs automatiques et de vérifier les résultats de vos propres yeux, car le correcteur automatique peut parfois produire des résultats indésirables.

Suppression des reniflements localement

Les reniflements sélectionnés dans cette norme marqués par le symbole peuvent être supprimés pour un morceau de code spécifique à l'aide d'une annotation. Prenons l'exemple suivant : 

 /**
 * @param int $max
 */
public function createProgressBar ( $ max = 0 ): ProgressBar
{

}

Le paramètre $max pourrait avoir un indice de type scalaire int natif. Mais comme la méthode de la classe parent n’a pas cette indication de type, celle-ci ne peut pas non plus l’avoir. PHP_CodeSniffer affiche l'erreur suivante : 

 ----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 67 | ERROR | [x] Method ErrorsConsoleStyle::createProgressBar()
    |       |     does not have native type hint for its parameter $max
    |       |     but it should be possible to add it based on @param
    |       |     annotation "int".
    |       |     (SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint)

Si nous voulons supprimer cette erreur au lieu de la corriger, nous pouvons prendre le code d'erreur ( SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint ) et l'utiliser avec une annotation @phpcsSuppress comme celle-ci : 

 /**
 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
 * @param int $max
 */
public function createProgressBar ( $ max = 0 ): ProgressBar
{

}

Contribuer

Pour faire fonctionner ce référentiel sur votre machine, clonez-le et exécutez ces deux commandes dans le répertoire racine du référentiel : 

 composer install
bin/phing

Après avoir écrit du code et modifié ou ajouté des tests unitaires, exécutez à nouveau phing pour vérifier que tout va bien : 

 bin/phing

Nous attendons toujours avec impatience vos rapports de bogues, vos demandes de fonctionnalités et vos demandes d'extraction. Merci.

Code de conduite

Ce projet adhère à un code de conduite des contributeurs. En participant à ce projet et à sa communauté, vous êtes censé respecter ce code.

Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout