Merge pull request #4439 from oleibman/stan1001

Phpstan Tweaks

Author: oleibman

.github/workflows/main.yml

@@ -87,7 +87,7 @@ jobs:
 
       # This is non-ideal because it only checks for the last commit of the PR, not all of them, but better than nothing
       - name: Check PHPDoc types
-        run: ./bin/check-phpdoc-types
+        run: ./bin/check-phpdoc-types.php
 
   php-cs-fixer:
     runs-on: ubuntu-latest

.php-cs-fixer.dist.php

@@ -1,9 +1,8 @@
 <?php
 
 $finder = PhpCsFixer\Finder::create()
-    ->exclude('vendor')
+    ->exclude(['vendor', 'docs', '.git', '.github'])
     ->notPath('src/PhpSpreadsheet/Writer/ZipStream3.php')
-    ->name('/(\.php|^generate-document|^generate-locales|^check-phpdoc-types)$/')
     ->in(__DIR__);
 
 $config = new PhpCsFixer\Config();

.phpcs.xml.dist

@@ -6,12 +6,7 @@
     <file>src</file>
     <file>tests</file>
     <file>infra</file>
-    <file>bin/generate-document</file>
-    <file>bin/generate-locales</file>
-    <file>bin/check-phpdoc-types</file>
-
-    <exclude-pattern>samples/Header.php</exclude-pattern>
-    <exclude-pattern>*/tests/Core/*/*Test\.(inc|css|js)$</exclude-pattern>
+    <file>bin</file>
 
     <arg name="report-width" value="200"/>
     <arg name="parallel" value="80"/>

bin/check-phpdoc-types renamed to bin/check-phpdoc-types.php

@@ -8,7 +8,7 @@
  *
  * This will help us slowly migrate away from PHPDoc typing to PHP native typing.
  */
-function checkPhpDocTypes(): void
+function checkPhpDocTypes(): int
 {
     $content = shell_exec('git diff --cached') ?? shell_exec('git diff') ?? shell_exec('git show HEAD');
     preg_match_all('~^\+ +\* @(param|var) (mixed|string|int|float|bool|null|array|\?|\|)+( \$\w+)?$~m', "$content", $parameters);
@@ -19,11 +19,16 @@ function checkPhpDocTypes(): void
         ...$returns[0],
     ];
 
-    if ($errors) {
+    if (!empty($errors)) {
         echo 'PHP native types must be used instead of PHPDoc types (without comments), for the following lines:' . PHP_EOL . PHP_EOL;
         echo implode(PHP_EOL, $errors) . PHP_EOL;
-        exit(1);
+
+        return 1;
     }
+
+    return 0;
 }
 
-checkPhpDocTypes();
+if (checkPhpDocTypes()) {
+    exit(1);
+}

bin/generate-document renamed to bin/generate-document.php

@@ -4,7 +4,7 @@
 use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
 use PhpOffice\PhpSpreadsheetInfra\DocumentGenerator;
 
-require_once 'vendor/autoload.php';
+require_once __DIR__ . '/..' . '/vendor/autoload.php';
 
 $phpSpreadsheetFunctions = Calculation::getFunctions();
 ksort($phpSpreadsheetFunctions);

bin/generate-locales renamed to bin/generate-locales.php

@@ -4,7 +4,7 @@
 use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
 use PhpOffice\PhpSpreadsheetInfra\LocaleGenerator;
 
-require_once 'vendor/autoload.php';
+require_once __DIR__ . '/..' . '/vendor/autoload.php';
 
 $phpSpreadsheetFunctions = Calculation::getFunctions();
 

bin/pre-commit

@@ -24,7 +24,7 @@ if [ "$files" != "" ]; then
 fi
 
 # Check PHPDoc types
-./bin/check-phpdoc-types
+./bin/check-phpdoc-types.php
 if [ $? -ne 0 ]; then
     pass=false
 fi

composer.json

@@ -46,7 +46,7 @@
     ],
     "scripts": {
         "check": [
-            "php ./bin/check-phpdoc-types",
+            "php bin/check-phpdoc-types.php",
             "phpcs samples/ src/ tests/ --report=checkstyle",
             "phpcs samples/ src/ tests/ --standard=PHPCompatibility --runtime-set testVersion 8.0- --exclude=PHPCompatibility.Variables.ForbiddenThisUseContexts -n",
             "php-cs-fixer fix --ansi --dry-run --diff",

infra/DocumentGenerator.php

@@ -33,11 +33,19 @@ public static function generateFunctionListByCategory(array $phpSpreadsheetFunct
         return $result;
     }
 
+    /** @return array<string, string> */
     private static function getCategories(): array
     {
-        return (new ReflectionClass(Category::class))->getConstants();
+        /** @var array<string, string> */
+        $x = (new ReflectionClass(Category::class))->getConstants();
+
+        return $x;
     }
 
+    /**
+     * @param int[] $lengths
+     * @param null|array<int, int|string> $values
+     */
     private static function tableRow(array $lengths, ?array $values = null): string
     {
         $result = '';
@@ -46,7 +54,7 @@ private static function tableRow(array $lengths, ?array $values = null): string
             if ($i > 0) {
                 $result .= '|' . $pad;
             }
-            $result .= str_pad($value ?? '', $length, $pad);
+            $result .= str_pad("$value", $length ?? 0, $pad);
         }
 
         return rtrim($result, ' ');
@@ -71,7 +79,7 @@ private static function getPhpSpreadsheetFunctionText(mixed $functionCall): stri
     }
 
     /**
-     * @param array[] $phpSpreadsheetFunctions
+     * @param array<string, array<string, int|string>> $phpSpreadsheetFunctions
      */
     public static function generateFunctionListByName(array $phpSpreadsheetFunctions): string
     {

infra/LocaleGenerator.php

@@ -30,6 +30,7 @@ class LocaleGenerator
 
     protected string $translationBaseFolder;
 
+    /** @var string[] */
     protected array $phpSpreadsheetFunctions;
 
     protected Spreadsheet $translationSpreadsheet;
@@ -38,16 +39,23 @@ class LocaleGenerator
 
     protected Worksheet $localeTranslations;
 
+    /** @var string[] */
     protected array $localeLanguageMap = [];
 
+    /** @var array<string, int> */
     protected array $errorCodeMap = [];
 
     private Worksheet $functionNameTranslations;
 
+    /** @var string[] */
     protected array $functionNameLanguageMap = [];
 
+    /** @var array<string, int|string> */
     protected array $functionNameMap = [];
 
+    /**
+     * @param string[] $phpSpreadsheetFunctions
+     */
     public function __construct(
         string $translationBaseFolder,
         string $translationSpreadsheetName,
@@ -268,6 +276,7 @@ protected function getTranslationSheet(string $sheetName): Worksheet
         return $worksheet;
     }
 
+    /** @return string[] */
     protected function mapLanguageColumns(Worksheet $translationWorksheet): array
     {
         $sheetName = $translationWorksheet->getTitle();
@@ -282,7 +291,7 @@ protected function mapLanguageColumns(Worksheet $translationWorksheet): array
             $cells->setIterateOnlyExistingCells(true);
             foreach ($cells as $cell) {
                 if ($this->localeCanBeSupported($translationWorksheet, $cell)) {
-                    $languageNameMap[$cell->getColumn()] = $cell->getValue();
+                    $languageNameMap[$cell->getColumn()] = $cell->getValueString();
                     $this->log($cell->getColumn() . ' -> ' . $cell->getValueString());
                 }
             }