TASK: Add readme and make generated classes are final and psr12 compliant

Author: mficzel

Classes/Command/NodetypeObjectsCommandController.php

@@ -27,20 +27,51 @@ public function injectPackageManager(PackageManager $packageManager): void
     }
 
     /**
-     * @param string $nodeTypeName Pattern for nodeTypeNames to generate classes for
+     * Remove all NodeTypeObjects from the selected package
+     *
      * @param string $packageKey PackageKey to store the classes in
      * @return void
      */
+    public function cleanCommand(string $packageKey):void
+    {
+        if($this->packageManager->isPackageAvailable($packageKey)) {
+            $package = $this->packageManager->getPackage($packageKey);
+        } else {
+            $this->output->outputLine("Unknown package " . $packageKey);
+            $this->quit(1);
+        }
+        if (!$package instanceof FlowPackageInterface) {
+            $this->output->outputLine($packageKey . " is not a Flow package");
+            $this->quit(1);
+        }
+
+        $packagePath = $package->getPackagePath();
+        $files = Files::readDirectoryRecursively($packagePath, 'NodeObject.php');
+        if (is_array($files)) {
+            foreach ($files as $file) {
+                if (is_file($file)) {
+                    unlink($file);
+                }
+                $this->outputLine(' - ' . $file);
+            }
+        }
+    }
+
+    /**
+     * Create new NodeTypeObjects for the selected Package
+     *
+     * @param string $packageKey PackageKey
+     */
     public function buildCommand(string $packageKey):void
     {
         if($this->packageManager->isPackageAvailable($packageKey)) {
             $package = $this->packageManager->getPackage($packageKey);
         } else {
-            $this->output->outputLine("Unknwn package " . $packageKey);
+            $this->output->outputLine("Unknown package " . $packageKey);
             $this->quit(1);
         }
         if (!$package instanceof FlowPackageInterface) {
-            $this->output->outputLine($packageKey . " is not a flow package");
+            $this->output->outputLine($packageKey . " is not a Flow package");
             $this->quit(1);
         }
 
@@ -75,6 +106,8 @@ public function buildCommand(string $packageKey):void
                 $filePath,
                 $fileName,
             );
+
+            $this->outputLine(' - ' . $filePath . '/' . $fileName);
         }
     }
 
@@ -122,7 +155,7 @@ private function buildOne(FlowPackageInterface $package, NodeType $nodeType, str
                 /**
                  * @return $annotationType;
                  */
-                public function $methodName (): ?$phpType
+                public function $methodName(): ?$phpType
                 {
                     return \$this->node->getProperty('$propertyName');
                 }
@@ -133,6 +166,7 @@ public function $methodName (): ?$phpType
 
         $class = <<<EOL
         <?php
+
         declare(strict_types=1);
 
         namespace $classNamespace;
@@ -141,24 +175,27 @@ public function $methodName (): ?$phpType
         use Neos\Flow\Annotations as Flow;
 
         /**
-         * AUTOGENERATED DO NOT MODIFY
+         * AUTOGENERATED CODE ... DO NOT MODIFY !!!
+         *
          * run `./ nodetypeobjects:build` to regenerate this
          */
         #[Flow\Proxy(false)]
-        readonly class $className {
+        final readonly class $className
+        {
             private function __construct(
                 public NodeInterface \$node
-            ) {}
+            ) {
+            }
 
             public static function fromNode(NodeInterface \$node): self
             {
                 if (\$node->getNodeType()->getName() !== "$nodeTypeName") {
                     throw new \Exception("unsupported nodetype " . \$node->getNodeType()->getName());
                 }
                 return new self(\$node);
-            }
-            $propertyAccesssors
+            }$propertyAccesssors
         }
+
         EOL;
 
         Files::createDirectoryRecursively($filePath);
@@ -167,7 +204,5 @@ public static function fromNode(NodeInterface \$node): self
             $filePath . '/' . $fileName,
             $class
         );
-
-        $this->outputLine('Generated class %s (%s) from type %s', [$classNamespace . '\\' . $className, $filePath . '/' . $fileName, $nodeType->getName()]);
     }
 }

README.md

@@ -0,0 +1,35 @@
+# PackageFactory.NodeTypeObjects
+
+!!! THIS IS EXPERIMENTAL ... EVERYTHING MAY CHANGE, USE AT YOUR OWN RISK !!!
+
+Autogenerate php classes for NodeTypes with type safe property accessor methods that allow full static analysis. 
+
+- NodeTypeObject are created for each non abatrsct NodeType in the namespace of the given package.
+- NodeTypeObjects are stored in the `NodeTypes` folder using all parts of the NodeTypeName as folders   
+- The namespace of each NodeTypeObject is derived from the packaghe-key with added ``NodeTypes`
+- The className of a NodeTypeObject is defined by the last part of the NodeTypeName with postfix `NodeTypeObject`
+
+## Precondtions
+
+The following preconditions have to be met for a package to use NodeTypeObjects.
+
+- The Package registers a PSR4 Namespace for NodeTypes in the.composer.json that points to the NodeTypes folder
+- The pattern `*NodeTypeObject.php` hast to be added to `.gitignore` to avoid committing the generated files.
+- The commands `nodetypeobjects:build` and `nodetypeobjects:clean` have to be integrated into build processes and watchers
+
+## Usage 
+
+The package defines the following cli commands
+
+- `./flow nodetypeobjects:build Vendor.Site` : regenerate all NodeTypeObject in the given package.
+- `./flow nodetypeobjects:clean Vendor.Site` : remove all NodeTypeObject in the given package. 
+
+## Installation
+
+PackageFactory.NodeTypeObjects is available via packagist. Just run `composer require packagefactory/nodetypeobjects`.
+
+We use semantic-versioning so every breaking change will increase the major-version number.
+
+## License
+
+see [LICENSE file](LICENSE)

composer.json

@@ -4,7 +4,8 @@
     "name": "packagefactory/nodetypeobjects",
     "license": "MIT",
     "require": {
-        "neos/neos": "~8.3"
+        "neos/neos": "~8.3",
+        "php": ">=8.2"
     },
     "autoload": {
         "psr-4": {