fix(markdown-satteri): clarify smartPunctuation default#17314
Open
barry166 wants to merge 1 commit into
Open
Conversation
Astro enables smart punctuation by default before merging user feature overrides, but the public Satteri processor options reused upstream Satteri JSDoc that says smartPunctuation defaults to false. Override only that feature property in the exported Astro type so IDE hovers match Astro behavior without changing runtime defaults. Constraint: Upstream satteri default remains false, while Astro's markdown wrapper defaults smartypants to true. Rejected: Change runtime feature defaults | issue is documentation/type metadata only. Confidence: high Scope-risk: narrow Tested: corepack pnpm --filter @astrojs/prism build; corepack pnpm --filter @astrojs/internal-helpers build; corepack pnpm --filter @astrojs/markdown-satteri build; corepack pnpm --filter @astrojs/markdown-satteri test; prettier check on touched files; git diff --check Not-tested: IDE hover rendering manually in an editor
|
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
1 participant
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.
Summary
SatteriFeaturestype that overrides the upstreamsmartPunctuationJSDocsatteri({ features })Fixes #17305.
Testing
corepack pnpm --filter @astrojs/prism buildcorepack pnpm --filter @astrojs/internal-helpers buildcorepack pnpm --filter @astrojs/markdown-satteri buildcorepack pnpm --filter @astrojs/markdown-satteri testcorepack pnpm exec prettier packages/markdown/satteri/src/processor.ts packages/markdown/satteri/src/index.ts --checkgit diff --checkNotes
AI-assisted. I manually reviewed the final diff and verification output.