Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include instructions for bun package manager #53590

Merged
merged 7 commits into from
Aug 10, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,10 @@ First, install the dependency:
npm install --save-dev eslint-config-prettier

yarn add --dev eslint-config-prettier

pnpm add --dev eslint-config-prettier

bun add --development eslint-config-prettier
```

Then, add `prettier` to your existing ESLint config:
Expand Down Expand Up @@ -272,6 +276,10 @@ The plugin can be installed normally in your project without needing to run `nex
npm install --save-dev @next/eslint-plugin-next

yarn add --dev @next/eslint-plugin-next

pnpm add --dev @next/eslint-plugin-next

bun add -d @next/eslint-plugin-next
```

This eliminates the risk of collisions or errors that can occur due to importing the same plugin or parser across multiple configurations.
Expand Down
4 changes: 4 additions & 0 deletions docs/02-app/02-api-reference/05-next-config-js/output.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ yarn add sharp
pnpm add sharp
```

```bash filename="Terminal"
bun add sharp
```

## Caveats

- While tracing in monorepo setups, the project directory is used for tracing by default. For `next build packages/web-app`, `packages/web-app` would be the tracing root and any files outside of that folder will not be included. To include files outside of this folder you can set `experimental.outputFileTracingRoot` in your `next.config.js`.
Expand Down
4 changes: 4 additions & 0 deletions docs/02-app/02-api-reference/06-create-next-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ yarn create next-app
pnpm create next-app
```

```bash filename="Terminal"
bunx create-next-app
```

You will then be asked the following prompts:

```bash filename="Terminal"
Expand Down
2 changes: 1 addition & 1 deletion docs/02-app/02-api-reference/08-next-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ To learn more about Telemetry, [please read this document](https://nextjs.org/te
## Next Info

`next info` prints relevant details about the current system which can be used to report Next.js bugs.
This information includes Operating System platform/arch/version, Binaries (Node.js, npm, Yarn, pnpm) and npm package versions (`next`, `react`, `react-dom`).
This information includes Operating System platform/arch/version, Binaries (Node.js, npm, Yarn, pnpm, Bun) and npm package versions (`next`, `react`, `react-dom`).
colinhacks marked this conversation as resolved.
Show resolved Hide resolved

Running the following in your project's root directory:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This documentation explains how you can handle development, server-side, and cli

## Handling Errors in Development

When there is a runtime error during the development phase of your Next.js application, you will encounter an **overlay**. It is a modal that covers the webpage. It is **only** visible when the development server runs using `next dev` via `pnpm dev`, `npm run dev`, or `yarn dev` and will not be shown in production. Fixing the error will automatically dismiss the overlay.
When there is a runtime error during the development phase of your Next.js application, you will encounter an **overlay**. It is a modal that covers the webpage. It is **only** visible when the development server runs using `next dev` via `pnpm dev`, `npm run dev`, `yarn dev`, or `bun run dev` and will not be shown in production. Fixing the error will automatically dismiss the overlay.

Here is an example of an overlay:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ npm i next@latest react@latest react-dom@latest eslint-config-next@latest
yarn add next@latest react@latest react-dom@latest eslint-config-next@latest
# or
pnpm up next react react-dom eslint-config-next --latest
# or
bun add next@latest react@latest react-dom@latest eslint-config-next@latest
```

### v13 Summary
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ npm install next@12
yarn add next@12

pnpm update next@12

bun add next@12
```

### Upgrading to 12.2
Expand All @@ -29,6 +31,8 @@ npm install react@latest react-dom@latest
yarn add react@latest react-dom@latest

pnpm update react@latest react-dom@latest

bun add react@latest react-dom@latest
```

#### SWC replacing Babel
Expand Down