!!! TASK: Document and add types to dls interface

neos · Mar 11, 2024 · 50bda4e · 50bda4e
1 parent fe98c8c
commit 50bda4e
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 4 deletions.
diff --git a/Neos.Fusion.Afx/Classes/Dsl/AfxDslImplementation.php b/Neos.Fusion.Afx/Classes/Dsl/AfxDslImplementation.php
@@ -32,7 +32,7 @@ class AfxDslImplementation implements DslInterface
      * @return string
      * @throws Fusion\Exception
      */
-    public function transpile($code)
+    public function transpile(string $code): string
     {
         try {
             return AfxService::convertAfxToFusion($code);

diff --git a/Neos.Fusion/Classes/Core/DslInterface.php b/Neos.Fusion/Classes/Core/DslInterface.php
@@ -16,6 +16,26 @@
 /**
  * Contract for a Fusion DSL parser
  *
+ * A dsl can be registered like:
+ *
+ *     Neos:
+ *       Fusion:
+ *         dsl:
+ *           afx: Neos\Fusion\Afx\Dsl\AfxDslImplementation
+ *
+ * And will be available via its identifier in Fusion:
+ *
+ *     root = afx`
+ *         <div>Hello World</div>
+ *     `
+ * The returned string must be a valid fusion string,
+ * which is parsed again:
+ *
+ *     Neos.Fusion:Tag {
+ *         tagName = 'div'
+ *         content = 'Hello World'
+ *     }
+ *
  * @api
  */
 interface DslInterface
@@ -27,5 +47,5 @@ interface DslInterface
      * @return string
      * @throws Fusion\Exception
      */
-    public function transpile($code);
+    public function transpile(string $code): string;
 }
diff --git a/...sion/Tests/Functional/Parser/Fixtures/Dsl/FusionObjectExpressionTestDslImplementation.php b/...sion/Tests/Functional/Parser/Fixtures/Dsl/FusionObjectExpressionTestDslImplementation.php
@@ -15,7 +15,7 @@
 
 class FusionObjectExpressionTestDslImplementation implements DslInterface
 {
-    public function transpile($code)
+    public function transpile(string $code): string
     {
         $config = json_decode($code, true);
 

diff --git a/Neos.Fusion/Tests/Functional/Parser/Fixtures/Dsl/PassthroughTestDslImplementation.php b/Neos.Fusion/Tests/Functional/Parser/Fixtures/Dsl/PassthroughTestDslImplementation.php
@@ -15,7 +15,7 @@
 
 class PassthroughTestDslImplementation implements DslInterface
 {
-    public function transpile($code)
+    public function transpile(string $code): string
     {
         return $code;
     }