TASK: Add linting and testing to ci ... no tets yet

Author: mficzel

.github/workflows/build.yml

@@ -0,0 +1,43 @@
+name: build
+
+on:
+  push:
+      branches:
+        - 'main'
+  pull_request:
+      branches:
+        - 'main'
+
+jobs:
+    test:
+        name: "Test (PHP ${{ matrix.php-versions }}, Neos ${{ matrix.flow-versions }})"
+
+        strategy:
+            fail-fast: false
+            matrix:
+                php-versions: ["8.2", "8.3"]
+                neos-versions: ["8.3"]
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+              with:
+                  path: ${{ env.FLOW_FOLDER }}
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: ${{ matrix.php-versions }}
+                  extensions: mbstring, xml, json, zlib, iconv, intl, pdo_sqlite
+                  ini-values: date.timezone="Africa/Tunis", opcache.fast_shutdown=0, apc.enable_cli=on
+
+            - name: Set Neos Version
+              run: composer require neos/neos ^${{ matrix.neos-versions }} --no-progress --no-interaction
+
+            - name: Run Linter
+              run: composer lint
+
+            - name: Run Test
+              run: composer test

.gitignore

@@ -0,0 +1,3 @@
+.idea
+Packages
+vendor

Classes/Command/NodetypeObjectsCommandController.php

@@ -1,11 +1,13 @@
 <?php
+
 declare(strict_types=1);
 
 namespace PackageFactory\NodeTypeObjects\Command;
 
 use Neos\ContentRepository\Domain\Model\NodeType;
 use Neos\ContentRepository\Domain\Service\NodeTypeManager;
 use Neos\Flow\Cli\CommandController;
+use Neos\Flow\Core\Bootstrap;
 use Neos\Flow\Package\FlowPackageInterface;
 use Neos\Flow\Package\PackageManager;
 use Neos\Utility\Files;
@@ -18,7 +20,7 @@ class NodetypeObjectsCommandController extends CommandController
 
     public function injectNodeTypeManager(NodeTypeManager $nodeTypeManager): void
     {
-       $this->nodeTypeManager = $nodeTypeManager;
+        $this->nodeTypeManager = $nodeTypeManager;
     }
 
     public function injectPackageManager(PackageManager $packageManager): void
@@ -32,9 +34,9 @@ public function injectPackageManager(PackageManager $packageManager): void
      * @param string $packageKey PackageKey to store the classes in
      * @return void
      */
-    public function cleanCommand(string $packageKey):void
+    public function cleanCommand(string $packageKey): void
     {
-        if($this->packageManager->isPackageAvailable($packageKey)) {
+        if ($this->packageManager->isPackageAvailable($packageKey)) {
             $package = $this->packageManager->getPackage($packageKey);
         } else {
             $this->output->outputLine("Unknown package " . $packageKey);
@@ -62,9 +64,9 @@ public function cleanCommand(string $packageKey):void
      *
      * @param string $packageKey PackageKey
      */
-    public function buildCommand(string $packageKey):void
+    public function buildCommand(string $packageKey): void
     {
-        if($this->packageManager->isPackageAvailable($packageKey)) {
+        if ($this->packageManager->isPackageAvailable($packageKey)) {
             $package = $this->packageManager->getPackage($packageKey);
         } else {
             $this->output->outputLine("Unknown package " . $packageKey);
@@ -81,7 +83,7 @@ public function buildCommand(string $packageKey):void
             if (!str_starts_with($nodeType->getName(), $packageKey . ':')) {
                 continue;
             }
-            $localNameParts = explode('.', str_replace( $packageKey . ':','', $nodeType->getName()));
+            $localNameParts = explode('.', str_replace($packageKey . ':', '', $nodeType->getName()));
             $localName = array_pop($localNameParts);
             $localNamespace = implode('.', $localNameParts);
 
@@ -91,10 +93,10 @@ public function buildCommand(string $packageKey):void
                 . '/' . $localName;
             $fileName = $localName . 'NodeObject.php';
 
-            $classNamespace = str_replace('.', '\\' , $packageKey)
+            $classNamespace = str_replace('.', '\\', $packageKey)
                 . '\\NodeTypes'
-                . '\\' . str_replace('.', '\\' , $localNamespace)
-                . '\\' . str_replace('.', '\\' , $localName);
+                . '\\' . str_replace('.', '\\', $localNamespace)
+                . '\\' . str_replace('.', '\\', $localName);
 
             $className =  $localName . 'NodeObject';
 
@@ -111,7 +113,7 @@ public function buildCommand(string $packageKey):void
         }
     }
 
-    private function buildOne(FlowPackageInterface $package, NodeType $nodeType, string $classNamespace, string $className, string $filePath, string $fileName):void
+    private function buildOne(FlowPackageInterface $package, NodeType $nodeType, string $classNamespace, string $className, string $filePath, string $fileName): void
     {
 
         $propertyAccesssors = '';
@@ -130,7 +132,7 @@ private function buildOne(FlowPackageInterface $package, NodeType $nodeType, str
                 $annotationType = $type;
                 $phpType = 'array';
             } elseif (str_starts_with($type, 'array<') && str_ends_with($type, '>')) {
-                $annotationType = substr($type , 6 ,-1) . '[]';
+                $annotationType = substr($type, 6, -1) . '[]';
                 $phpType = 'array';
             } elseif ($type  === 'boolean') {
                 $phpType = 'bool';

composer.json

@@ -12,9 +12,44 @@
             "PackageFactory\\NodeTypeObjects\\": "Classes/"
         }
     },
+    "require-dev": {
+        "phpunit/phpunit": "^10.0",
+        "phpstan/phpstan": "^1.10",
+        "squizlabs/php_codesniffer": "^3.7"
+    },
+    "scripts": {
+        "fix:code-style": [
+            "phpcbf --extensions=php --colors --standard=PSR12 ./Classes",
+            "phpcbf --extensions=php --colors --standard=PSR12 ./Tests"
+        ],
+        "fix": [
+            "@install",
+            "@fix:code-style"
+        ],
+        "lint:code-style": [
+            "phpcs --extensions=php --colors --standard=PSR12 --exclude=Generic.Files.LineLength ./Classes",
+            "phpcs --extensions=php --colors --standard=PSR12 --exclude=Generic.Files.LineLength ./Tests"
+        ],
+        "lint:static-analysis": "phpstan analyse",
+        "lint": [
+            "@install",
+            "@lint:code-style",
+            "@lint:static-analysis"
+        ],
+        "test:unit": "vendor/bin/phpunit Tests/Unit",
+        "test": [
+            "@install",
+            "@test:unit"
+        ]
+    },
     "extra": {
         "neos": {
             "package-key": "PackageFactory.NodeTypeObjects"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "neos/composer-plugin": true
+        }
     }
 }