Merge pull request #160 from oliverklee/cleanup/php-74-language-level

[TASK] Use more PHP 7.4 language features

src/Linter/Configuration/YamlConfigurationLoader.php

@@ -44,13 +44,13 @@ public function __construct(FileLocatorInterface $locator, YamlParser $yamlParse
      * Loads a resource.
      *
      * @param mixed $resource The resource
-     * @param string $type The resource type
+     * @param string|null $type The resource type
      *
      * @return array
      *
      * @psalm-suppress MethodSignatureMismatch
      */
-    public function load($resource, $type = null): array
+    public function load(mixed $resource, ?string $type = null): array
     {
         try {
             /** @var string $path */
@@ -67,13 +67,13 @@ public function load($resource, $type = null): array
      * Returns true if this class supports the given resource.
      *
      * @param mixed $resource A resource
-     * @param string $type The resource type
+     * @param string|null $type The resource type
      *
      * @return bool    true if this class supports the given resource, false otherwise
      *
      * @psalm-suppress MethodSignatureMismatch
      */
-    public function supports($resource, $type = null): bool
+    public function supports(mixed $resource, string $type = null): bool
     {
         return is_string($resource)
             && in_array(pathinfo($resource, PATHINFO_EXTENSION), ['yml', 'yaml']);

src/Linter/Linter.php

@@ -17,14 +17,11 @@
 class Linter implements LinterInterface
 {
 
-    /** @var TokenizerInterface */
-    private $tokenizer;
+    private TokenizerInterface $tokenizer;
 
-    /** @var ParserInterface */
-    private $parser;
+    private ParserInterface $parser;
 
-    /** @var SniffLocator */
-    private $sniffLocator;
+    private SniffLocator $sniffLocator;
 
     public function __construct(TokenizerInterface $tokenizer, ParserInterface $parser, SniffLocator $sniffLocator)
     {
@@ -33,14 +30,6 @@ public function __construct(TokenizerInterface $tokenizer, ParserInterface $pars
         $this->sniffLocator = $sniffLocator;
     }
 
-    /**
-     * @param string $filename
-     * @param Report $report
-     * @param LinterConfiguration $configuration
-     * @param LinterLoggerInterface $logger
-     *
-     * @return File
-     */
     public function lintFile(
         string $filename,
         Report $report,
@@ -69,12 +58,7 @@ public function lintFile(
     }
 
     /**
-     * @param TokenInterface[] $tokens
-     * @param File $file
-     * @param LinterConfiguration $configuration
-     * @param LinterLoggerInterface $logger
-     *
-     * @return File
+     * @psalm-param TokenInterface[] $tokens
      */
     private function lintTokenStream(
         array $tokens,
@@ -98,12 +82,7 @@ private function lintTokenStream(
     }
 
     /**
-     * @param Statement[] $statements
-     * @param File $file
-     * @param LinterConfiguration $configuration
-     * @param LinterLoggerInterface $logger
-     *
-     * @return File
+     * @psalm-param Statement[] $statements
      */
     private function lintSyntaxTree(
         array $statements,

src/Linter/LinterConfiguration.php

@@ -8,8 +8,7 @@
 class LinterConfiguration implements ConfigurationInterface
 {
 
-    /** @var array */
-    private $configuration = [];
+    private array $configuration = [];
 
     public function setConfiguration(array $configuration): void
     {

src/Linter/LinterInterface.php

@@ -8,15 +8,6 @@
 
 interface LinterInterface
 {
-
-    /**
-     * @param string $filename
-     * @param Report $report
-     * @param LinterConfiguration $configuration
-     * @param LinterLoggerInterface $logger
-     *
-     * @return File
-     */
     public function lintFile(
         string $filename,
         Report $report,

src/Linter/Report/File.php

@@ -13,27 +13,16 @@
 class File
 {
 
-    /** @var string */
-    private $filename;
+    private string $filename;
 
     /** @var Issue[] */
-    private $issues = [];
+    private array $issues = [];
 
-    /**
-     * Constructs a new file report.
-     *
-     * @param string $filename The filename.
-     */
     public function __construct(string $filename)
     {
         $this->filename = $filename;
     }
 
-    /**
-     * Gets the filename.
-     *
-     * @return string The filename.
-     */
     public function getFilename(): string
     {
         return $this->filename;
@@ -61,9 +50,7 @@ public function getIssues(): array
     {
         usort(
             $this->issues,
-            function (Issue $a, Issue $b): int {
-                return ($a->getLine() ?? 0) - ($b->getLine() ?? 0);
-            }
+            fn(Issue $a, Issue $b): int => ($a->getLine() ?? 0) - ($b->getLine() ?? 0)
         );
         return $this->issues;
     }
@@ -77,9 +64,7 @@ function (Issue $a, Issue $b): int {
      */
     public function getIssuesBySeverity(string $severity): array
     {
-        return array_values(array_filter($this->getIssues(), function (Issue $i) use ($severity): bool {
-            return $i->getSeverity() === $severity;
-        }));
+        return array_values(array_filter($this->getIssues(), fn(Issue $i): bool => $i->getSeverity() === $severity));
     }
 
     /**

src/Linter/Report/Issue.php

@@ -16,24 +16,19 @@
 class Issue
 {
 
-    const SEVERITY_INFO = "info";
-    const SEVERITY_WARNING = "warning";
-    const SEVERITY_ERROR = "error";
+    public const SEVERITY_INFO = "info";
+    public const SEVERITY_WARNING = "warning";
+    public const SEVERITY_ERROR = "error";
 
-    /** @var int|null */
-    private $line;
+    private ?int $line = null;
 
-    /** @var int|null */
-    private $column;
+    private ?int $column = null;
 
-    /** @var string */
-    private $message;
+    private string $message;
 
-    /** @var string */
-    private $severity;
+    private string $severity;
 
-    /** @var string */
-    private $source;
+    private string $source;
 
     /**
      * Creates a new warning from a parse error.

src/Linter/Report/Report.php

@@ -14,7 +14,7 @@ class Report
 {
 
     /** @var File[] */
-    private $files = [];
+    private array $files = [];
 
     /**
      * Adds a sub-report for a specific file.

src/Linter/ReportPrinter/CheckstyleReportPrinter.php

@@ -22,8 +22,7 @@
 class CheckstyleReportPrinter implements Printer
 {
 
-    /** @var OutputInterface */
-    private $output;
+    private OutputInterface $output;
 
     /**
      * Constructs a new checkstyle report printer.

src/Linter/ReportPrinter/ConsoleReportPrinter.php

@@ -19,8 +19,7 @@
 class ConsoleReportPrinter implements Printer
 {
 
-    /** @var OutputInterface */
-    private $output;
+    private OutputInterface $output;
 
     /**
      * Constructs a new console report printer.

src/Linter/ReportPrinter/GccReportPrinter.php

@@ -18,8 +18,7 @@
 class GccReportPrinter implements Printer
 {
 
-    /** @var OutputInterface */
-    private $output;
+    private OutputInterface $output;
 
     /**
      * Constructs a new GCC report printer.

src/Linter/ReportPrinter/Printer.php

@@ -8,17 +8,10 @@
  * Interface definition for code linting report printers.
  *
  * @package    Helmich\TypoScriptLint
- * @subpcakage Linter\ReportPrinter
+ * @subpackage Linter\ReportPrinter
  */
 interface Printer
 {
 
-    /**
-     * Writes a report.
-     *
-     * @param Report $report
-     *
-     * @return void
-     */
     public function writeReport(Report $report): void;
 }

src/Linter/Sniff/AbstractSyntaxTreeSniff.php

@@ -17,9 +17,6 @@
 abstract class AbstractSyntaxTreeSniff implements SyntaxTreeSniffInterface
 {
 
-    /**
-     * @param array $parameters
-     */
     public function __construct(array $parameters)
     {
     }
@@ -44,8 +41,5 @@ public function sniff(array $statements, File $file, LinterConfiguration $config
         }
     }
 
-    /**
-     * @return SniffVisitor
-     */
     abstract protected function buildVisitor(): SniffVisitor;
 }

src/Linter/Sniff/ConfigNoCacheSniff.php

@@ -7,9 +7,6 @@
 
 class ConfigNoCacheSniff extends AbstractSyntaxTreeSniff
 {
-    /**
-     * @return SniffVisitor
-     */
     protected function buildVisitor(): SniffVisitor
     {
         return new ConfigNoCacheVisitor();

src/Linter/Sniff/DeadCodeSniff.php

@@ -12,11 +12,8 @@
 class DeadCodeSniff implements TokenStreamSniffInterface
 {
 
-    const ANNOTATION_COMMENT = '/^\s*([a-z0-9]+=(.*?))(;\s*[a-z0-9]+=(.*?))*\s*$/';
+    public const ANNOTATION_COMMENT = '/^\s*([a-z0-9]+=(.*?))(;\s*[a-z0-9]+=(.*?))*\s*$/';
 
-    /**
-     * @param array $parameters
-     */
     public function __construct(array $parameters)
     {
     }
@@ -51,7 +48,7 @@ public function sniff(array $tokens, File $file, LinterConfiguration $configurat
                             0,
                             'Found commented code (' . $matches[0] . ').',
                             Issue::SEVERITY_INFO,
-                            __CLASS__
+                            self::class
                         ));
                     } catch (\Exception $e) {
                         // pass

src/Linter/Sniff/DuplicateAssignmentSniff.php

@@ -7,9 +7,6 @@
 
 class DuplicateAssignmentSniff extends AbstractSyntaxTreeSniff
 {
-    /**
-     * @return SniffVisitor
-     */
     protected function buildVisitor(): SniffVisitor
     {
         return new DuplicateAssignmentVisitor();