61f56f997c
Some checks failed
Test examples / Test Examples (20) (push) Has been cancelled
Test examples / Test Examples (22) (push) Has been cancelled
Lock Threads / action (push) Has been cancelled
Trigger Release / start (push) Has been cancelled
Stale issue handler / stale (push) Has been cancelled
Update Font Data / create-pull-request (push) Has been cancelled
build-and-deploy / deploy-target (push) Has been cancelled
build-and-deploy / build (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / build-wasm (nodejs) (push) Has been cancelled
build-and-deploy / build-wasm (web) (push) Has been cancelled
build-and-deploy / Deploy preview tarball (push) Has been cancelled
build-and-deploy / Potentially publish release (push) Has been cancelled
build-and-deploy / publish-turbopack-npm-packages (push) Has been cancelled
build-and-deploy / Deploy examples (push) Has been cancelled
build-and-deploy / thank you, build (push) Has been cancelled
build-and-deploy / Upload Turbopack Bytesize metrics to Datadog (push) Has been cancelled
Rspack Next.js development integration tests / Rspack integration tests (push) Has been cancelled
Rspack Next.js production integration tests / Rspack integration tests (push) Has been cancelled
Turbopack Next.js development integration tests / Next.js integration tests (push) Has been cancelled
Turbopack Next.js production integration tests / Next.js integration tests (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack development test manifest (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack production test manifest (push) Has been cancelled
Upload bundler test manifests to areweturboyet.com / Upload test results (push) Has been cancelled
Update React / create-pull-request (push) Has been cancelled
test-e2e-project-reset-cron / reset-test-project (push) Has been cancelled
Notify about the top 15 issues/PRs/feature requests (most reacted) in the last 90 days / run (push) Has been cancelled
39 lines
2.4 KiB
Markdown
39 lines
2.4 KiB
Markdown
# Building
|
|
|
|
You can build Next.js, including all type definitions and packages, with:
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
> [!TIP]
|
|
> Next.js uses [taskr](https://www.npmjs.com/package/taskr) to parallelize the build tasks.
|
|
> The tasks can be found in the [`taskfile.js`](../../packages/next/taskfile.js) file, and each task name refers to the name of the function to execute.
|
|
> For example, `taskr release` will execute the `release()` function in the `taskfile.js` file.
|
|
|
|
The build process consists of the three main tasks:
|
|
|
|
- [Compile the TypeScript sources with SWC](#compile-the-typescript-sources-with-swc)
|
|
- [Bundle the project with Webpack](#bundle-the-project-with-webpack)
|
|
- [Generate the type definitions](#generate-the-type-definitions)
|
|
|
|
### Compile the TypeScript Sources with SWC
|
|
|
|
By default, the latest canary of the `next-swc` binaries will be installed and used to compile the TypeScript sources of the project. These sources are meant to be built inside the `packages/next/dist/...` directory. The outputs will include compiled JavaScript files and source maps.
|
|
|
|
### Bundle the Project with Webpack
|
|
|
|
Based on the outputs of the compilation, the project is then bundled with Webpack. The configuration can be found in the [`next-runtime.webpack-config.js`](../../packages/next/next-runtime.webpack-config.js) file.
|
|
|
|
### Generate the Type Definitions
|
|
|
|
The type definitions are generated using the TypeScript [`tsc`](https://www.typescriptlang.org/docs/handbook/compiler-options.html) compiler. You can build them separately with `pnpm types`. The [`tsconfig.build.json`](../../packages/next/tsconfig.build.json) is used which extends the base [`tsconfig.json`](../../packages/next/tsconfig.json) but excludes test files and other unneeded type definitions.
|
|
|
|
## Working on Turbopack, WASM, and other Rust code
|
|
|
|
If you are actively working on Rust code or you need to test out the most recent Rust code that hasn't been published as a canary yet, you can [install Rust](https://www.rust-lang.org/tools/install) and run `pnpm swc-build-native`.
|
|
|
|
If you want to test out the wasm build locally, you will need to [install wasm-pack](https://rustwasm.github.io/wasm-pack/installer/). Run `pnpm --filter=@next/swc build-wasm --target <wasm_target>` to build and `node ./scripts/setup-wasm.mjs` to copy it into your `node_modules`. Run next with `NODE_OPTIONS='--no-addons'` to force it to use the wasm binary.
|
|
|
|
If you need to clean the project for any reason, use `pnpm clean`.
|