Improve package coding style

Author: nyamsprod

.php-cs-fixer.php

@@ -11,21 +11,31 @@
         '@PSR2' => true,
         'array_syntax' => ['syntax' => 'short'],
         'concat_space' => ['spacing' => 'none'],
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
+        'list_syntax' => ['syntax' => 'short'],
         'new_with_braces' => true,
         'no_blank_lines_after_phpdoc' => true,
         'no_empty_phpdoc' => true,
         'no_empty_comment' => true,
         'no_leading_import_slash' => true,
-        'no_superfluous_phpdoc_tags' => true,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'remove_inheritdoc' => true,
+            'allow_unused_params' => false,
+        ],
         'no_trailing_comma_in_singleline_array' => true,
         'no_unused_imports' => true,
         'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
-        'phpdoc_add_missing_param_annotation' => ['only_untyped' => false],
+        'phpdoc_add_missing_param_annotation' => ['only_untyped' => true],
         'phpdoc_align' => true,
         'phpdoc_no_empty_return' => true,
         'phpdoc_order' => true,
         'phpdoc_scalar' => true,
-        'phpdoc_to_comment' => false,
+        'phpdoc_to_comment' => true,
         'phpdoc_summary' => true,
         'psr_autoloading' => true,
         'return_type_declaration' => ['space_before' => 'none'],
@@ -36,7 +46,5 @@
         'trailing_comma_in_multiline' => true,
         'trim_array_spaces' => true,
         'whitespace_after_comma_in_array' => true,
-        'yoda_style' => true,
     ])
-    ->setFinder($finder)
-;
+    ->setFinder($finder);

src/DomainTest.php

@@ -5,6 +5,7 @@
 namespace Pdp;
 
 use PHPUnit\Framework\TestCase;
+use stdClass;
 use TypeError;
 
 /**
@@ -314,7 +315,7 @@ public function withLabelWorksProvider(): iterable
     public function testWithLabelFailsWithTypeError(): void
     {
         $this->expectException(TypeError::class);
-        Domain::fromIDNA2008('example.com')->withLabel(1, new \stdClass());
+        Domain::fromIDNA2008('example.com')->withLabel(1, new stdClass());
     }
 
     public function testWithLabelFailsWithInvalidKey(): void

src/Idna.php

@@ -99,7 +99,7 @@ public static function toAscii(string $domain, int $options): IdnaInfo
 
         self::supportsIdna();
 
-        /** @param-out array{errors: int, isTransitionalDifferent: bool, result: string} $idnaInfo */
+        /* @param-out array{errors: int, isTransitionalDifferent: bool, result: string} $idnaInfo */
         idn_to_ascii($domain, $options, INTL_IDNA_VARIANT_UTS46, $idnaInfo);
 
         /** @var array{result:string, isTransitionalDifferent:bool, errors:int} $idnaInfo */
@@ -124,7 +124,7 @@ public static function toUnicode(string $domain, int $options): IdnaInfo
 
         self::supportsIdna();
 
-        /** @param-out array{errors: int, isTransitionalDifferent: bool, result: string} $idnaInfo */
+        /* @param-out array{errors: int, isTransitionalDifferent: bool, result: string} $idnaInfo */
         idn_to_utf8($domain, $options, INTL_IDNA_VARIANT_UTS46, $idnaInfo);
 
         /** @var array{result:string, isTransitionalDifferent:bool, errors:int} $idnaInfo */

src/Storage/PublicSuffixListPsr16CacheTest.php

@@ -4,6 +4,8 @@
 
 namespace Pdp\Storage;
 
+use DateInterval;
+use DateTimeImmutable;
 use InvalidArgumentException;
 use Pdp\Rules;
 use PHPUnit\Framework\TestCase;
@@ -54,7 +56,7 @@ public function testItReturnsNullIfTheCacheContentCannotBeConvertedToTheCorrectI
         $cache = $this->createStub(CacheInterface::class);
         $cache->method('get')->willReturn('{"foo":"bar"}');
 
-        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateTimeImmutable('+1 DAY'));
+        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateTimeImmutable('+1 DAY'));
 
         self::assertNull($pslCache->fetch('http://www.example.com'));
     }
@@ -65,7 +67,7 @@ public function testItCanStoreAPublicSuffixListInstance(): void
         $cache->method('set')->willReturn(true);
 
         $psl = Rules::fromPath(dirname(__DIR__, 2).'/test_data/public_suffix_list.dat');
-        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateInterval('P1D'));
+        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateInterval('P1D'));
 
         self::assertTrue($pslCache->remember('http://www.example.com', $psl));
     }
@@ -76,7 +78,7 @@ public function testItReturnsFalseIfItCantStoreAPublicSuffixListInstance(): void
         $cache->method('set')->willReturn(false);
 
         $psl = Rules::fromPath(dirname(__DIR__, 2).'/test_data/public_suffix_list.dat');
-        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateInterval('P1D'));
+        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateInterval('P1D'));
 
         self::assertFalse($pslCache->remember('http://www.example.com', $psl));
     }
@@ -89,7 +91,7 @@ public function testItReturnsFalseIfItCantCacheAPublicSuffixListInstance(): void
         $cache->method('set')->will(self::throwException($exception));
 
         $psl = Rules::fromPath(dirname(__DIR__, 2).'/test_data/public_suffix_list.dat');
-        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateInterval('P1D'));
+        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateInterval('P1D'));
 
         self::assertFalse($pslCache->remember('http://www.example.com', $psl));
     }
@@ -120,7 +122,7 @@ public function testItCanDeleteTheCachedDatabase(): void
         $cache = $this->createStub(CacheInterface::class);
         $cache->method('delete')->willReturn(true);
 
-        $instance = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateInterval('P1D'));
+        $instance = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateInterval('P1D'));
         self::assertTrue($instance->forget($uri));
     }
 

src/TopLevelDomainList.php

@@ -24,9 +24,7 @@ public function version(): string;
      */
     public function lastUpdated(): DateTimeImmutable;
 
-    /**
-     * {@inheritdoc}
-     */
+    
     public function count(): int;
 
     /**