Improve new directive handling

Author: jaapio

packages/guides-restructured-text/src/RestructuredText/Compiler/Passes/DirectiveProcessPass.php

@@ -81,6 +81,6 @@ public function supports(Node $node): bool
 
     public function getPriority(): int
     {
-        return PHP_INT_MAX;
+        return 100;
     }
 }

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

@@ -51,11 +51,16 @@ final protected function processSub(
 
     public function createNode(DirectiveNode $directiveNode): Node|null
     {
+        $children = $directiveNode->getChildren();
+        if ($directiveNode->getDirective()->getDataNode() !== null) {
+            array_unshift($children, new ParagraphNode([$directiveNode->getDirective()->getDataNode()]));
+        }
+
         return new AdmonitionNode(
             $directiveNode->getDirective()->getName(),
-            $directiveNode->getDirective()->getDataNode(),
+            null,
             $this->text,
-            $directiveNode->getChildren(),
+            $children,
         );
     }
 }

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/DirectiveRule.php

@@ -95,10 +95,22 @@ public function apply(BlockContext $blockContext, CompoundNode|null $on = null):
         $buffer = $this->collectDirectiveContents($documentIterator);
 
         if ($this->startingRule !== null && $directiveHandler->isUpgraded()) {
-            return $this->startingRule->apply(
+            $node = $this->startingRule->apply(
                 new BlockContext($blockContext->getDocumentParserContext(), $buffer->getLinesString(), true, $documentIterator->key()),
                 new DirectiveNode($directive),
             );
+
+            if ($node === null) {
+                return null;
+            }
+
+            if ($directive->getVariable() === '') {
+                return $node;
+            }
+
+            $blockContext->getDocumentParserContext()->getDocument()->addVariable($directive->getVariable(), $node);
+
+            return null;
         }
 
         // Processing the Directive, the handler is responsible for adding the right Nodes to the document.

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

@@ -48,15 +48,15 @@ public function leaveNode(Node $node, CompilerContextInterface $compilerContext)
         $nodeReplacement ??= $compilerContext->getProjectNode()->getVariable($node->getValue(), null);
 
         if ($nodeReplacement instanceof Node) {
-            $node->setChild($nodeReplacement);
-        } else {
-            $this->logger->warning(
-                'No replacement was found for variable |' . $node->getValue() . '|',
-                $compilerContext->getLoggerInformation(),
-            );
-            $node->setChild(new PlainTextInlineNode('|' . $node->getValue() . '|'));
+            return $nodeReplacement;
         }
 
+        $this->logger->warning(
+            'No replacement was found for variable |' . $node->getValue() . '|',
+            $compilerContext->getLoggerInformation(),
+        );
+        $node->setChild(new PlainTextInlineNode('|' . $node->getValue() . '|'));
+
         return $node;
     }