[FEATURE] Allow to specify headline anchor explicitly (#32)

Author: s2b

config/typo3/01_viewhelpers_global.json

@@ -16,5 +16,8 @@
             "sourcePrefix": "https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/",
             "editPrefix": "https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/"
         }
+    },
+    "headlineIdentifierPrefix": {
+        "http://typo3.org/ns/TYPO3/CMS/Fluid/ViewHelpers": "typo3-fluid"
     }
 }

config/typo3/02_viewhelpers_core.json

@@ -8,5 +8,8 @@
             "sourcePrefix": "https://github.com/TYPO3/typo3/blob/main/typo3/sysext/core/Classes/ViewHelpers/",
             "editPrefix": "https://github.com/TYPO3/typo3/edit/main/typo3/sysext/core/Classes/ViewHelpers/"
         }
+    },
+    "headlineIdentifierPrefix": {
+        "http://typo3.org/ns/TYPO3/CMS/Core/ViewHelpers": "typo3-core"
     }
 }

config/typo3/03_viewhelpers_backend.json

@@ -8,5 +8,8 @@
             "sourcePrefix": "https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/",
             "editPrefix": "https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/"
         }
+    },
+    "headlineIdentifierPrefix": {
+        "http://typo3.org/ns/TYPO3/CMS/Backend/ViewHelpers": "typo3-backend"
     }
 }

config/typo3/04_viewhelpers_form.json

@@ -8,5 +8,8 @@
             "sourcePrefix": "https://github.com/TYPO3/typo3/blob/main/typo3/sysext/form/Classes/ViewHelpers/",
             "editPrefix": "https://github.com/TYPO3/typo3/edit/main/typo3/sysext/form/Classes/ViewHelpers/"
         }
+    },
+    "headlineIdentifierPrefix": {
+        "http://typo3.org/ns/TYPO3/CMS/Form/ViewHelpers": "typo3-form"
     }
 }

src/Config.schema.json

@@ -51,6 +51,13 @@
                     "editPrefix": { "type": "string" }
                 }
             }
+        },
+        "headlineIdentifierPrefix": {
+            "description": "Per-namespace configuration of prefixes for headline anchor names in the rendered documentation",
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
         }
     },
     "required": [

src/ConsoleRunner.php

@@ -184,7 +184,9 @@ private function renderViewHelperDocumentation(ViewHelperPackage $package, ViewH
     {
         $sourceEdit = $package->sourceEdit[$viewHelper->metadata->xmlNamespace] ?? null;
 
-        $headlineIdentifier = str_replace(['.', "'", '/', '\\'], '-', strtolower(sprintf('%s-%s', $viewHelper->namespaceWithoutSuffix, $viewHelper->nameWithoutSuffix)));
+        $headlineIdentifierPrefix = $package->headlineIdentifierPrefix[$viewHelper->metadata->xmlNamespace]
+            ?? str_replace(['.', "'", '/', '\\'], '-', strtolower($viewHelper->namespaceWithoutSuffix));
+        $headlineIdentifier = sprintf('%s-%s', $headlineIdentifierPrefix, str_replace(['.', "'", '/', '\\'], '-', strtolower($viewHelper->nameWithoutSuffix)));
 
         $view = $this->createView($templateFile);
         $view->assignMultiple([
@@ -298,6 +300,7 @@ private function createPackageFromConfigFile(string $filePath): ViewHelperPackag
                 ...array_map(fn($path) => $this->preparePath($path, $configPath), (array)($config->templates ?? [])),
             ],
             sourceEdit: isset($config->sourceEdit) ? (array)$config->sourceEdit : null,
+            headlineIdentifierPrefix: isset($config->headlineIdentifierPrefix) ? (array)$config->headlineIdentifierPrefix : null,
         );
     }
 

src/ViewHelperPackage.php

@@ -25,6 +25,7 @@ final class ViewHelperPackage
      * @param string[] $includesNamespaces
      * @param array<string, string> $templates
      * @param array<string, object> $sourceEdit
+     * @param array<string, string> $headlineIdentifierPrefix
      */
     public function __construct(
         public readonly string $name,
@@ -34,5 +35,6 @@ public function __construct(
         public readonly array $includesNamespaces,
         public readonly array $templates,
         public readonly ?array $sourceEdit,
+        public readonly ?array $headlineIdentifierPrefix,
     ) {}
 }

tests/Fixtures/SerializePackageResult.json

@@ -41,5 +41,8 @@
             "editPrefix": "http://example.com/edit/",
             "sourcePrefix": "http://example.com/source/"
         }
+    },
+    "headlineIdentifierPrefix": {
+        "http://typo3.org/ns/Vendor/MyPackage/ViewHelpers/": "vendor-mypackage"
     }
 }

tests/Functional/SerializePackageTest.php

@@ -58,6 +58,9 @@ public function serializePackage(): void
                     'sourcePrefix' => 'http://example.com/source/',
                 ],
             ],
+            [
+                'http://typo3.org/ns/Vendor/MyPackage/ViewHelpers/' => 'vendor-mypackage',
+            ],
         );
         $package->uri = 'Global/Index';
         $package->viewHelpers = [$viewHelper];