Merge pull request #806 from phpDocumentor/task/interlink

!![TASK] Improve interlink slug and warning handling

Author: jaapio

packages/guides-restructured-text/src/RestructuredText/Directives/ConfvalDirective.php

@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Nodes\ConfvalNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
@@ -30,7 +30,7 @@ final class ConfvalDirective extends SubDirective
     public function __construct(
         protected Rule $startingRule,
         GenericLinkProvider $genericLinkProvider,
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
         private readonly InlineParser $inlineParser,
     ) {
         parent::__construct($startingRule);

packages/guides-restructured-text/src/RestructuredText/Directives/OptionDirective.php

@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Nodes\OptionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
@@ -31,7 +31,7 @@ final class OptionDirective extends SubDirective
     public function __construct(
         protected Rule $startingRule,
         GenericLinkProvider $genericLinkProvider,
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
     ) {
         parent::__construct($startingRule);
 

packages/guides-restructured-text/src/RestructuredText/TextRoles/GenericReferenceTextRole.php

@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\ReferenceNode;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Parser\Interlink\InterlinkParser;
 
 use function array_keys;
@@ -15,7 +15,7 @@ class GenericReferenceTextRole extends AbstractReferenceTextRole
 {
     public function __construct(
         private readonly GenericLinkProvider $genericLinkProvider,
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
         private readonly InterlinkParser $interlinkParser,
     ) {
     }

packages/guides-theme-bootstrap/src/Bootstrap/Directives/TabsDirective.php

@@ -18,7 +18,7 @@
 use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\InlineCompoundNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Directives\SubDirective;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
@@ -35,7 +35,7 @@ class TabsDirective extends SubDirective
     public function __construct(
         protected Rule $startingRule,
         private readonly LoggerInterface $logger,
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
     ) {
         parent::__construct($startingRule);
     }

packages/guides/resources/config/guides.php

@@ -10,11 +10,6 @@
 use phpDocumentor\Guides\Compiler\NodeTransformers\CustomNodeTransformerFactory;
 use phpDocumentor\Guides\Compiler\NodeTransformers\MenuNodeTransformers\InternalMenuEntryNodeTransformer;
 use phpDocumentor\Guides\Compiler\NodeTransformers\NodeTransformerFactory;
-use phpDocumentor\Guides\Interlink\DefaultInventoryLoader;
-use phpDocumentor\Guides\Interlink\DefaultInventoryRepository;
-use phpDocumentor\Guides\Interlink\InventoryLoader;
-use phpDocumentor\Guides\Interlink\InventoryRepository;
-use phpDocumentor\Guides\Interlink\JsonLoader;
 use phpDocumentor\Guides\NodeRenderers\Html\BreadCrumbNodeRenderer;
 use phpDocumentor\Guides\NodeRenderers\Html\DocumentNodeRenderer;
 use phpDocumentor\Guides\NodeRenderers\Html\MenuEntryRenderer;
@@ -23,20 +18,25 @@
 use phpDocumentor\Guides\NodeRenderers\OutputAwareDelegatingNodeRenderer;
 use phpDocumentor\Guides\Parser;
 use phpDocumentor\Guides\ReferenceResolvers\AnchorHyperlinkResolver;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\ReferenceResolvers\AnchorReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\DelegatingReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\DocReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\DocumentNameResolver;
 use phpDocumentor\Guides\ReferenceResolvers\DocumentNameResolverInterface;
 use phpDocumentor\Guides\ReferenceResolvers\EmailReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\ExternalReferenceResolver;
+use phpDocumentor\Guides\ReferenceResolvers\Interlink\DefaultInventoryLoader;
+use phpDocumentor\Guides\ReferenceResolvers\Interlink\DefaultInventoryRepository;
+use phpDocumentor\Guides\ReferenceResolvers\Interlink\InventoryLoader;
+use phpDocumentor\Guides\ReferenceResolvers\Interlink\InventoryRepository;
+use phpDocumentor\Guides\ReferenceResolvers\Interlink\JsonLoader;
 use phpDocumentor\Guides\ReferenceResolvers\InterlinkReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\InternalReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\PageHyperlinkResolver;
 use phpDocumentor\Guides\ReferenceResolvers\ReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\ReferenceResolverPreRender;
-use phpDocumentor\Guides\ReferenceResolvers\SluggerAnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\SluggerAnchorNormalizer;
 use phpDocumentor\Guides\Renderer\HtmlRenderer;
 use phpDocumentor\Guides\Renderer\InMemoryRendererFactory;
 use phpDocumentor\Guides\Renderer\InterlinkObjectsRenderer;
@@ -193,8 +193,8 @@
         ->arg('$renderSets', tagged_iterator('phpdoc.renderer.typerenderer', 'format'))
         ->alias(TypeRendererFactory::class, InMemoryRendererFactory::class)
 
-        ->set(SluggerAnchorReducer::class)
-        ->alias(AnchorReducer::class, SluggerAnchorReducer::class)
+        ->set(SluggerAnchorNormalizer::class)
+        ->alias(AnchorNormalizer::class, SluggerAnchorNormalizer::class)
 
         ->set('phpdoc.guides.output_node_renderer', OutputAwareDelegatingNodeRenderer::class)
         ->arg('$nodeRenderers', tagged_iterator('phpdoc.guides.output_node_renderer', 'format'))

packages/guides/src/Compiler/NodeTransformers/CollectLinkTargetsTransformer.php

@@ -13,7 +13,7 @@
 use phpDocumentor\Guides\Nodes\MultipleLinkTargetsNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\SectionNode;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use SplStack;
 use Webmozart\Assert\Assert;
 
@@ -24,7 +24,7 @@ final class CollectLinkTargetsTransformer implements NodeTransformer
     private readonly SplStack $documentStack;
 
     public function __construct(
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
     ) {
         /*
          * TODO: remove stack here, as we should not have sub documents in this way, sub documents are