Modernize TYPO3 Extension Metadata Handling (#214)

* Exclude var directory via .gitignore

* Git ignore full var directory, not only contained files

* Remove bin directory from .gitignore

* Remove vendor directory from .gitignore on root

* Remove index.php from .gitignore on root

* Remove typo3/install.php from .gitignore on root

* [TASK] Adjust directory path resolution in PHP-CS-Fixer config

Ensure consistent path resolution by updating the `in()` definition in `.php-cs-fixer.dist.php`.

* [TASK] Extend excluded directories in PHP-CS-Fixer config

Add additional directories to the exclude list for clearer code analysis boundaries.

* [TASK] Add strict type declarations to functional test fixtures

Include `declare(strict_types=1);` in all relevant PHP files within the functional test fixtures to enforce strict typing and improve code reliability.

* [TASK] Remove strict type declarations from functional test fixtures

Omit `declare(strict_types=1);` in functional test fixture PHP files to simplify the test setup and align with the intended purpose of fixtures as non-strictly typed code.

* [TASK] Filter null and empty values in site setting arrays

Ensure settings arrays exclude null or empty values during conversion to arrays, enhancing data cleanliness and consistency.

* [TASK] Skip SafeDeclareStrictTypesRector for specific fixture files

Update Rector configuration to exclude fixture files and `ext_emconf.php` from `SafeDeclareStrictTypesRector`, ensuring flexible handling of strict types for test-related and configuration files.

* [TASK] Remove ext_emconf.php handling from Extension Creator

Remove generation and usage of `ext_emconf.php` files from the Extension Creator and functional test fixtures, reflecting their deprecation and ensuring alignment with modern TYPO3 standards.

* [TASK] Enhance composer.json structure in test fixtures

Extend the `composer.json` structure within functional test fixtures to include `Package` metadata and `version` information, ensuring better compatibility with TYPO3 standards.

* [TASK] Remove ext_emconf.php and enhance composer.json structure

Remove the deprecated `ext_emconf.php` file and migrate metadata to `composer.json`, including `Package` metadata and `version`, aligning with modern TYPO3 standards.

* [TASK] Remove ext_emconf.php from Rector paths

Exclude `ext_emconf.php` from Rector's analyzed paths to align with its deprecation and removal in favor of `composer.json`.

Author: froemken

.gitignore

@@ -54,10 +54,7 @@ nbproject
 .tscache
 #
 # Ignore composer stuff
-/bin/*
-/vendor/*
-/index.php
-/typo3/install.php
+/var
 #
 # Ignore common TYPO3 CMS files/directories
 /typo3temp/*

Build/cgl/.php-cs-fixer.dist.php

@@ -22,9 +22,14 @@
     ->setFinder(
         (new PhpCsFixer\Finder())
             ->ignoreVCSIgnored(true)
-            ->in(__DIR__.'/../'.'../')
-            ->exclude('.Build')
-            ->exclude('Fixtures')
+            ->in(__DIR__ . '/../../')
+            ->exclude([
+                '.Build',
+                '.github',
+                'Build',
+                'var',
+                'Tests/Functional/Integration/Fixtures',
+            ])
     )
     ->setRiskyAllowed(true)
     ->setRules([

Build/rector/rector.php

@@ -13,6 +13,7 @@
 use Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector;
 use Rector\Config\RectorConfig;
 use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector;
+use Rector\TypeDeclaration\Rector\StmtsAwareInterface\SafeDeclareStrictTypesRector;
 use Rector\ValueObject\PhpVersion;
 use Ssch\TYPO3Rector\CodeQuality\General\ExtEmConfRector;
 use Ssch\TYPO3Rector\Configuration\Typo3Option;
@@ -24,7 +25,6 @@
         __DIR__ . '/../../Classes',
         __DIR__ . '/../../Configuration',
         __DIR__ . '/../../Tests',
-        __DIR__ . '/../../ext_emconf.php',
     ])
     ->withPreparedSets(
         deadCode: true,
@@ -53,8 +53,14 @@
     ->withImportNames(importShortClasses: false, removeUnusedImports: true)
     ->withSkip([
         NullToStrictStringFuncCallArgRector::class,
+        SafeDeclareStrictTypesRector::class => [
+            '*ext_emconf.php',
+            '*/Tests/Functional/Integration/Fixtures/*/Configuration/TCA/*.php',
+            '*/Tests/Functional/Integration/Fixtures/*/Configuration/TCA/Overrides/*.php',
+            '*/Tests/Functional/Integration/Fixtures/*/Configuration/Backend/*.php',
+        ],
         FlipTypeControlToUseExclusiveTypeRector::class => [
-            __DIR__ . '/../../Classes/PhpParser/Printer/PrettyTypo3Printer.php',
+            '*/Classes/PhpParser/Printer/PrettyTypo3Printer.php',
         ],
         '*Build/*',
         '*Resources/*',

Classes/Creator/Extension/ComposerJsonCreator.php

@@ -59,7 +59,11 @@ private function getFileContent(ExtensionInformation $extensionInformation): str
             ],
             'extra' => [
                 'typo3/cms' => [
+                    'Package' => [
+                        'providesPackages' => (object)[],
+                    ],
                     'extension-key' => $extensionInformation->getExtensionKey(),
+                    'version' => $extensionInformation->getVersion(),
                 ],
             ],
         ];

Classes/Creator/Extension/ExtEmconfCreator.php

@@ -64,7 +64,7 @@ private function getFileContent(SiteSettingsDefinitionInformation $siteSettingsD
         }
         $this->types->getProvidedServices();
         foreach ($siteSettingsDefinitionInformation->getSettings() as $setting) {
-            $array = $setting->toArray();
+            $array = array_filter(get_object_vars($setting), fn(mixed $value): bool => $value !== null && $value !== []);
 
             unset($array['key']);
             if ($array['readonly'] === false) {

Classes/Creator/SiteSet/SiteSettingsDefinitionCreator.php

@@ -70,6 +70,12 @@ private function updateComposerJson(array $composerConfig): string
 
         ksort($composerConfig['config']['allow-plugins']);
 
+        if (isset($composerConfig['extra']['typo3/cms']['Package']['providesPackages'])
+            && $composerConfig['extra']['typo3/cms']['Package']['providesPackages'] === []
+        ) {
+            $composerConfig['extra']['typo3/cms']['Package']['providesPackages'] = (object)[];
+        }
+
         if (!isset($composerConfig['config']['bin-dir'])) {
             $composerConfig['config']['bin-dir'] = '.Build/bin';
         }

Classes/Creator/Test/Environment/ComposerJsonCreator.php

@@ -1,6 +1,6 @@
 # TYPO3 Extension Kickstarter
 
-`kickstarter` is a TYPO3 extension that simplifies and accelerates the creation of new TYPO3 extensions by automating file generation, controller setup, and plugin registration through easy-to-use CLI commands. With a few CLI commands, it generates essential files like `LICENSE`, `ext_emconf.php`,`composer.json`, and more. Whether starting from scratch or extending existing functionality, `kickstarter` helps streamline development.
+`kickstarter` is a TYPO3 extension that simplifies and accelerates the creation of new TYPO3 extensions by automating file generation, controller setup, and plugin registration through easy-to-use CLI commands. With a few CLI commands, it generates essential files like `LICENSE`, `composer.json`, and more. Whether starting from scratch or extending existing functionality, `kickstarter` helps streamline development.
 
 ---
 

README.md

@@ -98,7 +98,6 @@ public static function extensionCreationProvider(): array
                 'namespaceForAutoload' => 'Vendor\\MyExtension\\',
                 'expectedDir' => __DIR__ . '/Fixtures/expected_extension',
                 'expectedFiles' => [
-                    'ext_emconf.php',
                     'README.md',
                 ],
             ],
@@ -116,7 +115,6 @@ public static function extensionCreationProvider(): array
                 'namespaceForAutoload' => 'Vendor\\MyExtension\\',
                 'expectedDir' => __DIR__ . '/Fixtures/extension_with_folders',
                 'expectedFiles' => [
-                    'ext_emconf.php',
                     'README.md',
                 ],
                 'createFolders' => true,

Tests/Functional/Integration/ExtensionCreatorServiceTest.php

@@ -26,7 +26,11 @@
     },
     "extra": {
         "typo3/cms": {
-            "extension-key": "my_extension"
+            "Package": {
+                "providesPackages": {}
+            },
+            "extension-key": "my_extension",
+            "version": "1.0.0"
         }
     }
 }