[TASK] Introduce phpstan, rector and fractor, adapt php-cs-fixer configs, update composer.json and ext_emconf.php for TYPO3 13

davkraid · davkraid · commit e3383dbe6a7b · 2024-12-27T16:28:53.000+01:00
diff --git a/composer.json b/composer.json
@@ -27,18 +27,22 @@
     }
   ],
   "require": {
-    "php": ">=8.1",
-    "typo3/cms-backend": "^12.4",
-    "typo3/cms-core": "^12.4",
-    "typo3/cms-extbase": "^12.4",
-    "typo3/cms-frontend": "^12.4",
+    "php": ">=8.3",
+    "typo3/cms-backend": "^12.4 || ^13.4",
+    "typo3/cms-core": "^12.4 || ^13.4",
+    "typo3/cms-extbase": "^12.4 || ^13.4",
+    "typo3/cms-frontend": "^12.4 || ^13.4",
     "symfony/console": "^6.3",
     "doctrine/dbal": "^3.6"
   },
   "require-dev": {
     "phpunit/phpunit": "^10.0",
     "typo3/testing-framework": "^8.0",
-    "friendsofphp/php-cs-fixer": "^3.0"
+    "friendsofphp/php-cs-fixer": "^3.0",
+    "saschaegerer/phpstan-typo3": "^1.10",
+    "phpstan/phpstan": "^1.11",
+    "ssch/typo3-rector": "^2.5",
+    "a9f/typo3-fractor": "^0.4"
   },
   "suggest": {
     "jaybizzle/crawler-detect": "If you do not want to redirect bots.",
@@ -65,7 +69,8 @@
     "bin-dir": ".Build/bin",
     "allow-plugins": {
       "typo3/class-alias-loader": true,
-      "typo3/cms-composer-installers": true
+      "typo3/cms-composer-installers": true,
+      "a9f/fractor-extension-installer": true
     }
   },
   "scripts": {
@@ -74,7 +79,9 @@
       "mkdir -p .Build/public/typo3conf/ext/",
       "[ -L .Build/public/typo3conf/ext/locate ] || ln -snvf ../../../../. .Build/public/typo3conf/ext/locate"
     ],
-    "cs-fix": ".Build/bin/php-cs-fixer fix --config php-cs-fixer.php --using-cache no --show-progress dots -v"
+    "check:cs": "./.Build/bin/php-cs-fixer fix --dry-run --config ./php-cs-fixer.php --using-cache no --show-progress dots -v --diff --format=txt",
+    "fix:cs": "./.Build/bin/php-cs-fixer fix --config ./php-cs-fixer.php --using-cache no --show-progress dots -v --diff --format=txt",
+    "check:phpstan": "./.Build/bin/phpstan analyse -c ./phpstan.neon"
   },
   "extra": {
     "typo3/cms": {
diff --git a/ext_emconf.php b/ext_emconf.php
@@ -3,11 +3,11 @@
 $EM_CONF['locate'] = [
     'title' => 'Locate',
     'description' => 'The users country, preferred language and other facts will be detected. Depending on configurable rules the user can be redirected to other languages or pages. Locate also provides geo blocking for configurable pages in configurable countries.',
-    'version' => '12.0.3',
+    'version' => '13.0.0',
     'category' => 'fe',
     'constraints' => [
         'depends' => [
-            'typo3' => '12.4.0-12.4.99',
+            'typo3' => '12.4.0-13.4.99',
         ],
         'conflicts' => [],
         'suggests' => [
diff --git a/fractor.php b/fractor.php
@@ -0,0 +1,24 @@
+<?php
+
+use a9f\Fractor\Configuration\FractorConfiguration;
+use a9f\FractorTypoScript\Configuration\TypoScriptProcessorOption;
+use a9f\Typo3Fractor\Set\Typo3LevelSetList;
+use Helmich\TypoScriptParser\Parser\Printer\PrettyPrinterConfiguration;
+
+return FractorConfiguration::configure()
+    ->withPaths([
+        __DIR__ . '/*',
+    ])
+    ->withSkip([
+        __DIR__ . '/.Build',
+    ])
+    ->withSets([
+        Typo3LevelSetList::UP_TO_TYPO3_13
+    ])
+    ->withOptions([
+        TypoScriptProcessorOption::INDENT_SIZE => 4,
+        TypoScriptProcessorOption::INDENT_CHARACTER => PrettyPrinterConfiguration::INDENTATION_STYLE_SPACES,
+        TypoScriptProcessorOption::ADD_CLOSING_GLOBAL => false,
+        TypoScriptProcessorOption::INCLUDE_EMPTY_LINE_BREAKS => true,
+        TypoScriptProcessorOption::INDENT_CONDITIONS => true,
+    ]);
diff --git a/php-cs-fixer.php b/php-cs-fixer.php
@@ -30,37 +30,47 @@
     ->setRiskyAllowed(true)
     ->setRules([
         '@DoctrineAnnotation' => true,
-        '@PER' => true,
-        '@PSR2' => true,
+        // @todo: Switch to @PER-CS2.0 once php-cs-fixer's todo list is done: https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues/7247
+        '@PER-CS1.0' => true,
+        'array_indentation' => true,
         'array_syntax' => ['syntax' => 'short'],
-        'blank_line_after_opening_tag' => true,
-        'braces' => ['allow_single_line_closure' => true],
+        'braces_position' => true,
         'cast_spaces' => ['space' => 'none'],
-        'compact_nullable_typehint' => true,
+        // @todo: Can be dropped once we enable @PER-CS2.0
+        'compact_nullable_type_declaration' => true,
         'concat_space' => ['spacing' => 'one'],
+        'control_structure_braces' => true,
+        'control_structure_continuation_position' => true,
         'declare_equal_normalize' => ['space' => 'none'],
+        'declare_parentheses' => true,
         'dir_constant' => true,
+        // @todo: Can be dropped once we enable @PER-CS2.0
+        'function_declaration' => [
+            'closure_fn_spacing' => 'none',
+        ],
         'function_to_constant' => ['functions' => ['get_called_class', 'get_class', 'get_class_this', 'php_sapi_name', 'phpversion', 'pi']],
-        'function_typehint_space' => true,
+        'type_declaration_spaces' => true,
+        'global_namespace_import' => ['import_classes' => false, 'import_constants' => false, 'import_functions' => false],
         'header_comment' => [
             'header' => $headerComment,
             'comment_type' => 'comment',
+            'location' => 'after_declare_strict',
             'separate' => 'both',
-            'location' => 'after_declare_strict'
         ],
-        'lowercase_cast' => true,
-        'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
+        'list_syntax' => ['syntax' => 'short'],
+        // @todo: Can be dropped once we enable @PER-CS2.0
+        'method_argument_space' => true,
         'modernize_strpos' => true,
         'modernize_types_casting' => true,
         'native_function_casing' => true,
-        'new_with_braces' => true,
+        'new_with_parentheses' => true,
         'no_alias_functions' => true,
         'no_blank_lines_after_phpdoc' => true,
         'no_empty_phpdoc' => true,
         'no_empty_statement' => true,
         'no_extra_blank_lines' => true,
-        'no_leading_import_slash' => true,
         'no_leading_namespace_whitespace' => true,
+        'no_multiple_statements_per_line' => true,
         'no_null_property_initialization' => true,
         'no_short_bool_cast' => true,
         'no_singleline_whitespace_before_semicolons' => true,
@@ -70,8 +80,7 @@
         'no_unused_imports' => true,
         'no_useless_else' => true,
         'no_useless_nullsafe_operator' => true,
-        'no_whitespace_in_blank_line' => true,
-        'ordered_imports' => true,
+        'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
         'php_unit_construct' => ['assertions' => ['assertEquals', 'assertSame', 'assertNotEquals', 'assertNotSame']],
         'php_unit_mock_short_will_return' => true,
         'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
@@ -84,8 +93,11 @@
         'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],
         'return_type_declaration' => ['space_before' => 'none'],
         'single_quote' => true,
+        'single_space_around_construct' => true,
         'single_line_comment_style' => ['comment_types' => ['hash']],
-        'single_trait_insert_per_statement' => true,
+        // @todo: Can be dropped once we enable @PER-CS2.0
+        'single_line_empty_body' => true,
+        'statement_indentation' => true,
         'trailing_comma_in_multiline' => ['elements' => ['arrays']],
         'whitespace_after_comma_in_array' => ['ensure_single_space' => true],
         'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,8 @@
+includes:
+  - .Build/vendor/saschaegerer/phpstan-typo3/extension.neon
+
+parameters:
+  level: 9
+
+  paths:
+    - %currentWorkingDirectory%/Classes
diff --git a/rector.php b/rector.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector;
+use Ssch\TYPO3Rector\Set\Typo3LevelSetList;
+use Ssch\TYPO3Rector\Set\Typo3SetList;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/*',
+    ])
+    ->withSkipPath(
+        __DIR__ . '/.Build',
+    )
+    ->withPhpSets(php83: true)
+    ->withRules([
+        TypedPropertyFromStrictConstructorRector::class
+    ])
+    ->withSets([
+        Typo3SetList::CODE_QUALITY,
+        Typo3SetList::GENERAL,
+        Typo3LevelSetList::UP_TO_TYPO3_13,
+    ])
+    // here we can define, what prepared sets of rules will be applied
+    ->withPreparedSets(
+        deadCode: true,
+        codeQuality: true
+    )
+    ->withTypeCoverageLevel(8);
