refactor(api-markdown-documenter): Remove support for unsafe escaped text support from PlainTextNode

[Josmithr]

This type previously supported an unsafe escape hatch for text escaping.
This support is no longer needed and has been removed.

[Copilot]

Pull Request Overview

Refactors how escaped text is handled by extracting it into its own EscapedTextNode type, removes the escaped flag from PlainTextNode, and updates renderers, transformations, and tests accordingly.

• Introduces EscapedTextNode class and related mapping in domain index
• Updates markdown and HTML renderers/transformers to handle escaped text separately
• Removes escaped parameter from PlainTextNode and adjusts tests

Reviewed Changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tools/api-markdown-documenter/src/renderers/markdown-renderer/test/RenderDocument.test.ts	Adds test for escaped markdown rendering
tools/api-markdown-documenter/src/renderers/markdown-renderer/default-renderers/RenderPlainText.ts	Removes node.escaped branch and refactors whitespace splitter export
tools/api-markdown-documenter/src/renderers/markdown-renderer/default-renderers/RenderEscapedText.ts	Implements renderer for EscapedTextNode
tools/api-markdown-documenter/src/renderers/markdown-renderer/default-renderers/index.ts	Exports and registers renderEscapedText
tools/api-markdown-documenter/src/documentation-domain/PlainTextNode.ts	Drops escaped flag from PlainTextNode constructor
tools/api-markdown-documenter/src/documentation-domain/EscapedTextNode.ts	Adds new EscapedTextNode class
tools/api-markdown-documenter/src/documentation-domain-to-html/default-transformations/EscapedTextToHtml.ts	Implements HTML transformer for EscapedTextNode
tools/api-markdown-documenter/src/api-item-transforms/TsdocNodeTransforms.ts	Emits EscapedTextNode from TSDoc escapes
tools/api-markdown-documenter/api-report/**/*	Updates public API to include EscapedTextNode and remove escaped param

Comments suppressed due to low confidence (4)

tools/api-markdown-documenter/src/renderers/markdown-renderer/default-renderers/index.ts:85

• The renderer key is a raw property escapedText. For consistency with other renderers, use [DocumentationNodeType.EscapedText] as the key so it maps correctly to the node type.

escapedText: (node, writer, context): void =>

tools/api-markdown-documenter/src/documentation-domain-to-html/default-transformations/EscapedTextToHtml.ts:18

• The doc comment refers to PlainTextNode but this function handles EscapedTextNode. Update the reference to {@link EscapedTextNode}.

* Transform a {@link PlainTextNode} to HTML.

tools/api-markdown-documenter/src/renderers/markdown-renderer/test/RenderDocument.test.ts:64

• The test references SectionNode but it is not imported at the top. Add SectionNode to the import list to prevent missing-symbol errors.

new SectionNode([

tools/api-markdown-documenter/src/documentation-domain-to-html/configuration/Transformation.ts:94

• The transformation key uses a raw property escapedText. To ensure the escaped node is picked up, use [DocumentationNodeType.EscapedText] instead of an unscoped property.

escapedText: (node, context) => escapedTextToHtml(node as EscapedTextNode, context),

[Josmithr]

No longer needed!

[github-actions]

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output

> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  222981 links
    1707 destination URLs
    1939 URLs ignored
       0 warnings
       0 errors