Skip to content

Commit

Permalink
Turbopack experimental fields docs and schema (#45560)
Browse files Browse the repository at this point in the history
This adds:
- Documentation for Turbopack experimental fields `turbopackLoaders` and `resolveAlias` to the API reference site.
- Typings and schema for the above Turbopack experimental options

Test Plan: 
- `pnpm build`, updated an example to use TypeScript for its Next.js config, and verified the config passed with matching shapes and failed with mismatching shapes.
  • Loading branch information
wbinnssmith authored Feb 8, 2023
1 parent 53c2ae8 commit d726fe3
Show file tree
Hide file tree
Showing 5 changed files with 121 additions and 6 deletions.
70 changes: 70 additions & 0 deletions docs/api-reference/next.config.js/turbopack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
description: Configure Next.js with Turbopack-specific options
---

# Turbopack-specific options (experimental)

> **Warning**: These features are experimental and will only work with `next --turbo`.
## webpack loaders

Currently, Turbopack supports a subset of webpack's loader API, allowing you to use some webpack loaders to transform code in Turbopack.

To configure loaders, add the names of the loaders you've installed and any options in `next.config.js`, mapping file extensions to a list of loaders:

```js
module.exports = {
experimental: {
turbo: {
loaders: {
// Option format
'.md': [
{
loader: '@mdx-js/loader',
options: {
format: 'md',
},
},
],
// Option-less format
'.mdx': '@mdx-js/loader',
},
},
},
}
```

Then, given the above configuration, you can use transformed code from your app:

```js
import MyDoc from './my-doc.mdx'

export default function Home() {
return <MyDoc />
}
```

## Resolve Alias

Through `next.config.js`, Turbopack can be configured to modify module resolution through aliases, similar to webpack's [`resolve.alias`](https://webpack.js.org/configuration/resolve/#resolvealias) configuration.

To configure resolve aliases, map imported patterns to their new destination in `next.config.js`:

```js
module.exports = {
experimental: {
turbo: {
resolveAlias: {
underscore: 'lodash',
mocha: { browser: 'mocha/browser-entry.js' },
},
},
},
}
```

This aliases imports of the `underscore` package to the `lodash` package. In other words, `import underscore from 'underscore'` will load the `lodash` module instead of `underscore`.

Turbopack also supports conditional aliasing through this field, similar to Node.js's [conditional exports](https://nodejs.org/docs/latest-v18.x/api/packages.html#conditional-exports). At the moment only the `browser` condition is supported. In the case above, imports of the `mocha` module will be aliased to `mocha/browser-entry.js` when Turbopack targets browser environments.

For more information and guidance for how to migrate your app to Turbopack from webpack, see [Turbopack's documentation on webpack compatibility](https://turbo.build/pack/docs/migrating-from-webpack).
4 changes: 4 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,10 @@
{
"title": "Build indicator",
"path": "/docs/api-reference/next.config.js/build-indicator.md"
},
{
"title": "Turbopack-specific options",
"path": "/docs/api-reference/next.config.js/turbopack.md"
}
]
}
Expand Down
3 changes: 1 addition & 2 deletions packages/next/src/cli/next-dev.ts
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,8 @@ const nextDev: CliCommand = async (argv) => {
'configFileName',
'env',
'experimental.appDir',
'experimental.resolveAlias',
'experimental.serverComponentsExternalPackages',
'experimental.turbopackLoaders',
'experimental.turbo',
'images',
'pageExtensions',
'onDemandEntries',
Expand Down
11 changes: 10 additions & 1 deletion packages/next/src/server/config-schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -441,8 +441,17 @@ const configSchema = {
webpackBuildWorker: {
type: 'boolean',
},
turbopackLoaders: {
turbo: {
type: 'object',
additionalProperties: false,
properties: {
loaders: {
type: 'object',
},
resolveAlias: {
type: 'object',
},
},
},
turbotrace: {
type: 'object',
Expand Down
39 changes: 36 additions & 3 deletions packages/next/src/server/config-shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,40 @@ export interface TypeScriptConfig {
tsconfigPath?: string
}

type JSONValue =
| string
| number
| boolean
| JSONValue[]
| { [k: string]: JSONValue }

type TurboLoaderItem =
| string
| {
loader: string
// At the moment, Turbopack options must be JSON-serializable, so restrict values.
options: Record<string, JSONValue>
}

interface ExperimentalTurboOptions {
/**
* (`next --turbo` only) A mapping of aliased imports to modules to load in their place.
*
* @see [Resolve Alias](https://nextjs.org/docs/api-reference/next.config.js/resolve-alias)
*/
resolveAlias?: Record<
string,
string | string[] | Record<string, string | string[]>
>

/**
* (`next --turbo` only) A list of webpack loaders to apply when running with Turbopack.
*
* @see [Turbopack Loaders](https://nextjs.org/docs/api-reference/next.config.js/turbopack-loaders)
*/
loaders?: Record<string, TurboLoaderItem[]>
}

export interface WebpackConfigContext {
/** Next.js root directory */
dir: string
Expand Down Expand Up @@ -157,9 +191,7 @@ export interface ExperimentalConfig {

webVitalsAttribution?: Array<typeof WEB_VITALS[number]>

// webpack loaders to use when running turbopack
turbopackLoaders?: Record<string, string | string[]>

turbo?: ExperimentalTurboOptions
turbotrace?: {
logLevel?:
| 'bug'
Expand Down Expand Up @@ -625,6 +657,7 @@ export const defaultConfig: NextConfig = {
enableUndici: false,
adjustFontFallbacks: false,
adjustFontFallbacksWithSizeAdjust: false,
turbo: undefined,
turbotrace: undefined,
},
}
Expand Down

0 comments on commit d726fe3

Please sign in to comment.