[TASK] Use "Line Break Opportunity" tags in confvals (#726)

Resolves #719

Author: linawolf

Documentation-rendertest/Confval/ConfvalTrees.rst

@@ -84,7 +84,7 @@ Long default values
     ..  confval:: pages
         :name: typoscript-pages
         :type: string
-        :default: {$styles.content.loginform.pid}
+        :default: `{$styles.content.loginform.pid}`
         :test: `1`
 
         Define the User Storage Page with the Website User Records, using a
@@ -93,7 +93,7 @@ Long default values
     ..  confval:: redirectPageLoginError
         :name: typoscript-redirectPageLoginError
         :type: integer
-        :default: {$styles.content.loginform.redirectPageLoginError}
+        :default: `{$styles.content.loginform.redirectPageLoginError}`
 
         Page id to redirect to after Login Error
 
@@ -108,7 +108,7 @@ Long default values
         ..  confval:: email.templateRootPaths
             :name: typoscript-email.templateRootPaths
             :type: array
-            :default: {$styles.content.loginform.email.templateRootPaths}
+            :default: `{$styles.content.loginform.email.templateRootPaths}`
 
             Path to template directory used for emails
 

Documentation-rendertest/PhpDomain/Index.rst

@@ -469,32 +469,32 @@ Return Types
     ..  php:method:: returnClassFromSameNamespace()
 
         :returns: An object instance of a class from the same namespace.
-        :returntype: OtherLibrary\\ReturnedClass
+        :returntype: `OtherLibrary\\ReturnedClass`
 
     ..  php:method:: returnClassFromOtherNamespace()
 
         :returns: An object instance of a class from another namespace.
-        :returntype: LibraryName\\SubPackage\\SubpackageInterface
+        :returntype: `LibraryName\\SubPackage\\SubpackageInterface`
 
     ..  php:method:: returnClassConstant()
 
         :returns: The value of a specific class constant.
-        :returntype: LibraryName\\NamespaceClass::NAMESPACE_CONST
+        :returntype: `LibraryName\\NamespaceClass::NAMESPACE_CONST`
 
     ..  php:method:: returnGlobalConstant()
 
         :returns: The value of a specific global constant.
-        :returntype: SOME_CONSTANT
+        :returntype: `SOME_CONSTANT`
 
     ..  php:method:: returnExceptionInstance()
 
         :returns: An instance of an exception.
-        :returntype: InvalidArgumentException
+        :returntype: `InvalidArgumentException`
 
     ..  php:method:: returnScalarType()
 
         :returns: A scalar string type.
-        :returntype: string
+        :returntype: `string`
 
     ..  php:method:: returnUnionType()
 
@@ -533,6 +533,6 @@ Instance of this interface is returned by.
     :param integer $end: End angle.
     :param Imagine\Image\Color $color: Line color.
 
-    :throws: Imagine\Exception\RuntimeException
+    :throws: `Imagine\Exception\RuntimeException`
 
-    :returns: Imagine\Draw\DrawerInterface
+    :returns: `Imagine\Draw\DrawerInterface`

composer.lock

@@ -8,7 +8,7 @@
             {% endif %}
         {% endfor %}
         <div class="label">
-            <a href="#{{ entry.anchor }}">{{ entry.plainContent }}</a>
+            <a href="#{{ entry.anchor }}">{{ replaceLineBreakOpportunityTags(entry.plainContent) }}</a>
             {% for fieldName, field in node.fields %}
                 {% if fieldName=='type' %}
                     , Type: {{ renderNode(entry.type) }}
@@ -60,7 +60,7 @@
                 </div>
             {% endif %}
             <div class="label">
-                <a href="#{{ entry.anchor }}">{{ entry.plainContent }}</a>
+                <a href="#{{ entry.anchor }}">{{ replaceLineBreakOpportunityTags(entry.plainContent) }}</a>
                 {% for fieldName, field in node.fields %}
                     {% if fieldName=='type' %}
                         , Type: {{ renderNode(entry.type) }}
@@ -89,7 +89,7 @@
 
 {% macro renderConfvalRow(entry, node, level) %}
     <tr>
-        <td><div class="confval-label ps-{{ level * 2 }}"><a href="#{{ entry.anchor }}">{{ entry.plainContent }}</a></div></td>
+        <td><div class="confval-label ps-{{ level * 2 }}"><a href="#{{ entry.anchor }}">{{ replaceLineBreakOpportunityTags(entry.plainContent) }}</a></div></td>
         {% for fieldName, field in node.fields %}
             <td>
             {% if fieldName=='type' %}

packages/typo3-docs-theme/resources/template/body/directive/confval-menu.html.twig

@@ -1,7 +1,7 @@
 <dl class="confval">
     <dt{% if not node.noindex %} id="{{ node.anchor }}"{% endif %} class="d-flex justify-content-between">
         <div class="confval-header">
-        <code class="sig-name descname"><span class="pre">{{ node.plainContent }}</span></code>
+        <code class="sig-name descname"><span class="pre">{{ replaceLineBreakOpportunityTags(node.plainContent) }}</span></code>
         {% if not node.noindex %}
         <a class="headerlink" href="#{{ node.anchor }}" data-bs-toggle="modal" data-bs-target="#linkReferenceModal" data-id="{{ node.anchor }}" data-rstCode="{{ getRstCodeForLink(node) }}"  title="Reference this configuration value">¶</a>
         {% else %}

packages/typo3-docs-theme/resources/template/body/directive/confval.html.twig

@@ -0,0 +1 @@
+<span class="sig-name descname"><span class="pre">{{ replaceLineBreakOpportunityTags(node.name) }}</span></span>

packages/typo3-docs-theme/resources/template/body/directive/php/memberName.html.twig

@@ -0,0 +1 @@
+<span class="pre">{{ replaceLineBreakOpportunityTags(code) }}</span>

packages/typo3-docs-theme/resources/template/body/directive/php/partials/codeStyle.html.twig

@@ -6,9 +6,9 @@
           data-bs-html="true">
         {%- if node.info.url %}
             <a href="{{ node.info['url'] }}" target="_blank">
-                {{- node.value }} <span class="text-secondary"><i class="fa-regular fa-circle-question"></i></span></a>
+                {{- replaceLineBreakOpportunityTags(node.value) }} <span class="text-secondary"><i class="fa-regular fa-circle-question"></i></span></a>
         {%- else -%}
-            {{ node.value }}
+            {{ replaceLineBreakOpportunityTags(node.value) }}
         {%- endif -%}
     </code>
 {% endapply %}

packages/typo3-docs-theme/resources/template/inline/textroles/code.html.twig

@@ -1,3 +1,3 @@
 {% apply spaceless %}
-    <code class="code-inline file" translate="no" title="File path">{{ node.value }}</code>
+    <code class="code-inline file" translate="no" title="File path">{{ replaceLineBreakOpportunityTags(node.value) }}</code>
 {% endapply %}

packages/typo3-docs-theme/resources/template/inline/textroles/file.html.twig

@@ -1,3 +1,3 @@
 {% apply spaceless %}
-    <code class="code-inline path" translate="no" title="Path">{{ node.value }}</code>
+    <code class="code-inline path" translate="no" title="Path">{{ replaceLineBreakOpportunityTags(node.value) }}</code>
 {% endapply %}

packages/typo3-docs-theme/resources/template/inline/textroles/path.html.twig

@@ -1,3 +1,3 @@
 {% apply spaceless %}
-    <code class="code-inline">{{ node.value }}</code>
+    <code class="code-inline">{{ replaceLineBreakOpportunityTags(node.value) }}</code>
 {% endapply %}

packages/typo3-docs-theme/resources/template/inline/textroles/unknown.html.twig

@@ -20,6 +20,6 @@ public function extractInterlink(string $fullReference): InterlinkData
             return new InterlinkData($fullReference, '');
         }
 
-        return new InterlinkData($matches[2], $matches[1] ?? '');
+        return new InterlinkData($matches[2], $matches[1]);
     }
 }

packages/typo3-docs-theme/src/Parser/ExtendedInterlinkParser.php

@@ -64,17 +64,20 @@ protected function createNode(DocumentParserContext $documentParserContext, stri
     private function extractEmbeddedUri(string $text): array
     {
         preg_match(self::TEXTROLE_LINK_REGEX, $text, $matches);
+        $description = null;
+        $uri = $text;
+        if (isset($matches[1]) && is_string($matches[1])) {
+            $description = $matches[1] === '' ? null : $matches[1];
+            $uri = $matches[1];
+        }
 
-        $text = $matches[1] === '' ? null : $matches[1];
-        $uri = $matches[1];
-
-        if (isset($matches[2])) {
+        if (isset($matches[2]) && is_string($matches[2])) {
             // there is an embedded URI, text and URI are different
             $uri = $matches[2];
         } else {
-            $text = null;
+            $description = null;
         }
 
-        return ['text' => $text, 'uri' => $uri];
+        return ['text' => $description, 'uri' => $uri];
     }
 }

packages/typo3-docs-theme/src/TextRoles/CustomLinkTextRole.php

@@ -34,6 +34,21 @@
 
 final class TwigExtension extends AbstractExtension
 {
+    /**
+     * @see https://regex101.com/r/qWKenb/1
+     */
+    public const CAMEL_CASE_BREAK_REGEX = '/([a-z])([A-Z])/';
+
+    /**
+     * @see https://regex101.com/r/nxExYM/2
+     */
+    public const NON_LETTER_BREAK_REGEX = '/(?<!^)([.\_\-\\\\\/:])([a-zA-Z0-9])/';
+
+    /**
+     * @see https://regex101.com/r/uIul8d/1
+     */
+    public const BRACKETS_BREAK_REGEX = '/(?<!^)([\[\(\{\<\|])/';
+
     private string $typo3AzureEdgeURI = '';
 
     public function __construct(
@@ -75,8 +90,19 @@ public function getFunctions(): array
             new TwigFunction('getStandardInventories', $this->getStandardInventories(...), ['is_safe' => ['html'], 'needs_context' => true]),
             new TwigFunction('getRstCodeForLink', $this->getRstCodeForLink(...), ['is_safe' => [], 'needs_context' => true]),
             new TwigFunction('isRenderedForDeployment', $this->isRenderedForDeployment(...)),
+            new TwigFunction('replaceLineBreakOpportunityTags', $this->replaceLineBreakOpportunityTags(...), ['is_safe' => ['html'], 'needs_context' => false]),
         ];
     }
+    public function replaceLineBreakOpportunityTags(string $value): string
+    {
+        // as the result is html safe
+        $brokenValue = htmlspecialchars($value);
+        $brokenValue  = preg_replace(self::BRACKETS_BREAK_REGEX, '<wbr>$1', $brokenValue);
+        $brokenValue  = preg_replace(self::CAMEL_CASE_BREAK_REGEX, '$1<wbr>$2', $brokenValue ?? $value);
+        $brokenValue  = preg_replace(self::NON_LETTER_BREAK_REGEX, '$1<wbr>$2', $brokenValue ?? $value);
+        $brokenValue  = preg_replace(self::NON_LETTER_BREAK_REGEX, '$1<wbr>$2', $brokenValue ?? $value);
+        return $brokenValue ?? $value;
+    }
 
     public function renderPlainText(mixed $value): string
     {