Startseite>PHP-Quellcode>Andere Kategorien
Herunterladen

Slevomat-Kodierungsstandard

Build-Status

Slevomat Coding Standard für PHP_CodeSniffer bietet Sniffs, die in drei Kategorien fallen:

  • Funktional – Verbesserung der Sicherheit und des Verhaltens von Code
  • Reinigen – toten Code erkennen
  • Formatierung – Regeln für ein einheitliches Code-Erscheinungsbild

Inhaltsverzeichnis

  1. Alphabetische Liste der Sniffs
  2. Installation
  3. So führen Sie die Sniffs aus
  • Wählen Sie aus, welche Sniffs ausgeführt werden sollen
  • Schließen Sie Sniffs aus, die Sie nicht ausführen möchten
  1. Fehler automatisch beheben
  2. Sniffs lokal unterdrücken
  3. Mitwirken

Alphabetische Liste der Sniffs

= Automatische Fehlerbehebung

= Sniff-Check kann lokal unterdrückt werden

  • SlevomatCodingStandard.Arrays.AlphabeticallySortedByKeys
  • 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.Complexity.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.AlphabeticallySortedUses
  • 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.UselessSemikolon
  • SlevomatCodingStandard.Strings.DisallowVariableParsing
  • SlevomatCodingStandard.TypeHints.DeclareStrictTypes
  • SlevomatCodingStandard.TypeHints.DisallowArrayTypeHintSyntax
  • 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

Die empfohlene Methode zur Installation von Slevomat Coding Standard ist Composer. 

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

Es wird außerdem empfohlen, php-parallel-lint/php-parallel-lint zu installieren, das den Quellcode auf Syntaxfehler überprüft. Sniffs gehen davon aus, dass der verarbeitete Code syntaktisch gültig ist (keine Analysefehler), andernfalls können sie sich unerwartet verhalten. Es wird empfohlen PHP-Parallel-Lint in Ihrem Build-Tool auszuführen, bevor Sie PHP_CodeSniffer ausführen und den Build-Prozess vorzeitig beenden, wenn PHP-Parallel-Lint fehlschlägt.

So führen Sie die Sniffs aus

Sie können eine von zwei Möglichkeiten wählen, um nur ausgewählte Sniffs aus dem Standard in Ihrer Codebasis auszuführen:

Wählen Sie aus, welche Sniffs ausgeführt werden sollen

Die empfohlene Methode besteht darin, Ihre eigene Ruleset.xml zu schreiben und dabei nur auf die ausgewählten Sniffs zu verweisen. Dies ist ein Beispiel für Ruleset.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 >

Führen Sie dann die ausführbare phpcs Datei wie gewohnt aus: 

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

Schließen Sie Sniffs aus, die Sie nicht ausführen möchten

Sie können Slevomat Coding Standard auch in der ruleset.xml Ihres Projekts erwähnen und nur einige Sniffs ausschließen: 

<? 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 >

Es handelt sich jedoch nicht um eine empfohlene Methode zur Verwendung des Slevomat Coding Standard, da Ihr Build beim Wechsel zwischen Nebenversionen des Standards abbrechen kann (was passieren kann, wenn Sie die Versionseinschränkung ^ oder ~ in composer.json verwenden). Wir fügen auch in Nebenversionen regelmäßig neue Sniffs hinzu, was bedeutet, dass Ihr Code höchstwahrscheinlich nicht mit neuen Nebenversionen des Pakets kompatibel ist.

Fehler automatisch beheben

Sniffs in diesem Standard, die mit dem Symbol gekennzeichnet sind, unterstützen die automatische Behebung von Verstößen gegen Codierungsstandards. Um Ihren Code automatisch zu reparieren, führen Sie phpcbf anstelle von phppcs aus: 

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

Denken Sie immer daran, Ihren Code zu sichern, bevor Sie automatische Korrekturen durchführen, und überprüfen Sie die Ergebnisse mit eigenen Augen, da die automatische Korrektur manchmal zu unerwünschten Ergebnissen führen kann.

Sniffs lokal unterdrücken

Ausgewählte Sniffs in diesem Standard, die durch das Symbol gekennzeichnet sind, können mithilfe einer Annotation für einen bestimmten Codeabschnitt unterdrückt werden. Betrachten Sie das folgende Beispiel: 

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

}

Der Parameter $max könnte einen nativen skalaren int -Typhinweis haben. Aber da die Methode in der übergeordneten Klasse diesen Typhinweis nicht hat, kann diese ihn auch nicht haben. PHP_CodeSniffer zeigt einen folgenden Fehler: 

 ----------------------------------------------------------------------
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)

Wenn wir diesen Fehler unterdrücken möchten, anstatt ihn zu beheben, können wir den Fehlercode ( SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint ) nehmen und ihn mit einer @phpcsSuppress Annotation wie dieser verwenden: 

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

}

Mitwirken

Damit dieses Repository auf Ihrem Computer funktioniert, klonen Sie es und führen Sie diese beiden Befehle im Stammverzeichnis des Repositorys aus: 

 composer install
bin/phing

Nachdem Sie Code geschrieben und Komponententests bearbeitet oder hinzugefügt haben, führen Sie Phing erneut aus, um zu überprüfen, ob alles in Ordnung ist: 

 bin/phing

Wir freuen uns immer über eure Bugreports, Feature Requests und Pull Requests. Danke schön.

Verhaltenskodex

Dieses Projekt unterliegt einem Verhaltenskodex für Mitwirkende. Durch die Teilnahme an diesem Projekt und seiner Community wird von Ihnen erwartet, dass Sie diesen Kodex einhalten.

Expandieren
Zusätzliche Informationen
Ähnliche Anwendungen
Empfohlen für Sie
Ähnliche Nachrichten Alle