[MDX] Fix remaining inconsistencies with Markdown #4268
Merged
Conversation
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
🦋 Changeset detectedLatest commit: bd9ee73 The changes in this PR will be included in the next version bump. This PR includes changesets to release 14 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 |
github-actions
bot
added
pkg: astro
bholmesdev
force-pushed
the
fix/mdx-md-prop-consistency
branch
from
7eab1db
to
c36825e
Compare
bholmesdev
commented
Aug 12, 2022
packages/astro/src/@types/astro.ts
Outdated
Comment on lines
865
to
875
| export interface MarkdownLayoutProps<T extends Record<string, any>> { | ||
| frontmatter: { file: string; url: string | undefined } & T; | ||
| file: MarkdownInstance<T>['file']; | ||
| url: MarkdownInstance<T>['url']; | ||
| headings: MarkdownHeading[]; | ||
| rawContent: MarkdownInstance<T>['rawContent']; | ||
| compiledContent: MarkdownInstance<T>['compiledContent']; | ||
| } | ||
|
|
||
| export interface MDXLayoutProps<T> | ||
| extends Omit<MarkdownLayoutProps<T>, 'rawContent' | 'compiledContent'> {} |
There was a problem hiding this comment.
Added these types for my own sanity. Could be pretty helpful! Example usage:
---
import type { MarkdownLayoutProps } from 'astro';
const { file, url, headings, frontmatter } = Astro.props as MarkdownLayoutProps<{ title: string }>;
---
natemoo-re
reviewed
Aug 12, 2022
bholmesdev
commented
Aug 12, 2022
| @@ -86,6 +84,8 @@ export default function markdown({ config, logging }: AstroPluginOptions): Plugi | |||
| }; | |||
| export async function Content() { | |||
| const { layout, ...content } = frontmatter; | |||
| content.file = file; | |||
There was a problem hiding this comment.
Fixes existing bug where frontmatter.file and frontmatter.url are added to glob results as well. This is inconsistent with the previous API and type defs.
natemoo-re
approved these changes
Aug 12, 2022
Merged
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
fileandurlto frontmatter propsglob<Content />component exportrawContentandcompiledContentof typenever. If called, this will log a helpful error message pointing to new frontmatter injection docs.*.mdxto declared type moduleglobto useMDXInstanceinstead. This overrides therawContentandcompiledContentprops to be typeneverMarkdownLayoutPropsandMDXLayoutProps. Can remove if out of scope, but should be useful!Testing
Contentcomponentfileandurlfrom layoutsDocs
N/A