-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FEATURE] Use :ref: Textrole to link to confvals and viewhelpers
- Loading branch information
Showing
20 changed files
with
379 additions
and
169 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
154 changes: 154 additions & 0 deletions
154
...es/typo3-docs-theme/src/Compiler/NodeTransformers/CollectPrefixLinkTargetsTransformer.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * This file is part of phpDocumentor. | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| * | ||
| * @link https://phpdoc.org | ||
| */ | ||
|
|
||
| namespace T3Docs\Typo3DocsTheme\Compiler\NodeTransformers; | ||
|
|
||
| use phpDocumentor\Guides\Compiler\CompilerContextInterface; | ||
| use phpDocumentor\Guides\Compiler\NodeTransformer; | ||
| use phpDocumentor\Guides\Exception\DuplicateLinkAnchorException; | ||
| use phpDocumentor\Guides\Meta\InternalTarget; | ||
| use phpDocumentor\Guides\Nodes\AnchorNode; | ||
| use phpDocumentor\Guides\Nodes\DocumentNode; | ||
| use phpDocumentor\Guides\Nodes\LinkTargetNode; | ||
| use phpDocumentor\Guides\Nodes\MultipleLinkTargetsNode; | ||
| use phpDocumentor\Guides\Nodes\Node; | ||
| use phpDocumentor\Guides\Nodes\OptionalLinkTargetsNode; | ||
| use phpDocumentor\Guides\Nodes\PrefixedLinkTargetNode; | ||
| use phpDocumentor\Guides\Nodes\SectionNode; | ||
| use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer; | ||
| use Psr\Log\LoggerInterface; | ||
| use SplStack; | ||
| use Webmozart\Assert\Assert; | ||
|
|
||
| use function sprintf; | ||
|
|
||
| /** @implements NodeTransformer<DocumentNode|AnchorNode|SectionNode> */ | ||
| final class CollectPrefixLinkTargetsTransformer implements NodeTransformer | ||
| { | ||
| /** @var SplStack<DocumentNode> */ | ||
| private readonly SplStack $documentStack; | ||
|
|
||
| public function __construct( | ||
| private readonly AnchorNormalizer $anchorReducer, | ||
| private LoggerInterface|null $logger = null, | ||
| ) { | ||
| /* | ||
| * TODO: remove stack here, as we should not have sub documents in this way, sub documents are | ||
| * now produced by the {@see \phpDocumentor\Guides\RestructuredText\MarkupLanguageParser::getSubParser} | ||
| * as this works right now in isolation includes do not work as they should. | ||
| */ | ||
| $this->documentStack = new SplStack(); | ||
| } | ||
|
|
||
| public function enterNode(Node $node, CompilerContextInterface $compilerContext): Node | ||
| { | ||
| if ($node instanceof DocumentNode) { | ||
| $this->documentStack->push($node); | ||
| return $node; | ||
| } | ||
| if ($node instanceof SectionNode) { | ||
| return $node; | ||
| } | ||
|
|
||
| if ($node instanceof LinkTargetNode) { | ||
| if ($node instanceof OptionalLinkTargetsNode && $node->isNoindex()) { | ||
| return $node; | ||
| } | ||
| if ($node->getLinkText() === SectionNode::STD_LABEL) { | ||
| return $node; | ||
| } | ||
|
|
||
| $currentDocument = $this->documentStack->top(); | ||
| Assert::notNull($currentDocument); | ||
| $anchor = $this->anchorReducer->reduceAnchor($node->getId()); | ||
| $prefix = ''; | ||
| if ($node instanceof PrefixedLinkTargetNode) { | ||
| $prefix = $node->getPrefix(); | ||
| } | ||
|
|
||
| $this->addLinkTargetToProject( | ||
| $compilerContext, | ||
| new InternalTarget( | ||
| $currentDocument->getFilePath(), | ||
| $prefix . $anchor, | ||
| $node->getLinkText(), | ||
| SectionNode::STD_LABEL, | ||
| ), | ||
| ); | ||
| if ($node instanceof MultipleLinkTargetsNode) { | ||
| foreach ($node->getAdditionalIds() as $id) { | ||
| $anchor = $this->anchorReducer->reduceAnchor($id); | ||
| $this->addLinkTargetToProject( | ||
| $compilerContext, | ||
| new InternalTarget( | ||
| $currentDocument->getFilePath(), | ||
| $prefix . $anchor, | ||
| $node->getLinkText(), | ||
| SectionNode::STD_LABEL, | ||
| ), | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return $node; | ||
| } | ||
|
|
||
| public function leaveNode(Node $node, CompilerContextInterface $compilerContext): Node|null | ||
| { | ||
| if ($node instanceof DocumentNode) { | ||
| $this->documentStack->pop(); | ||
| } | ||
|
|
||
| return $node; | ||
| } | ||
|
|
||
| public function supports(Node $node): bool | ||
| { | ||
| return $node instanceof DocumentNode || $node instanceof LinkTargetNode; | ||
| } | ||
|
|
||
| public function getPriority(): int | ||
| { | ||
| // After CollectLinkTargetsTransformer | ||
| return 4000; | ||
| } | ||
|
|
||
| private function addLinkTargetToProject(CompilerContextInterface $compilerContext, InternalTarget $internalTarget): void | ||
| { | ||
| if ($compilerContext->getProjectNode()->hasInternalTarget($internalTarget->getAnchor(), $internalTarget->getLinkType())) { | ||
| $otherLink = $compilerContext->getProjectNode()->getInternalTarget($internalTarget->getAnchor(), $internalTarget->getLinkType()); | ||
| $this->logger?->warning( | ||
| sprintf( | ||
| 'Duplicate anchor "%s" for link type "%s" in document "%s". The anchor is already used at "%s"', | ||
| $internalTarget->getAnchor(), | ||
| $internalTarget->getLinkType(), | ||
| $compilerContext->getDocumentNode()->getFilePath(), | ||
| $otherLink?->getDocumentPath(), | ||
| ), | ||
| $compilerContext->getLoggerInformation(), | ||
| ); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| try { | ||
| $compilerContext->getProjectNode()->addLinkTarget( | ||
| $internalTarget->getAnchor(), | ||
| $internalTarget, | ||
| ); | ||
| } catch (DuplicateLinkAnchorException $exception) { | ||
| $this->logger?->warning($exception->getMessage(), $compilerContext->getLoggerInformation()); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,4 +9,4 @@ Confval | |
|
|
||
| Some Text | ||
|
|
||
| See also :confval:`demo`. | ||
| See also :confval:`demo` or :ref:`demo <confval-demo>`. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.