CS: update ruleset for PHP8 (#112)

janedbal · web-flow · commit 0faab1e9b3ec · 2025-01-31T12:48:17.000+01:00
* CS: update ruleset for PHP8

* Only latest psr/log
diff --git a/composer.json b/composer.json
@@ -18,7 +18,7 @@
         "phpstan/phpstan-phpunit": "^2.0.0",
         "phpstan/phpstan-strict-rules": "^2.0.0",
         "phpunit/phpunit": "^10.5.29",
-        "psr/log": "^1 || ^2 || ^3",
+        "psr/log": "^3",
         "shipmonk/composer-dependency-analyser": "^1.7.0",
         "shipmonk/phpstan-rules": "^4.0.0",
         "slevomat/coding-standard": "^8.15.0"
diff --git a/composer.lock b/composer.lock
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -4,7 +4,7 @@
     xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
     name="ShipMonk Generic Coding Standard"
 >
-    <config name="php_version" value="70400"/>
+    <config name="php_version" value="80100"/>
     <arg name="basepath" value="."/>
     <arg name="extensions" value="php"/>
     <arg name="parallel" value="80"/>
@@ -244,9 +244,7 @@
     </rule>
 
     <rule ref="SlevomatCodingStandard.Arrays.TrailingArrayComma"/>
-    <rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference">
-        <exclude name="SlevomatCodingStandard.Classes.ModernClassNameReference.ClassNameReferencedViaFunctionCall"/> <!-- after bumping to PHP8 -->
-    </rule>
+    <rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference"/>
     <rule ref="SlevomatCodingStandard.Classes.ClassConstantVisibility" />
     <rule ref="SlevomatCodingStandard.Classes.ClassStructure">
         <properties>
@@ -265,8 +263,19 @@
     <rule ref="SlevomatCodingStandard.Classes.DisallowLateStaticBindingForConstants" />
     <rule ref="SlevomatCodingStandard.Classes.DisallowMultiConstantDefinition" />
     <rule ref="SlevomatCodingStandard.Classes.DisallowMultiPropertyDefinition" />
+    <rule ref="SlevomatCodingStandard.Classes.DisallowStringExpressionPropertyFetch"/>
     <rule ref="SlevomatCodingStandard.Classes.MethodSpacing" />
+    <rule ref="SlevomatCodingStandard.Classes.EnumCaseSpacing">
+        <properties>
+            <property name="minLinesCountBeforeWithComment" value="0"/>
+            <property name="maxLinesCountBeforeWithComment" value="1"/>
+            <property name="minLinesCountBeforeWithoutComment" value="0"/>
+            <property name="maxLinesCountBeforeWithoutComment" value="1"/>
+        </properties>
+    </rule>
     <rule ref="SlevomatCodingStandard.Classes.EmptyLinesAroundClassBraces"/>
+    <rule ref="SlevomatCodingStandard.Classes.PropertyDeclaration"/>
+    <rule ref="SlevomatCodingStandard.Classes.RequireSelfReference"/>
     <rule ref="SlevomatCodingStandard.Classes.TraitUseDeclaration" />
     <rule ref="SlevomatCodingStandard.Classes.TraitUseSpacing" />
     <rule ref="SlevomatCodingStandard.Classes.DisallowConstructorPropertyPromotion" />
@@ -280,7 +289,11 @@
     </rule>
     <rule ref="SlevomatCodingStandard.Commenting.EmptyComment"/>
     <rule ref="SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment"/>
-    <rule ref="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration"/>
+    <rule ref="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration">
+        <properties>
+            <property name="allowAboveNonAssignment" value="true"/>
+        </properties>
+    </rule>
     <rule ref="SlevomatCodingStandard.Commenting.UselessInheritDocComment"/>
     <rule ref="SlevomatCodingStandard.Commenting.ForbiddenComments">
         <properties>
@@ -300,12 +313,33 @@
     <rule ref="SlevomatCodingStandard.Exceptions.DeadCatch"/>
     <rule ref="SlevomatCodingStandard.Exceptions.RequireNonCapturingCatch"/>
     <rule ref="SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly"/>
-    <rule ref="SlevomatCodingStandard.Functions.DisallowArrowFunction"/>
+    <rule ref="SlevomatCodingStandard.Functions.ArrowFunctionDeclaration">
+        <properties>
+            <property name="allowMultiLine" value="true" />
+        </properties>
+    </rule>
+    <rule ref="SlevomatCodingStandard.Functions.NamedArgumentSpacing"/>
+    <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse">
+        <properties>
+            <property name="onlySingleLine" value="true"/>
+        </properties>
+    </rule>
+    <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration">
+        <properties>
+            <property name="onlySingleLine" value="true"/>
+        </properties>
+    </rule>
+    <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInCall">
+        <properties>
+            <property name="onlySingleLine" value="true"/>
+        </properties>
+    </rule>
+    <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse"/>
+    <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration"/>
     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall"/>
     <rule ref="SlevomatCodingStandard.Functions.StaticClosure"/>
     <rule ref="SlevomatCodingStandard.Functions.UselessParameterDefaultValue"/>
     <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure"/>
-    <rule ref="SlevomatCodingStandard.Functions.DisallowArrowFunction"/>
     <rule ref="SlevomatCodingStandard.Namespaces.UseFromSameNamespace"/>
     <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses">
         <properties>
@@ -392,6 +426,7 @@
     <rule ref="SlevomatCodingStandard.TypeHints.LongTypeHints"/>
     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>
     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
+    <rule ref="SlevomatCodingStandard.Variables.DisallowVariableVariable"/>
     <rule ref="SlevomatCodingStandard.Variables.DuplicateAssignmentToVariable"/>
     <rule ref="SlevomatCodingStandard.Variables.UnusedVariable">
         <properties>
diff --git a/src/Command/MigrationCheckCommand.php b/src/Command/MigrationCheckCommand.php
@@ -23,7 +23,7 @@ class MigrationCheckCommand extends Command
     private MigrationService $migrationService;
 
     public function __construct(
-        MigrationService $migrationService
+        MigrationService $migrationService,
     )
     {
         parent::__construct();
diff --git a/src/Command/MigrationGenerateCommand.php b/src/Command/MigrationGenerateCommand.php
@@ -14,7 +14,7 @@ class MigrationGenerateCommand extends Command
     private MigrationService $migrationService;
 
     public function __construct(
-        MigrationService $migrationService
+        MigrationService $migrationService,
     )
     {
         parent::__construct();
diff --git a/src/Command/MigrationInitCommand.php b/src/Command/MigrationInitCommand.php
@@ -13,7 +13,7 @@ class MigrationInitCommand extends Command
     private MigrationService $migrationService;
 
     public function __construct(
-        MigrationService $migrationService
+        MigrationService $migrationService,
     )
     {
         parent::__construct();
diff --git a/src/Command/MigrationRunCommand.php b/src/Command/MigrationRunCommand.php
@@ -23,7 +23,7 @@ class MigrationRunCommand extends Command
     private MigrationService $migrationService;
 
     public function __construct(
-        MigrationService $migrationService
+        MigrationService $migrationService,
     )
     {
         parent::__construct();
diff --git a/src/MigrationConfig.php b/src/MigrationConfig.php
@@ -36,7 +36,7 @@ public function __construct(
         ?string $migrationClassPrefix = null,
         ?array $excludedTables = null,
         ?string $templateFilePath = null,
-        ?string $templateIndent = null
+        ?string $templateIndent = null,
     )
     {
         $templateFilePathToUse = $templateFilePath ?? __DIR__ . '/template/migration.txt';
diff --git a/src/MigrationDefaultExecutor.php b/src/MigrationDefaultExecutor.php
@@ -14,7 +14,7 @@ class MigrationDefaultExecutor implements MigrationExecutor
     private Connection $connection;
 
     public function __construct(
-        Connection $connection
+        Connection $connection,
     )
     {
         $this->connection = $connection;
diff --git a/src/MigrationRun.php b/src/MigrationRun.php
@@ -19,7 +19,7 @@ public function __construct(
         string $version,
         MigrationPhase $phase,
         DateTimeImmutable $startedAt,
-        DateTimeImmutable $finishedAt
+        DateTimeImmutable $finishedAt,
     )
     {
         $this->version = $version;
diff --git a/src/MigrationService.php b/src/MigrationService.php
@@ -40,7 +40,7 @@ public function __construct(
         MigrationConfig $config,
         ?MigrationExecutor $executor = null,
         ?MigrationVersionProvider $versionProvider = null,
-        ?MigrationAnalyzer $migrationsAnalyzer = null
+        ?MigrationAnalyzer $migrationsAnalyzer = null,
     )
     {
         $this->entityManager = $entityManager;
diff --git a/tests/CachingSqlLogger.php b/tests/CachingSqlLogger.php
@@ -19,14 +19,12 @@ class CachingSqlLogger implements LoggerInterface
     private array $queries = [];
 
     /**
-     * @param mixed $level
-     * @param string|Stringable $message
      * @param mixed[] $context
      */
     public function log(
-        $level,
-        $message,
-        array $context = []
+        mixed $level,
+        string|Stringable $message,
+        array $context = [],
     ): void
     {
         if (isset($context['sql'])) {
diff --git a/tests/MigrationServiceTest.php b/tests/MigrationServiceTest.php
@@ -295,7 +295,7 @@ private function createMigrationService(
         array $excludedTables = [],
         bool $transactional = false,
         ?MigrationVersionProvider $versionProvider = null,
-        ?MigrationAnalyzer $statementAnalyzer = null
+        ?MigrationAnalyzer $statementAnalyzer = null,
     ): MigrationService
     {
         $migrationsDir = $this->getMigrationsTestDir();

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class MigrationCheckCommand extends Command`
`23`	`23`	`private MigrationService $migrationService;`
`24`	`24`
`25`	`25`	`public function __construct(`
`26`		`- MigrationService $migrationService`
	`26`	`+ MigrationService $migrationService,`
`27`	`27`	`)`
`28`	`28`	`{`
`29`	`29`	`parent::__construct();`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ class MigrationGenerateCommand extends Command`
`14`	`14`	`private MigrationService $migrationService;`
`15`	`15`
`16`	`16`	`public function __construct(`
`17`		`- MigrationService $migrationService`
	`17`	`+ MigrationService $migrationService,`
`18`	`18`	`)`
`19`	`19`	`{`
`20`	`20`	`parent::__construct();`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class MigrationInitCommand extends Command`
`13`	`13`	`private MigrationService $migrationService;`
`14`	`14`
`15`	`15`	`public function __construct(`
`16`		`- MigrationService $migrationService`
	`16`	`+ MigrationService $migrationService,`
`17`	`17`	`)`
`18`	`18`	`{`
`19`	`19`	`parent::__construct();`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class MigrationRunCommand extends Command`
`23`	`23`	`private MigrationService $migrationService;`
`24`	`24`
`25`	`25`	`public function __construct(`
`26`		`- MigrationService $migrationService`
	`26`	`+ MigrationService $migrationService,`
`27`	`27`	`)`
`28`	`28`	`{`
`29`	`29`	`parent::__construct();`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function __construct(`
`36`	`36`	`?string $migrationClassPrefix = null,`
`37`	`37`	`?array $excludedTables = null,`
`38`	`38`	`?string $templateFilePath = null,`
`39`		`- ?string $templateIndent = null`
	`39`	`+ ?string $templateIndent = null,`
`40`	`40`	`)`
`41`	`41`	`{`
`42`	`42`	`$templateFilePathToUse = $templateFilePath ?? __DIR__ . '/template/migration.txt';`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ class MigrationDefaultExecutor implements MigrationExecutor`
`14`	`14`	`private Connection $connection;`
`15`	`15`
`16`	`16`	`public function __construct(`
`17`		`- Connection $connection`
	`17`	`+ Connection $connection,`
`18`	`18`	`)`
`19`	`19`	`{`
`20`	`20`	`$this->connection = $connection;`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public function __construct(`
`19`	`19`	`string $version,`
`20`	`20`	`MigrationPhase $phase,`
`21`	`21`	`DateTimeImmutable $startedAt,`
`22`		`- DateTimeImmutable $finishedAt`
	`22`	`+ DateTimeImmutable $finishedAt,`
`23`	`23`	`)`
`24`	`24`	`{`
`25`	`25`	`$this->version = $version;`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public function __construct(`
`40`	`40`	`MigrationConfig $config,`
`41`	`41`	`?MigrationExecutor $executor = null,`
`42`	`42`	`?MigrationVersionProvider $versionProvider = null,`
`43`		`- ?MigrationAnalyzer $migrationsAnalyzer = null`
	`43`	`+ ?MigrationAnalyzer $migrationsAnalyzer = null,`
`44`	`44`	`)`
`45`	`45`	`{`
`46`	`46`	`$this->entityManager = $entityManager;`
Original file line number	Diff line number	Diff line change
`@@ -295,7 +295,7 @@ private function createMigrationService(`
`295`	`295`	`array $excludedTables = [],`
`296`	`296`	`bool $transactional = false,`
`297`	`297`	`?MigrationVersionProvider $versionProvider = null,`
`298`		`- ?MigrationAnalyzer $statementAnalyzer = null`
	`298`	`+ ?MigrationAnalyzer $statementAnalyzer = null,`
`299`	`299`	`): MigrationService`
`300`	`300`	`{`
`301`	`301`	`$migrationsDir = $this->getMigrationsTestDir();`