Skip to content

fix: handle frontmatter body field in mdx #451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

stefanprobst
Copy link
Contributor

markdown documents can have a body markdown field in frontmatter, which will be processed correctly, e.g.:

const Nested = defineNestedType(() => ({
  name: 'Nested',
  fields: {
    body: {
      type: 'markdown',
      required: true,
    }
  }
}))

const Post = defineDocumentType(() => ({
  name: 'Post',
  filePathPattern: `**/*.md`,
  contentType: 'markdown',
  fields: {
    title: {
      type: 'string',
      required: true,
    },
    nested: {
      type: 'nested',
      of: Nested,
      required: true
    }
  }
}))

however, the same fails with mdx (contentlayer will use the top-level body field even for nested.body):

const Nested = defineNestedType(() => ({
  name: 'Nested',
  fields: {
    body: {
      type: 'mdx',
      required: true,
    }
  }
}))

const Post = defineDocumentType(() => ({
  name: 'Post',
  filePathPattern: `**/*.mdx`,
  contentType: 'mdx',
  fields: {
    title: {
      type: 'string',
      required: true,
    },
    nested: {
      type: 'nested',
      of: Nested,
      required: true
    }
  }
}))

this is because the markdown field checks isRootDocument, but the mdx field does not. this pr makes the mdx field match the markdown field behavior.


for context: i ran into this because netlify-cms will create these nested frontmatter body fields for "single file" collections with i18n.

@changeset-bot
Copy link

changeset-bot bot commented May 5, 2023

⚠️ No Changeset found

Latest commit: eee50e8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR
Some errors occurred when validating the changesets config:
The package or glob expression "examples-*" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.

@stale
Copy link

stale bot commented May 25, 2023

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the meta: stale label May 25, 2023
@schickling schickling added this to the 0.3.3 milestone May 25, 2023
@schickling schickling merged commit 5364d4f into contentlayerdev:main May 31, 2023
@schickling
Copy link
Collaborator

Thanks a lot @stefanprobst 🙌

@stefanprobst stefanprobst deleted the fix/frontmatter-body-field branch May 31, 2023 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants