Bug: makeSource args type not updated with new config options for 0.2.5 release

[Saeris]

In the 0.2.5 release notes, for MDX, it's recommended to use a new mdxOptions property, but the PartialArgs type that makeSource expects hasn't been updated for this as far as I can tell. Whereas with the markdown field, it was correctly updated to optionally support a builder callback function. Here's a link the relevant code:

contentlayer/packages/@contentlayer/core/src/plugin.ts

Lines 125 to 132 in dcc4885

	export type PartialArgs = {
	markdown?: MarkdownOptions | MarkdownUnifiedBuilderCallback | undefined
	mdx?: MarkdownOptions | undefined
	date?: DateOptions | undefined
	fieldOptions?: Partial<FieldOptions>
	extensions?: PluginExtensions
	disableImportAliasWarning?: boolean
	}

And the release notes where there is a mismatch: https://github.com/contentlayerdev/contentlayer/releases/tag/v0.2.5

Additionally, I'm unsure how this solves the problem I was aiming to resolve with #192

[Saeris]

Ah, as for #192 I see that in fact the rawDocumentData was added to the VFile data object, which was undocumented in the release notes. So that does solve for my problem. Thanks!

Clarity may still be needed for this issue though on the makeSource arg types.

[seancdavis]

@Saeris There are two issues on the website repo for better documenting markdown behavior:

• source-files: Document markdown processing behaviour website#20
• Passing raw HTML tags through the markdown processor website#43

Do you suspect properly completing those issues would solve this topic here?

[Saeris]

This topic is specifically about the types the library is shipping need to be updated. Currently you cannot use mdxOptions as documented because it raises a type error. So no, it's not a documentation issue, it's missing code. Either that or the release notes were inaccurate.

Read the section on MDX Processing in the page I linked above. You cannot use the code snippet there because it raises a type error.

[schickling]

This should be addressed with the 0.2.6 release. 🎉