Fix Markdoc custom transform dropped for tag/node names with dashes#17191
Open
eldardada wants to merge 1 commit into
Open
Fix Markdoc custom transform dropped for tag/node names with dashes#17191eldardada wants to merge 1 commit into
eldardada wants to merge 1 commit into
Conversation
🦋 Changeset detectedLatest commit: 391e07a The changes in this PR will be included in the next version bump. This PR includes changesets to release 24 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
850d54f to
5270964
Compare
1 task
5270964 to
391e07a
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
Custom Markdoc
transformfunctions were being dropped for tags and nodes whose names need bracket access, likeside-note.Here is why. When you set a custom
rendercomponent,resolveComponentImportsremoves thetransformunless that transform "respects" render (issue #9708, added in #15335). It worked that out by string-matching the transform's source forconfig.tags?.<key>?.renderorconfig.nodes?.<key>?.render, which only covers dot notation.A key like
side-notecan't be read with dot notation at all (config.tags?.side-note?.renderparses as a subtraction), so those transforms have to use bracket notation:config.tags?.['side-note']?.render. The old check never matched that, so the transform was always treated as not respecting render and deleted, which broke the tag.The detection now handles bracket notation alongside dot notation, plus optional chaining and whitespace. Includes a changeset (
@astrojs/markdocpatch).Fixes #17118.
Testing
Added
packages/integrations/markdoc/test/resolve-component-imports.test.ts, a unit test over the exportedresolveComponentImports:side-note, via bracket access) is kept;renderwins.I checked it both ways: the first case fails on
main(transform deleted) and passes with this change. The full package suite is green too.pnpm --filter @astrojs/markdoc testruns 50 tests, including the existingrender-with-transformtest for #9708.tsc -b,biome check,prettier --check, andeslintare all clean on the changed files.Docs
No docs changes. This restores the documented behavior (a custom
rendertogether with a customtransform) for tag and node names that contain dashes, and there is no public API change.