Merge pull request #124 from jrfnl/feature/cs-update

CS update after upstream changes

Author: jaapio

phpcs.xml.dist

@@ -1,21 +1,35 @@
 <?xml version="1.0"?>
-<ruleset name="phpDocumentor">
-    <description>The coding standard for phpDocumentor.</description>
+<ruleset name="TypeResolver">
+    <description>The coding standard for this library.</description>
 
     <file>src</file>
     <file>tests/unit</file>
-    <exclude-pattern>*/tests/unit/Types/ContextFactoryTest.php</exclude-pattern>
+    <exclude-pattern>*/tests/unit/Types/ContextFactoryTest\.php</exclude-pattern>
     <arg value="p"/>
 
+    <!-- Set the minimum PHP version for PHPCompatibility.
+         This should be kept in sync with the requirements in the composer.json file. -->
+    <config name="testVersion" value="7.2-"/>
+
     <rule ref="phpDocumentor">
+        <!-- Property type declarations are a PHP 7.4 feature. -->
+        <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint"/>
     </rule>
 
     <rule ref="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming.SuperfluousPrefix">
-        <exclude-pattern>*/src/*/Abstract*.php</exclude-pattern>
+        <exclude-pattern>*/src/*/Abstract*\.php</exclude-pattern>
     </rule>
 
     <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
-        <exclude-pattern>*/src/PseudoTypes/False_.php</exclude-pattern>
-        <exclude-pattern>*/src/PseudoTypes/True_.php</exclude-pattern>
+        <exclude-pattern>*/src/PseudoTypes/False_\.php</exclude-pattern>
+        <exclude-pattern>*/src/PseudoTypes/True_\.php</exclude-pattern>
+    </rule>
+
+	<!-- Ignore two PHP 8.0 constants which are being polyfilled in the file using them. -->
+    <rule ref="PHPCompatibility.Constants.NewConstants.t_name_qualifiedFound">
+        <exclude-pattern>*/src/Types/ContextFactory\.php</exclude-pattern>
+    </rule>
+    <rule ref="PHPCompatibility.Constants.NewConstants.t_name_fully_qualifiedFound">
+        <exclude-pattern>*/src/Types/ContextFactory\.php</exclude-pattern>
     </rule>
 </ruleset>

src/FqsenResolver.php

@@ -15,6 +15,7 @@
 
 use InvalidArgumentException;
 use phpDocumentor\Reflection\Types\Context;
+
 use function explode;
 use function implode;
 use function strpos;
@@ -29,7 +30,7 @@ class FqsenResolver
     /** @var string Definition of the NAMESPACE operator in PHP */
     private const OPERATOR_NAMESPACE = '\\';
 
-    public function resolve(string $fqsen, ?Context $context = null) : Fqsen
+    public function resolve(string $fqsen, ?Context $context = null): Fqsen
     {
         if ($context === null) {
             $context = new Context('');
@@ -45,7 +46,7 @@ public function resolve(string $fqsen, ?Context $context = null) : Fqsen
     /**
      * Tests whether the given type is a Fully Qualified Structural Element Name.
      */
-    private function isFqsen(string $type) : bool
+    private function isFqsen(string $type): bool
     {
         return strpos($type, self::OPERATOR_NAMESPACE) === 0;
     }
@@ -56,7 +57,7 @@ private function isFqsen(string $type) : bool
      *
      * @throws InvalidArgumentException When type is not a valid FQSEN.
      */
-    private function resolvePartialStructuralElementName(string $type, Context $context) : Fqsen
+    private function resolvePartialStructuralElementName(string $type, Context $context): Fqsen
     {
         $typeParts = explode(self::OPERATOR_NAMESPACE, $type, 2);
 

src/PseudoType.php

@@ -15,5 +15,5 @@
 
 interface PseudoType extends Type
 {
-    public function underlyingType() : Type;
+    public function underlyingType(): Type;
 }

src/PseudoTypes/CallableString.php

@@ -24,15 +24,15 @@
  */
 final class CallableString extends String_ implements PseudoType
 {
-    public function underlyingType() : Type
+    public function underlyingType(): Type
     {
         return new String_();
     }
 
     /**
      * Returns a rendered output of the Type as it would be used in a DocBlock.
      */
-    public function __toString() : string
+    public function __toString(): string
     {
         return 'callable-string';
     }

src/PseudoTypes/False_.php

@@ -16,6 +16,7 @@
 use phpDocumentor\Reflection\PseudoType;
 use phpDocumentor\Reflection\Type;
 use phpDocumentor\Reflection\Types\Boolean;
+
 use function class_alias;
 
 /**
@@ -25,12 +26,12 @@
  */
 final class False_ extends Boolean implements PseudoType
 {
-    public function underlyingType() : Type
+    public function underlyingType(): Type
     {
         return new Boolean();
     }
 
-    public function __toString() : string
+    public function __toString(): string
     {
         return 'false';
     }

src/PseudoTypes/HtmlEscapedString.php

@@ -24,15 +24,15 @@
  */
 final class HtmlEscapedString extends String_ implements PseudoType
 {
-    public function underlyingType() : Type
+    public function underlyingType(): Type
     {
         return new String_();
     }
 
     /**
      * Returns a rendered output of the Type as it would be used in a DocBlock.
      */
-    public function __toString() : string
+    public function __toString(): string
     {
         return 'html-escaped-string';
     }

src/PseudoTypes/LowercaseString.php

@@ -24,15 +24,15 @@
  */
 final class LowercaseString extends String_ implements PseudoType
 {
-    public function underlyingType() : Type
+    public function underlyingType(): Type
     {
         return new String_();
     }
 
     /**
      * Returns a rendered output of the Type as it would be used in a DocBlock.
      */
-    public function __toString() : string
+    public function __toString(): string
     {
         return 'lowercase-string';
     }

src/PseudoTypes/NonEmptyLowercaseString.php

@@ -24,15 +24,15 @@
  */
 final class NonEmptyLowercaseString extends String_ implements PseudoType
 {
-    public function underlyingType() : Type
+    public function underlyingType(): Type
     {
         return new String_();
     }
 
     /**
      * Returns a rendered output of the Type as it would be used in a DocBlock.
      */
-    public function __toString() : string
+    public function __toString(): string
     {
         return 'non-empty-lowercase-string';
     }

src/PseudoTypes/NonEmptyString.php

@@ -24,15 +24,15 @@
  */
 final class NonEmptyString extends String_ implements PseudoType
 {
-    public function underlyingType() : Type
+    public function underlyingType(): Type
     {
         return new String_();
     }
 
     /**
      * Returns a rendered output of the Type as it would be used in a DocBlock.
      */
-    public function __toString() : string
+    public function __toString(): string
     {
         return 'non-empty-string';
     }

src/PseudoTypes/NumericString.php

@@ -24,15 +24,15 @@
  */
 final class NumericString extends String_ implements PseudoType
 {
-    public function underlyingType() : Type
+    public function underlyingType(): Type
     {
         return new String_();
     }
 
     /**
      * Returns a rendered output of the Type as it would be used in a DocBlock.
      */
-    public function __toString() : string
+    public function __toString(): string
     {
         return 'numeric-string';
     }