feat: support `pnpm` with `create-next-app` #34947

balazsorban44 · 2022-03-02T01:44:33Z

Closes #21653, closes #27259.

Both were slightly outdated, had merge conflicts and lacked tests, and did not have documentation.

This PR adds both tests and documentation, and I also verified it running locally. 👍

Bug

Related issues linked using fixes #number
Integration tests added
Errors have helpful link attached, see contributing.md

Feature

Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
Related issues linked using fixes #number
Integration tests added
Documentation added
Telemetry added. In case of a feature if it's used or not.
Errors have helpful link attached, see contributing.md

Documentation / Examples

Make sure the linting passes by running yarn lint

balazsorban44 · 2022-03-02T02:33:56Z

~~Not sure why tests are failing, they all pass locally 🤔 Might be a CI issue?~~

It was mostly a me issue. 🤦 😅

packages/create-next-app/index.ts

test/integration/create-next-app/index.test.ts

Co-authored-by: Steven <steven@ceriously.com>

styfle

Thanks!

ijjk · 2022-03-03T01:11:23Z

Failing test suites

Commit: a72a32c

yarn testheadless test/integration/create-next-app/index.test.ts

create next app > should support typescript flag

Expand output

● create next app › should support typescript flag

expect(received).toBeTruthy()

Received: false

  126 |
  127 |       files.forEach((file) =>
> 128 |         expect(fs.existsSync(path.join(cwd, projectName, file))).toBeTruthy()
      |                                                                  ^
  129 |       )
  130 |
  131 |       const pkgJSONPath = path.join(cwd, projectName, 'package.json')

  at forEach (integration/create-next-app/index.test.ts:128:66)
      at Array.forEach (<anonymous>)
  at integration/create-next-app/index.test.ts:127:13
  at usingTempDir (integration/create-next-app/index.test.ts:19:5)
  at Object.<anonymous> (integration/create-next-app/index.test.ts:103:5)

Read more about building and testing Next.js in contributing.md.

ijjk · 2022-03-03T02:14:47Z

Stats from current PR

Default Build (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
buildDuration	15.2s	15.3s	⚠️ +58ms
buildDurationCached	6.1s	6s	-73ms
nodeModulesSize	372 MB	372 MB	⚠️ +8 B

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.94	2.929	-0.01
/ avg req/sec	850.27	853.6	+3.33
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.194	1.204	⚠️ +0.01
/error-in-render avg req/sec	2093.04	2076.45	⚠️ -16.59

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
925.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42 kB	42 kB	✓
main-HASH.js gzip	27.9 kB	27.9 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	71.5 kB	71.5 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
_app-HASH.js gzip	1.36 kB	1.36 kB	✓
_error-HASH.js gzip	192 B	192 B	✓
amp-HASH.js gzip	309 B	309 B	✓
css-HASH.js gzip	327 B	327 B	✓
dynamic-HASH.js gzip	2.57 kB	2.57 kB	✓
head-HASH.js gzip	351 B	351 B	✓
hooks-HASH.js gzip	920 B	920 B	✓
image-HASH.js gzip	5.06 kB	5.06 kB	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	2.26 kB	2.26 kB	✓
routerDirect..HASH.js gzip	320 B	320 B	✓
script-HASH.js gzip	387 B	387 B	✓
withRouter-HASH.js gzip	319 B	319 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	14.8 kB	14.8 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
_buildManifest.js gzip	460 B	460 B	✓
Overall change	460 B	460 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
index.html gzip	532 B	532 B	✓
link.html gzip	545 B	545 B	✓
withRouter.html gzip	525 B	525 B	✓
Overall change	1.6 kB	1.6 kB	✓

Default Build with SWC (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
buildDuration	18.6s	18.4s	-233ms
buildDurationCached	6s	6s	⚠️ +8ms
nodeModulesSize	372 MB	372 MB	⚠️ +8 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.909	2.903	-0.01
/ avg req/sec	859.48	861.09	+1.61
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.194	1.174	-0.02
/error-in-render avg req/sec	2093.4	2129.63	+36.23

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
925.HASH.js gzip	178 B	178 B	✓
framework-HASH.js gzip	42.3 kB	42.3 kB	✓
main-HASH.js gzip	28.1 kB	28.1 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	72.1 kB	72.1 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
_app-HASH.js gzip	1.36 kB	1.36 kB	✓
_error-HASH.js gzip	179 B	179 B	✓
amp-HASH.js gzip	313 B	313 B	✓
css-HASH.js gzip	324 B	324 B	✓
dynamic-HASH.js gzip	2.56 kB	2.56 kB	✓
head-HASH.js gzip	351 B	351 B	✓
hooks-HASH.js gzip	921 B	921 B	✓
image-HASH.js gzip	5.2 kB	5.2 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	2.33 kB	2.33 kB	✓
routerDirect..HASH.js gzip	322 B	322 B	✓
script-HASH.js gzip	388 B	388 B	✓
withRouter-HASH.js gzip	317 B	317 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	14.9 kB	14.9 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
_buildManifest.js gzip	458 B	458 B	✓
Overall change	458 B	458 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js feat/create-next-app-pnpm	Change
index.html gzip	530 B	530 B	✓
link.html gzip	543 B	543 B	✓
withRouter.html gzip	525 B	525 B	✓
Overall change	1.6 kB	1.6 kB	✓

Commit: 906494b

leerob · 2022-03-05T02:08:06Z

packages/create-next-app/README.md

@@ -26,6 +26,7 @@ npx create-next-app blog-app
 - **-e, --example [name]|[github-url]** - An example to bootstrap the app with. You can use an example name from the [Next.js repo](https://github.com/vercel/next.js/tree/canary/examples) or a GitHub URL. The URL can use any branch and/or subdirectory.
 - **--example-path &lt;path-to-example&gt;** - In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: `--example-path foo/bar`
 - **--use-npm** - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we recommend to run `yarn create next-app`
+- **--use-pnpm** - Explicitly tell the CLI to bootstrap the app using pnpm. To bootstrap using yarn we recommend running `yarn create next-app`


"To bootstrap using yarn"...

is that accurate?

Our default is yarn right now. 👍 So if no --use-npm or --use-pnpm flags are defined, we are falling back to Yarn.

This fixes our package manager detection which was changed slightly in #34947 for `pnpm` support to ensure the default case still attempts detecting the available package manager if no preference is specified in the command args. This also adds a test case to ensure the install succeeds when we fail to detect a valid `yarn` binary and no preference is set via the `npm_config_user_agent` env variable. ## Bug - [x] Related issues linked using `fixes #number` - [x] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` Fixes: #35607 Fixes: #35599

balazsorban44 added 3 commits March 2, 2022 02:37

feat: support pnpm with create-next-app

84a072a

test: add --use-pnpm tests

c0fd7a8

docs: mention --use-pnpm flag in docs

dafdfce

balazsorban44 requested review from timneutkens, ijjk, shuding, styfle, huozhi, padmaia and leerob as code owners March 2, 2022 01:44

ijjk added create-next-app Related to our CLI tool for quickly starting a new Next.js application. area: documentation labels Mar 2, 2022

This comment has been minimized.

Sign in to view

test: remove only

64f9df1

This comment has been minimized.

Sign in to view

styfle reviewed Mar 2, 2022

View reviewed changes

packages/create-next-app/index.ts Show resolved Hide resolved

styfle reviewed Mar 2, 2022

View reviewed changes

test/integration/create-next-app/index.test.ts Outdated Show resolved Hide resolved

Update test/integration/create-next-app/index.test.ts

219620e

Co-authored-by: Steven <steven@ceriously.com>

styfle previously approved these changes Mar 2, 2022

View reviewed changes

This comment has been minimized.

Sign in to view

chore: add pnpm action setup to tests

96853c5

balazsorban44 dismissed styfle’s stale review via 96853c5 March 3, 2022 00:14

chore: use latest pnpm

289ece8

This comment has been minimized.

Sign in to view

chore: debug

d40bb65

This comment has been minimized.

Sign in to view

chore: debug

a72a32c

This comment has been minimized.

Sign in to view

balazsorban44 added 2 commits March 3, 2022 02:31

fix: fall back to yarn instead of npm

342bb61

test: run all tests

4a53801

balazsorban44 requested a review from styfle March 3, 2022 01:35

This comment has been minimized.

Sign in to view

Merge branch 'canary' into feat/create-next-app-pnpm

906494b

styfle approved these changes Mar 3, 2022

View reviewed changes

balazsorban44 merged commit 62c33c1 into canary Mar 3, 2022

balazsorban44 deleted the feat/create-next-app-pnpm branch March 3, 2022 23:49

leerob reviewed Mar 5, 2022

View reviewed changes

ijjk mentioned this pull request Mar 26, 2022

Fix create-next-app failing without yarn installed #35608

Merged

3 tasks

yeskunall mentioned this pull request Mar 27, 2022

npx create-next-app@latest not working #35623

Closed

1 task

github-actions bot locked as resolved and limited conversation to collaborators Apr 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support `pnpm` with `create-next-app` #34947

feat: support `pnpm` with `create-next-app` #34947

balazsorban44 commented Mar 2, 2022

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

balazsorban44 commented Mar 2, 2022 •

edited

styfle left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Mar 3, 2022

This comment has been minimized.

This comment has been minimized.

ijjk commented Mar 3, 2022

leerob Mar 5, 2022

balazsorban44 Mar 5, 2022

feat: support pnpm with create-next-app #34947

feat: support pnpm with create-next-app #34947

Conversation

balazsorban44 commented Mar 2, 2022

Bug

Feature

Documentation / Examples

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

balazsorban44 commented Mar 2, 2022 • edited

styfle left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Mar 3, 2022

Failing test suites

This comment has been minimized.

This comment has been minimized.

ijjk commented Mar 3, 2022

Stats from current PR

leerob Mar 5, 2022

Choose a reason for hiding this comment

balazsorban44 Mar 5, 2022

Choose a reason for hiding this comment

feat: support `pnpm` with `create-next-app` #34947

feat: support `pnpm` with `create-next-app` #34947

balazsorban44 commented Mar 2, 2022 •

edited