feat(cli): store markdown file references in docs definition jsFiles #11063
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Refs: Requested by @sbawabe
When generating docs,
<Markdown src="xyz" />components are replaced with their content, but the reference to the original file is lost. This PR preserves these referenced markdown files by storing them in thejsFilesobject of the docs definition.Changes Made
replaceReferencedMarkdown()to track all referenced markdown files and return them alongside the processed markdownReferencedMarkdownFileandReplaceReferencedMarkdownResultto represent the tracked filesDocsDefinitionResolverto collect referenced markdown files from all pages and add them tojsFilespreviewDocs.tsto handle the new return typeTesting
Human Review Checklist
Verify no other callers ofFound and updatedreplaceReferencedMarkdownexist outsideDocsDefinitionResolverpreviewDocs.tsjsFilesmatches what the docs-loader expectsreferencedMarkdownFilesarray doesn't accumulate ifresolve()is called multiple times on the sameDocsDefinitionResolverinstanceLink to Devin run: https://app.devin.ai/sessions/200e42b48c144b5b96a758ffdf554cfc
Requested by: Sarah Bawabe ([email protected]) / @sbawabe