michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[MDX] Remove verbose migration logs (#5667)

Browse source 
* chore: remove markdown extends warnings

* chore: changeset
This commit is contained in:
Ben Holmes 2022-12-22 16:13:46 -05:00 committed by GitHub
parent 813576b39a
commit a5ba4af799
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/fluffy-cougars-care.md Normal file
View file

@ -0,0 +1,5 @@
---
'@astrojs/mdx': patch
---
Chore: remove verbose "Now interiting Markdown plugins..." logs

33
packages/integrations/mdx/src/index.ts
View file

@ -14,7 +14,7 @@ import {
recmaInjectImportMetaEnvPlugin, recmaInjectImportMetaEnvPlugin,
rehypeApplyFrontmatterExport, rehypeApplyFrontmatterExport,
} from './plugins.js'; } from './plugins.js';
import { getFileInfo, handleExtendsNotSupported, parseFrontmatter } from './utils.js'; import { getFileInfo, parseFrontmatter } from './utils.js';
const RAW_CONTENT_ERROR = const RAW_CONTENT_ERROR =
'MDX does not support rawContent()! If you need to read the Markdown contents to calculate values (ex. reading time), we suggest injecting frontmatter via remark plugins. Learn more on our docs: https://docs.astro.build/en/guides/integrations-guide/mdx/#inject-frontmatter-via-remark-or-rehype-plugins'; 'MDX does not support rawContent()! If you need to read the Markdown contents to calculate values (ex. reading time), we suggest injecting frontmatter via remark plugins. Learn more on our docs: https://docs.astro.build/en/guides/integrations-guide/mdx/#inject-frontmatter-via-remark-or-rehype-plugins';
@ -45,33 +45,10 @@ export default function mdx(mdxOptions: MdxOptions = {}): AstroIntegration {
addPageExtension('.mdx'); addPageExtension('.mdx');
mdxOptions.extendPlugins ??= 'markdown'; mdxOptions.extendPlugins ??= 'markdown';
handleExtendsNotSupported(mdxOptions.remarkPlugins); const remarkRehypeOptions = {
handleExtendsNotSupported(mdxOptions.rehypePlugins); ...(mdxOptions.extendPlugins === 'markdown' ? config.markdown.remarkRehype : {}),
...mdxOptions.remarkRehype,
// TODO: remove for 1.0. Shipping to ease migration to new minor };
if (
mdxOptions.extendPlugins === 'markdown' &&
(config.markdown.rehypePlugins?.length || config.markdown.remarkPlugins?.length)
) {
console.info(
blue(`[MDX] Now inheriting remark and rehype plugins from "markdown" config.`)
);
console.info(
`If you applied a plugin to both your Markdown and MDX configs, we suggest ${bold(
'removing the duplicate MDX entry.'
)}`
);
console.info(`See "extendPlugins" option to configure this behavior.`);
}
let remarkRehypeOptions = mdxOptions.remarkRehype;
if (mdxOptions.extendPlugins === 'markdown') {
remarkRehypeOptions = {
...config.markdown.remarkRehype,
...remarkRehypeOptions,
};
}
const mdxPluginOpts: MdxRollupPluginOptions = { const mdxPluginOpts: MdxRollupPluginOptions = {
remarkPlugins: await getRemarkPlugins(mdxOptions, config), remarkPlugins: await getRemarkPlugins(mdxOptions, config),

14
packages/integrations/mdx/src/utils.ts
View file

@ -83,21 +83,7 @@ export function jsToTreeNode(
}; };
} }
// TODO: remove for 1.0
export function handleExtendsNotSupported(pluginConfig: any) {
if (
typeof pluginConfig === 'object' &&
pluginConfig !== null &&
(pluginConfig as any).hasOwnProperty('extends')
) {
throw new Error(
`[MDX] The "extends" plugin option is no longer supported! Astro now extends your project's \`markdown\` plugin configuration by default. To customize this behavior, see the \`extendPlugins\` option instead: https://docs.astro.build/en/guides/integrations-guide/mdx/#extendplugins`
);
}
}
// Following utils taken from `packages/astro/src/core/path.ts`: // Following utils taken from `packages/astro/src/core/path.ts`:
export function isRelativePath(path: string) { export function isRelativePath(path: string) {
return startsWithDotDotSlash(path) || startsWithDotSlash(path); return startsWithDotDotSlash(path) || startsWithDotSlash(path);
} }