Unverified Commit 372f00eb authored by OJ Kwon's avatar OJ Kwon Committed by GitHub

fext(next): extend next.config for mdxRs support options (#64801)

### What

Closes PACK-2978, requires https://github.com/vercel/turbo/pull/8005.

PR extends existing mdxRs config from accepting object as well in
addition to current boolean flag, mainly to allow to specify what kind
of markdown types will be used between gfm and commonmark.
parent 75c9e2b8
This diff is collapsed.
...@@ -37,11 +37,11 @@ swc_core = { version = "0.90.33", features = [ ...@@ -37,11 +37,11 @@ swc_core = { version = "0.90.33", features = [
testing = { version = "0.35.22" } testing = { version = "0.35.22" }
# Turbo crates # Turbo crates
turbopack-binding = { git = "https://github.com/vercel/turbo.git", tag = "turbopack-240417.1" } turbopack-binding = { git = "https://github.com/vercel/turbo.git", tag = "turbopack-240422.2" }
# [TODO]: need to refactor embed_directory! macro usages, as well as resolving turbo_tasks::function, macros.. # [TODO]: need to refactor embed_directory! macro usages, as well as resolving turbo_tasks::function, macros..
turbo-tasks = { git = "https://github.com/vercel/turbo.git", tag = "turbopack-240417.1" } turbo-tasks = { git = "https://github.com/vercel/turbo.git", tag = "turbopack-240422.2" }
# [TODO]: need to refactor embed_directory! macro usage in next-core # [TODO]: need to refactor embed_directory! macro usage in next-core
turbo-tasks-fs = { git = "https://github.com/vercel/turbo.git", tag = "turbopack-240417.1" } turbo-tasks-fs = { git = "https://github.com/vercel/turbo.git", tag = "turbopack-240422.2" }
# General Deps # General Deps
......
...@@ -768,6 +768,20 @@ module.exports = withMDX({ ...@@ -768,6 +768,20 @@ module.exports = withMDX({
}) })
``` ```
`mdxRs` also accepts an object to configure how to transform mdx files.
```js filename="next.config.js"
module.exports = withMDX({
experimental: {
mdxRs: {
jsxRuntime?: string // Custom jsx runtime
jsxImportSource?: string // Custom jsx import source,
mdxType?: 'gfm' | 'commonmark' // Configure what kind of mdx syntax will be used to parse & transform
},
},
})
```
## Helpful Links ## Helpful Links
- [MDX](https://mdxjs.com) - [MDX](https://mdxjs.com)
......
...@@ -3,12 +3,15 @@ module.exports = ...@@ -3,12 +3,15 @@ module.exports =
(nextConfig = {}) => { (nextConfig = {}) => {
const extension = pluginOptions.extension || /\.mdx$/ const extension = pluginOptions.extension || /\.mdx$/
const loader = nextConfig?.experimental?.mdxRs const mdxRsOptions = nextConfig?.experimental?.mdxRs
const loader = mdxRsOptions
? { ? {
loader: require.resolve('./mdx-rs-loader'), loader: require.resolve('./mdx-rs-loader'),
options: { options: {
providerImportSource: 'next-mdx-import-source-file', providerImportSource: 'next-mdx-import-source-file',
...pluginOptions.options, ...pluginOptions.options,
// mdxRsOptions is a union of boolean and object type of MdxTransformOptions
...(mdxRsOptions === true ? {} : mdxRsOptions),
}, },
} }
: { : {
......
...@@ -20,6 +20,38 @@ const own = {}.hasOwnProperty ...@@ -20,6 +20,38 @@ const own = {}.hasOwnProperty
const marker = {} const marker = {}
const cache = new WeakMap() const cache = new WeakMap()
/*
* From next.config.js's mdxRs option, construct an actual option object that mdxRs compiler accepts.
*/
function coereceMdxTransformOptions(options = {}) {
const { mdxType, ...restOptions } = options
let parse = undefined
switch (mdxType) {
case 'gfm':
parse = {
constructs: {
gfmAutolinkLiteral: true,
gfmFootnoteDefinition: true,
gfmLabelStartFootnote: true,
gfmStrikethrough: true,
gfmTable: true,
gfmTaskListItem: true,
},
}
break
case 'commonMark':
default:
parse = { gfmStrikethroughSingleTilde: true, mathTextSingleDollar: true }
break
}
return {
...restOptions,
parse,
}
}
/** /**
* A webpack loader for mdx-rs. This is largely based on existing @mdx-js/loader, * A webpack loader for mdx-rs. This is largely based on existing @mdx-js/loader,
* replaces internal compilation logic to use mdx-rs instead. * replaces internal compilation logic to use mdx-rs instead.
...@@ -41,7 +73,10 @@ function loader(value, bindings, callback) { ...@@ -41,7 +73,10 @@ function loader(value, bindings, callback) {
let process = map.get(hash) let process = map.get(hash)
if (!process) { if (!process) {
process = createFormatAwareProcessors(bindings, config).compile process = createFormatAwareProcessors(
bindings,
coereceMdxTransformOptions(config)
).compile
map.set(hash, process) map.set(hash, process)
} }
......
...@@ -12,6 +12,7 @@ impl Task for MdxCompileTask { ...@@ -12,6 +12,7 @@ impl Task for MdxCompileTask {
fn compute(&mut self) -> napi::Result<Self::Output> { fn compute(&mut self) -> napi::Result<Self::Output> {
let options: Options = serde_json::from_slice(&self.option)?; let options: Options = serde_json::from_slice(&self.option)?;
compile(&self.input, &options) compile(&self.input, &options)
.map_err(|err| napi::Error::new(Status::GenericFailure, format!("{:?}", err))) .map_err(|err| napi::Error::new(Status::GenericFailure, format!("{:?}", err)))
} }
......
...@@ -25,8 +25,8 @@ use turbopack_binding::{ ...@@ -25,8 +25,8 @@ use turbopack_binding::{
turbopack::{ turbopack::{
condition::ContextCondition, condition::ContextCondition,
module_options::{ module_options::{
module_options_context::ModuleOptionsContext, JsxTransformOptions, module_options_context::ModuleOptionsContext, JsxTransformOptions, ModuleRule,
MdxTransformModuleOptions, ModuleRule, TypescriptTransformOptions, TypescriptTransformOptions,
}, },
resolve_options_context::ResolveOptionsContext, resolve_options_context::ResolveOptionsContext,
}, },
...@@ -42,7 +42,7 @@ use crate::{ ...@@ -42,7 +42,7 @@ use crate::{
next_config::NextConfig, next_config::NextConfig,
next_import_map::{ next_import_map::{
get_next_client_fallback_import_map, get_next_client_import_map, get_next_client_fallback_import_map, get_next_client_import_map,
get_next_client_resolved_map, mdx_import_source_file, get_next_client_resolved_map,
}, },
next_shared::{ next_shared::{
resolve::{ resolve::{
...@@ -192,16 +192,7 @@ pub async fn get_client_module_options_context( ...@@ -192,16 +192,7 @@ pub async fn get_client_module_options_context(
let tsconfig = get_typescript_transform_options(project_path); let tsconfig = get_typescript_transform_options(project_path);
let decorators_options = get_decorators_transform_options(project_path); let decorators_options = get_decorators_transform_options(project_path);
let enable_mdx_rs = if *next_config.mdx_rs().await? { let enable_mdx_rs = *next_config.mdx_rs().await?;
Some(
MdxTransformModuleOptions {
provider_import_source: Some(mdx_import_source_file()),
}
.cell(),
)
} else {
None
};
let jsx_runtime_options = get_jsx_transform_options( let jsx_runtime_options = get_jsx_transform_options(
project_path, project_path,
mode, mode,
......
...@@ -30,15 +30,15 @@ pub async fn get_next_client_transforms_rules( ...@@ -30,15 +30,15 @@ pub async fn get_next_client_transforms_rules(
let mut rules = vec![]; let mut rules = vec![];
let modularize_imports_config = &next_config.await?.modularize_imports; let modularize_imports_config = &next_config.await?.modularize_imports;
let enable_mdx_rs = next_config.mdx_rs().await?.is_some();
if let Some(modularize_imports_config) = modularize_imports_config { if let Some(modularize_imports_config) = modularize_imports_config {
rules.push(get_next_modularize_imports_rule( rules.push(get_next_modularize_imports_rule(
modularize_imports_config, modularize_imports_config,
*next_config.mdx_rs().await?, enable_mdx_rs,
)); ));
} }
let mdx_rs = *next_config.mdx_rs().await?; rules.push(get_next_font_transform_rule(enable_mdx_rs));
rules.push(get_next_font_transform_rule(mdx_rs));
match context_ty { match context_ty {
ClientContextType::Pages { pages_dir } => { ClientContextType::Pages { pages_dir } => {
...@@ -47,36 +47,36 @@ pub async fn get_next_client_transforms_rules( ...@@ -47,36 +47,36 @@ pub async fn get_next_client_transforms_rules(
get_next_pages_transforms_rule( get_next_pages_transforms_rule(
pages_dir, pages_dir,
ExportFilter::StripDataExports, ExportFilter::StripDataExports,
mdx_rs, enable_mdx_rs,
) )
.await?, .await?,
); );
rules.push(get_next_disallow_export_all_in_page_rule( rules.push(get_next_disallow_export_all_in_page_rule(
mdx_rs, enable_mdx_rs,
pages_dir.await?, pages_dir.await?,
)); ));
rules.push(get_next_page_config_rule(mdx_rs, pages_dir.await?)); rules.push(get_next_page_config_rule(enable_mdx_rs, pages_dir.await?));
} }
} }
ClientContextType::App { .. } => { ClientContextType::App { .. } => {
rules.push(get_server_actions_transform_rule( rules.push(get_server_actions_transform_rule(
ActionsTransform::Client, ActionsTransform::Client,
mdx_rs, enable_mdx_rs,
)); ));
} }
ClientContextType::Fallback | ClientContextType::Other => {} ClientContextType::Fallback | ClientContextType::Other => {}
}; };
if !foreign_code { if !foreign_code {
rules.push(get_next_amp_attr_rule(mdx_rs)); rules.push(get_next_amp_attr_rule(enable_mdx_rs));
rules.push(get_next_cjs_optimizer_rule(mdx_rs)); rules.push(get_next_cjs_optimizer_rule(enable_mdx_rs));
rules.push(get_next_pure_rule(mdx_rs)); rules.push(get_next_pure_rule(enable_mdx_rs));
rules.push(get_next_dynamic_transform_rule(false, false, mode, mdx_rs).await?); rules.push(get_next_dynamic_transform_rule(false, false, mode, enable_mdx_rs).await?);
rules.push(get_next_image_rule()); rules.push(get_next_image_rule());
rules.push(get_next_page_static_info_assert_rule( rules.push(get_next_page_static_info_assert_rule(
mdx_rs, enable_mdx_rs,
None, None,
Some(context_ty), Some(context_ty),
)); ));
......
...@@ -17,11 +17,15 @@ use turbopack_binding::{ ...@@ -17,11 +17,15 @@ use turbopack_binding::{
styled_components::StyledComponentsTransformConfig, styled_components::StyledComponentsTransformConfig,
}, },
node::transforms::webpack::{WebpackLoaderItem, WebpackLoaderItems}, node::transforms::webpack::{WebpackLoaderItem, WebpackLoaderItems},
turbopack::module_options::{LoaderRuleItem, OptionWebpackRules}, turbopack::module_options::{
module_options_context::MdxTransformOptions, LoaderRuleItem, OptionWebpackRules,
},
}, },
}; };
use crate::next_shared::transforms::ModularizeImportPackageConfig; use crate::{
next_import_map::mdx_import_source_file, next_shared::transforms::ModularizeImportPackageConfig,
};
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)] #[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
...@@ -423,6 +427,13 @@ pub enum LoaderItem { ...@@ -423,6 +427,13 @@ pub enum LoaderItem {
LoaderOptions(WebpackLoaderItem), LoaderOptions(WebpackLoaderItem),
} }
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, TraceRawVcs)]
#[serde(untagged)]
pub enum MdxRsOptions {
Boolean(bool),
Option(MdxTransformOptions),
}
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize, TraceRawVcs)] #[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize, TraceRawVcs)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct ExperimentalConfig { pub struct ExperimentalConfig {
...@@ -436,7 +447,7 @@ pub struct ExperimentalConfig { ...@@ -436,7 +447,7 @@ pub struct ExperimentalConfig {
pub isr_flush_to_disk: Option<bool>, pub isr_flush_to_disk: Option<bool>,
/// For use with `@next/mdx`. Compile MDX files using the new Rust compiler. /// For use with `@next/mdx`. Compile MDX files using the new Rust compiler.
/// @see [api reference](https://nextjs.org/docs/app/api-reference/next-config-js/mdxRs) /// @see [api reference](https://nextjs.org/docs/app/api-reference/next-config-js/mdxRs)
mdx_rs: Option<bool>, mdx_rs: Option<MdxRsOptions>,
/// A list of packages that should be treated as external in the RSC server /// A list of packages that should be treated as external in the RSC server
/// build. @see [api reference](https://nextjs.org/docs/app/api-reference/next-config-js/server_components_external_packages) /// build. @see [api reference](https://nextjs.org/docs/app/api-reference/next-config-js/server_components_external_packages)
pub server_components_external_packages: Option<Vec<String>>, pub server_components_external_packages: Option<Vec<String>>,
...@@ -638,6 +649,9 @@ impl RemoveConsoleConfig { ...@@ -638,6 +649,9 @@ impl RemoveConsoleConfig {
#[turbo_tasks::value(transparent)] #[turbo_tasks::value(transparent)]
pub struct ResolveExtensions(Option<Vec<String>>); pub struct ResolveExtensions(Option<Vec<String>>);
#[turbo_tasks::value(transparent)]
pub struct OptionalMdxTransformOptions(Option<Vc<MdxTransformOptions>>);
#[turbo_tasks::value_impl] #[turbo_tasks::value_impl]
impl NextConfig { impl NextConfig {
#[turbo_tasks::function] #[turbo_tasks::function]
...@@ -833,8 +847,34 @@ impl NextConfig { ...@@ -833,8 +847,34 @@ impl NextConfig {
} }
#[turbo_tasks::function] #[turbo_tasks::function]
pub async fn mdx_rs(self: Vc<Self>) -> Result<Vc<bool>> { pub async fn mdx_rs(self: Vc<Self>) -> Result<Vc<OptionalMdxTransformOptions>> {
Ok(Vc::cell(self.await?.experimental.mdx_rs.unwrap_or(false))) let options = &self.await?.experimental.mdx_rs;
let options = match options {
Some(MdxRsOptions::Boolean(true)) => OptionalMdxTransformOptions(Some(
MdxTransformOptions {
provider_import_source: Some(mdx_import_source_file()),
..Default::default()
}
.cell(),
)),
Some(MdxRsOptions::Option(options)) => OptionalMdxTransformOptions(Some(
MdxTransformOptions {
provider_import_source: Some(
options
.provider_import_source
.as_ref()
.map(|s| s.to_string())
.unwrap_or(mdx_import_source_file()),
),
..options.clone()
}
.cell(),
)),
_ => OptionalMdxTransformOptions(None),
};
Ok(options.cell())
} }
#[turbo_tasks::function] #[turbo_tasks::function]
......
...@@ -783,7 +783,7 @@ async fn insert_next_shared_aliases( ...@@ -783,7 +783,7 @@ async fn insert_next_shared_aliases(
) -> Result<()> { ) -> Result<()> {
let package_root = next_js_fs().root(); let package_root = next_js_fs().root();
if *next_config.mdx_rs().await? { if next_config.mdx_rs().await?.is_some() {
insert_alias_to_alternatives( insert_alias_to_alternatives(
import_map, import_map,
mdx_import_source_file(), mdx_import_source_file(),
......
...@@ -27,8 +27,7 @@ use turbopack_binding::{ ...@@ -27,8 +27,7 @@ use turbopack_binding::{
turbopack::{ turbopack::{
condition::ContextCondition, condition::ContextCondition,
module_options::{ module_options::{
JsxTransformOptions, MdxTransformModuleOptions, ModuleOptionsContext, ModuleRule, JsxTransformOptions, ModuleOptionsContext, ModuleRule, TypescriptTransformOptions,
TypescriptTransformOptions,
}, },
resolve_options_context::ResolveOptionsContext, resolve_options_context::ResolveOptionsContext,
transition::Transition, transition::Transition,
...@@ -46,7 +45,7 @@ use crate::{ ...@@ -46,7 +45,7 @@ use crate::{
next_build::get_postcss_package_mapping, next_build::get_postcss_package_mapping,
next_client::RuntimeEntries, next_client::RuntimeEntries,
next_config::NextConfig, next_config::NextConfig,
next_import_map::{get_next_server_import_map, mdx_import_source_file}, next_import_map::get_next_server_import_map,
next_server::resolve::ExternalPredicate, next_server::resolve::ExternalPredicate,
next_shared::{ next_shared::{
resolve::{ resolve::{
...@@ -325,9 +324,11 @@ pub async fn get_server_module_options_context( ...@@ -325,9 +324,11 @@ pub async fn get_server_module_options_context(
let mut foreign_next_server_rules = let mut foreign_next_server_rules =
get_next_server_transforms_rules(next_config, ty.into_value(), mode, true, next_runtime) get_next_server_transforms_rules(next_config, ty.into_value(), mode, true, next_runtime)
.await?; .await?;
let internal_custom_rules = let internal_custom_rules = get_next_server_internal_transforms_rules(
get_next_server_internal_transforms_rules(ty.into_value(), *next_config.mdx_rs().await?) ty.into_value(),
.await?; next_config.mdx_rs().await?.is_some(),
)
.await?;
let foreign_code_context_condition = let foreign_code_context_condition =
foreign_code_context_condition(next_config, project_path).await?; foreign_code_context_condition(next_config, project_path).await?;
...@@ -375,16 +376,7 @@ pub async fn get_server_module_options_context( ...@@ -375,16 +376,7 @@ pub async fn get_server_module_options_context(
// ModuleOptionsContext related options // ModuleOptionsContext related options
let tsconfig = get_typescript_transform_options(project_path); let tsconfig = get_typescript_transform_options(project_path);
let decorators_options = get_decorators_transform_options(project_path); let decorators_options = get_decorators_transform_options(project_path);
let enable_mdx_rs = if *next_config.mdx_rs().await? { let enable_mdx_rs = *next_config.mdx_rs().await?;
Some(
MdxTransformModuleOptions {
provider_import_source: Some(mdx_import_source_file()),
}
.cell(),
)
} else {
None
};
// Get the jsx transform options for the `client` side. // Get the jsx transform options for the `client` side.
// This matches to the behavior of existing webpack config, if issuer layer is // This matches to the behavior of existing webpack config, if issuer layer is
......
...@@ -33,7 +33,7 @@ pub async fn get_next_server_transforms_rules( ...@@ -33,7 +33,7 @@ pub async fn get_next_server_transforms_rules(
let mut rules = vec![]; let mut rules = vec![];
let modularize_imports_config = &next_config.await?.modularize_imports; let modularize_imports_config = &next_config.await?.modularize_imports;
let mdx_rs = *next_config.mdx_rs().await?; let mdx_rs = next_config.mdx_rs().await?.is_some();
if let Some(modularize_imports_config) = modularize_imports_config { if let Some(modularize_imports_config) = modularize_imports_config {
rules.push(get_next_modularize_imports_rule( rules.push(get_next_modularize_imports_rule(
modularize_imports_config, modularize_imports_config,
......
...@@ -9,7 +9,7 @@ use super::get_ecma_transform_rule; ...@@ -9,7 +9,7 @@ use super::get_ecma_transform_rule;
use crate::next_config::{EmotionTransformOptionsOrBoolean, NextConfig}; use crate::next_config::{EmotionTransformOptionsOrBoolean, NextConfig};
pub async fn get_emotion_transform_rule(next_config: Vc<NextConfig>) -> Result<Option<ModuleRule>> { pub async fn get_emotion_transform_rule(next_config: Vc<NextConfig>) -> Result<Option<ModuleRule>> {
let enable_mdx_rs = *next_config.mdx_rs().await?; let enable_mdx_rs = next_config.mdx_rs().await?.is_some();
let module_rule = next_config let module_rule = next_config
.await? .await?
.compiler .compiler
......
...@@ -37,7 +37,7 @@ pub async fn get_next_react_server_components_transform_rule( ...@@ -37,7 +37,7 @@ pub async fn get_next_react_server_components_transform_rule(
is_react_server_layer: bool, is_react_server_layer: bool,
app_dir: Option<Vc<FileSystemPath>>, app_dir: Option<Vc<FileSystemPath>>,
) -> Result<ModuleRule> { ) -> Result<ModuleRule> {
let enable_mdx_rs = *next_config.mdx_rs().await?; let enable_mdx_rs = next_config.mdx_rs().await?.is_some();
Ok(get_ecma_transform_rule( Ok(get_ecma_transform_rule(
Box::new(NextJsReactServerComponents::new( Box::new(NextJsReactServerComponents::new(
is_react_server_layer, is_react_server_layer,
......
...@@ -9,7 +9,7 @@ use crate::next_config::NextConfig; ...@@ -9,7 +9,7 @@ use crate::next_config::NextConfig;
/// Returns a transform rule for the relay graphql transform. /// Returns a transform rule for the relay graphql transform.
pub async fn get_relay_transform_rule(next_config: Vc<NextConfig>) -> Result<Option<ModuleRule>> { pub async fn get_relay_transform_rule(next_config: Vc<NextConfig>) -> Result<Option<ModuleRule>> {
let enable_mdx_rs = *next_config.mdx_rs().await?; let enable_mdx_rs = next_config.mdx_rs().await?.is_some();
let module_rule = next_config.await?.compiler.as_ref().and_then(|value| { let module_rule = next_config.await?.compiler.as_ref().and_then(|value| {
value.relay.as_ref().map(|config| { value.relay.as_ref().map(|config| {
get_ecma_transform_rule(Box::new(RelayTransformer::new(config)), enable_mdx_rs, true) get_ecma_transform_rule(Box::new(RelayTransformer::new(config)), enable_mdx_rs, true)
......
...@@ -13,7 +13,7 @@ use crate::{ ...@@ -13,7 +13,7 @@ use crate::{
pub async fn get_styled_components_transform_rule( pub async fn get_styled_components_transform_rule(
next_config: Vc<NextConfig>, next_config: Vc<NextConfig>,
) -> Result<Option<ModuleRule>> { ) -> Result<Option<ModuleRule>> {
let enable_mdx_rs = *next_config.mdx_rs().await?; let enable_mdx_rs = next_config.mdx_rs().await?.is_some();
let module_rule = next_config let module_rule = next_config
.await? .await?
......
...@@ -14,7 +14,7 @@ pub async fn get_styled_jsx_transform_rule( ...@@ -14,7 +14,7 @@ pub async fn get_styled_jsx_transform_rule(
next_config: Vc<NextConfig>, next_config: Vc<NextConfig>,
target_browsers: Vc<RuntimeVersions>, target_browsers: Vc<RuntimeVersions>,
) -> Result<Option<ModuleRule>> { ) -> Result<Option<ModuleRule>> {
let enable_mdx_rs = *next_config.mdx_rs().await?; let enable_mdx_rs = next_config.mdx_rs().await?.is_some();
let use_swc_css = *next_config.use_swc_css().await?; let use_swc_css = *next_config.use_swc_css().await?;
let versions = *target_browsers.await?; let versions = *target_browsers.await?;
......
...@@ -13,7 +13,7 @@ pub async fn get_swc_ecma_transform_plugin_rule( ...@@ -13,7 +13,7 @@ pub async fn get_swc_ecma_transform_plugin_rule(
Some(plugin_configs) if !plugin_configs.is_empty() => { Some(plugin_configs) if !plugin_configs.is_empty() => {
#[cfg(feature = "plugin")] #[cfg(feature = "plugin")]
{ {
let enable_mdx_rs = *next_config.mdx_rs().await?; let enable_mdx_rs = next_config.mdx_rs().await?.is_some();
get_swc_ecma_transform_rule_impl(project_path, plugin_configs, enable_mdx_rs).await get_swc_ecma_transform_rule_impl(project_path, plugin_configs, enable_mdx_rs).await
} }
......
...@@ -197,7 +197,7 @@ ...@@ -197,7 +197,7 @@
"@types/ws": "8.2.0", "@types/ws": "8.2.0",
"@vercel/ncc": "0.34.0", "@vercel/ncc": "0.34.0",
"@vercel/nft": "0.26.4", "@vercel/nft": "0.26.4",
"@vercel/turbopack-ecmascript-runtime": "https://gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240417.1", "@vercel/turbopack-ecmascript-runtime": "https://gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240422.2",
"acorn": "8.5.0", "acorn": "8.5.0",
"amphtml-validator": "1.0.35", "amphtml-validator": "1.0.35",
"anser": "1.4.9", "anser": "1.4.9",
......
...@@ -1500,10 +1500,7 @@ function getMdxOptions(options: any = {}) { ...@@ -1500,10 +1500,7 @@ function getMdxOptions(options: any = {}) {
...options, ...options,
development: options.development ?? false, development: options.development ?? false,
jsx: options.jsx ?? false, jsx: options.jsx ?? false,
parse: options.parse ?? { mdxType: options.mdxType ?? 'commonMark',
gfmStrikethroughSingleTilde: true,
mathTextSingleDollar: true,
},
} }
} }
......
...@@ -344,7 +344,20 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() => ...@@ -344,7 +344,20 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
]) ])
) )
.optional(), .optional(),
mdxRs: z.boolean().optional(), // This is partial set of mdx-rs transform options we support, aligned
// with next_core::next_config::MdxRsOptions. Ensure both types are kept in sync.
mdxRs: z
.union([
z.boolean(),
z.object({
development: z.boolean().optional(),
jsxRuntime: z.string().optional(),
jsxImportSource: z.string().optional(),
providerImportSource: z.string().optional(),
mdxType: z.enum(['gfm', 'commonmark']).optional(),
}),
])
.optional(),
typedRoutes: z.boolean().optional(), typedRoutes: z.boolean().optional(),
webpackBuildWorker: z.boolean().optional(), webpackBuildWorker: z.boolean().optional(),
turbo: z turbo: z
......
...@@ -317,7 +317,16 @@ export interface ExperimentalConfig { ...@@ -317,7 +317,16 @@ export interface ExperimentalConfig {
* For use with `@next/mdx`. Compile MDX files using the new Rust compiler. * For use with `@next/mdx`. Compile MDX files using the new Rust compiler.
* @see https://nextjs.org/docs/app/api-reference/next-config-js/mdxRs * @see https://nextjs.org/docs/app/api-reference/next-config-js/mdxRs
*/ */
mdxRs?: boolean mdxRs?:
| boolean
| {
development?: boolean
jsx?: boolean
jsxRuntime?: string
jsxImportSource?: string
providerImportSource?: string
mdxType?: 'gfm' | 'commonmark'
}
/** /**
* Generate Route types and enable type checking for Link and Router.push, etc. * Generate Route types and enable type checking for Link and Router.push, etc.
......
...@@ -1071,8 +1071,8 @@ importers: ...@@ -1071,8 +1071,8 @@ importers:
specifier: 0.26.4 specifier: 0.26.4
version: 0.26.4 version: 0.26.4
'@vercel/turbopack-ecmascript-runtime': '@vercel/turbopack-ecmascript-runtime':
specifier: https://gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240417.1 specifier: https://gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240422.2
version: '@gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240417.1' version: '@gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240422.2'
acorn: acorn:
specifier: 8.5.0 specifier: 8.5.0
version: 8.5.0 version: 8.5.0
...@@ -2155,7 +2155,6 @@ packages: ...@@ -2155,7 +2155,6 @@ packages:
/@babel/plugin-proposal-dynamic-import@7.16.7(@babel/core@7.22.5): /@babel/plugin-proposal-dynamic-import@7.16.7(@babel/core@7.22.5):
resolution: {integrity: sha512-I8SW9Ho3/8DRSdmDdH3gORdyUuYnk1m4cMxUAdu5oy4n3OfN8flDEH+d60iG7dUfi0KkYwSvoalHzzdRzpWHTg==} resolution: {integrity: sha512-I8SW9Ho3/8DRSdmDdH3gORdyUuYnk1m4cMxUAdu5oy4n3OfN8flDEH+d60iG7dUfi0KkYwSvoalHzzdRzpWHTg==}
engines: {node: '>=6.9.0'} engines: {node: '>=6.9.0'}
deprecated: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-dynamic-import instead.
peerDependencies: peerDependencies:
'@babel/core': 7.22.5 '@babel/core': 7.22.5
dependencies: dependencies:
...@@ -2166,7 +2165,6 @@ packages: ...@@ -2166,7 +2165,6 @@ packages:
/@babel/plugin-proposal-export-namespace-from@7.16.7(@babel/core@7.22.5): /@babel/plugin-proposal-export-namespace-from@7.16.7(@babel/core@7.22.5):
resolution: {integrity: sha512-ZxdtqDXLRGBL64ocZcs7ovt71L3jhC1RGSyR996svrCi3PYqHNkb3SwPJCs8RIzD86s+WPpt2S73+EHCGO+NUA==} resolution: {integrity: sha512-ZxdtqDXLRGBL64ocZcs7ovt71L3jhC1RGSyR996svrCi3PYqHNkb3SwPJCs8RIzD86s+WPpt2S73+EHCGO+NUA==}
engines: {node: '>=6.9.0'} engines: {node: '>=6.9.0'}
deprecated: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-export-namespace-from instead.
peerDependencies: peerDependencies:
'@babel/core': 7.22.5 '@babel/core': 7.22.5
dependencies: dependencies:
...@@ -2189,7 +2187,6 @@ packages: ...@@ -2189,7 +2187,6 @@ packages:
/@babel/plugin-proposal-logical-assignment-operators@7.16.7(@babel/core@7.22.5): /@babel/plugin-proposal-logical-assignment-operators@7.16.7(@babel/core@7.22.5):
resolution: {integrity: sha512-K3XzyZJGQCr00+EtYtrDjmwX7o7PLK6U9bi1nCwkQioRFVUv6dJoxbQjtWVtP+bCPy82bONBKG8NPyQ4+i6yjg==} resolution: {integrity: sha512-K3XzyZJGQCr00+EtYtrDjmwX7o7PLK6U9bi1nCwkQioRFVUv6dJoxbQjtWVtP+bCPy82bONBKG8NPyQ4+i6yjg==}
engines: {node: '>=6.9.0'} engines: {node: '>=6.9.0'}
deprecated: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-logical-assignment-operators instead.
peerDependencies: peerDependencies:
'@babel/core': 7.22.5 '@babel/core': 7.22.5
dependencies: dependencies:
...@@ -2211,7 +2208,6 @@ packages: ...@@ -2211,7 +2208,6 @@ packages:
/@babel/plugin-proposal-numeric-separator@7.16.7(@babel/core@7.22.5): /@babel/plugin-proposal-numeric-separator@7.16.7(@babel/core@7.22.5):
resolution: {integrity: sha512-vQgPMknOIgiuVqbokToyXbkY/OmmjAzr/0lhSIbG/KmnzXPGwW/AdhdKpi+O4X/VkWiWjnkKOBiqJrTaC98VKw==} resolution: {integrity: sha512-vQgPMknOIgiuVqbokToyXbkY/OmmjAzr/0lhSIbG/KmnzXPGwW/AdhdKpi+O4X/VkWiWjnkKOBiqJrTaC98VKw==}
engines: {node: '>=6.9.0'} engines: {node: '>=6.9.0'}
deprecated: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-numeric-separator instead.
peerDependencies: peerDependencies:
'@babel/core': 7.22.5 '@babel/core': 7.22.5
dependencies: dependencies:
...@@ -2261,7 +2257,6 @@ packages: ...@@ -2261,7 +2257,6 @@ packages:
/@babel/plugin-proposal-private-methods@7.16.11(@babel/core@7.22.5): /@babel/plugin-proposal-private-methods@7.16.11(@babel/core@7.22.5):
resolution: {integrity: sha512-F/2uAkPlXDr8+BHpZvo19w3hLFKge+k75XUprE6jaqKxjGkSYcK+4c+bup5PdW/7W/Rpjwql7FTVEDW+fRAQsw==} resolution: {integrity: sha512-F/2uAkPlXDr8+BHpZvo19w3hLFKge+k75XUprE6jaqKxjGkSYcK+4c+bup5PdW/7W/Rpjwql7FTVEDW+fRAQsw==}
engines: {node: '>=6.9.0'} engines: {node: '>=6.9.0'}
deprecated: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-private-methods instead.
peerDependencies: peerDependencies:
'@babel/core': 7.22.5 '@babel/core': 7.22.5
dependencies: dependencies:
...@@ -25573,8 +25568,8 @@ packages: ...@@ -25573,8 +25568,8 @@ packages:
/zwitch@2.0.4: /zwitch@2.0.4:
resolution: {integrity: sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==} resolution: {integrity: sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==}
'@gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240417.1': '@gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240422.2':
resolution: {tarball: https://gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240417.1} resolution: {tarball: https://gitpkg-fork.vercel.sh/vercel/turbo/crates/turbopack-ecmascript-runtime/js?turbopack-240422.2}
name: '@vercel/turbopack-ecmascript-runtime' name: '@vercel/turbopack-ecmascript-runtime'
version: 0.0.0 version: 0.0.0
dependencies: dependencies:
......
## Hello MDX
Here's a simple gfm mdx file!!
| foo | bar |
| --- | --- |
| baz | bim |
/* eslint-env jest */ /* eslint-env jest */
import { join } from 'path' import { join } from 'path'
import { renderViaHTTP, findPort, launchApp, killApp } from 'next-test-utils' import {
renderViaHTTP,
findPort,
launchApp,
killApp,
File,
} from 'next-test-utils'
const appDir = join(__dirname, '..')
const context = {} const context = {}
describe('MDX-rs Configuration', () => { describe('MDX-rs Configuration', () => {
beforeAll(async () => {
context.appPort = await findPort()
context.server = await launchApp(join(__dirname, '../'), context.appPort)
})
afterAll(() => {
killApp(context.server)
})
describe('MDX-rs Plugin support', () => { describe('MDX-rs Plugin support', () => {
beforeAll(async () => {
context.appPort = await findPort()
context.server = await launchApp(join(__dirname, '../'), context.appPort)
})
afterAll(() => {
killApp(context.server)
})
it('should render an MDX page correctly', async () => { it('should render an MDX page correctly', async () => {
expect(await renderViaHTTP(context.appPort, '/')).toMatch(/Hello MDX/) expect(await renderViaHTTP(context.appPort, '/')).toMatch(/Hello MDX/)
}) })
...@@ -31,4 +37,38 @@ describe('MDX-rs Configuration', () => { ...@@ -31,4 +37,38 @@ describe('MDX-rs Configuration', () => {
) )
}) })
}) })
describe('MDX-rs Plugin support with mdx transform options', () => {
let nextConfig
beforeAll(async () => {
nextConfig = new File(join(appDir, 'next.config.js'))
nextConfig.write(`
const withMDX = require('@next/mdx')({
extension: /\\.mdx?$/,
})
module.exports = withMDX({
pageExtensions: ['js', 'jsx', 'mdx'],
experimental: {
mdxRs: {
mdxType: 'gfm'
},
},
})
`)
context.appPort = await findPort()
context.server = await launchApp(join(__dirname, '../'), context.appPort)
})
afterAll(() => {
killApp(context.server)
nextConfig.restore()
})
it('should render an MDX page correctly', async () => {
expect(await renderViaHTTP(context.appPort, '/gfm')).toMatch(
/<table>\n<thead>\n<tr>\n<th>foo/
)
})
})
}) })
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment