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

docs: advise users of create-next-app --ts, --typescript #25349

Merged
merged 4 commits into from
Jun 11, 2021

Conversation

ctjlewis
Copy link
Contributor

@ctjlewis ctjlewis commented May 22, 2021

Since #24655 landed in 10.2.1, I wanted to update the documentation, especially for the top Google results for "next typescript", so that users know how to create a TS project.

Please feel free to change anything you feel is appropriate.

@ijjk ijjk added the create-next-app Related to our CLI tool for quickly starting a new Next.js application. label May 22, 2021
@ijjk

This comment has been minimized.

timneutkens
timneutkens previously approved these changes May 23, 2021
@timneutkens
Copy link
Member

Looks like the linting failed

@ctjlewis
Copy link
Contributor Author

@timneutkens - sorry, my bad, one second.

@ctjlewis
Copy link
Contributor Author

That should be good. Apologies. When this goes live, people will probably start using the feature, so feel free to tag me in any issues that might come up.

Copy link
Member

@timneutkens timneutkens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No worries! looks good 👍

@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Jun 11, 2021

Stats from current PR

Default Server Mode (Decrease detected ✓)
General
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
buildDuration 11.9s 11.8s -36ms
buildDurationCached 2.9s 3s ⚠️ +103ms
nodeModulesSize 46.5 MB 46.5 MB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
/ failed reqs 0 0
/ total time (seconds) 2.389 2.388 0
/ avg req/sec 1046.4 1046.73 +0.33
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.192 1.2 ⚠️ +0.01
/error-in-render avg req/sec 2098.02 2082.95 ⚠️ -15.07
Client Bundles (main, webpack, commons)
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
framework-HASH.js gzip 39.3 kB 39.3 kB
main-HASH.js gzip 20.2 kB 20.2 kB
webpack-HASH.js gzip 804 B 804 B
Overall change 60.3 kB 60.3 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
polyfills-HASH.js gzip 31.1 kB 31.1 kB
Overall change 31.1 kB 31.1 kB
Client Pages
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
_app-HASH.js gzip 801 B 801 B
_error-HASH.js gzip 3.07 kB 3.07 kB
amp-HASH.js gzip 527 B 527 B
css-HASH.js gzip 334 B 334 B
hooks-HASH.js gzip 890 B 890 B
index-HASH.js gzip 263 B 263 B
link-HASH.js gzip 1.64 kB 1.64 kB
routerDirect..HASH.js gzip 333 B 333 B
withRouter-HASH.js gzip 330 B 330 B
bb14e60e810b..30f.css gzip 125 B 125 B
Overall change 8.31 kB 8.31 kB
Client Build Manifests
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
_buildManifest.js gzip 392 B 392 B
Overall change 392 B 392 B
Rendered Page Sizes
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
index.html gzip 574 B 574 B
link.html gzip 581 B 581 B
withRouter.html gzip 569 B 569 B
Overall change 1.72 kB 1.72 kB

Serverless Mode
General
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
buildDuration 14s 13.7s -311ms
buildDurationCached 4s 4.1s ⚠️ +118ms
nodeModulesSize 46.5 MB 46.5 MB
Client Bundles (main, webpack, commons)
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
framework-HASH.js gzip 39.3 kB 39.3 kB
main-HASH.js gzip 20.2 kB 20.2 kB
webpack-HASH.js gzip 804 B 804 B
Overall change 60.3 kB 60.3 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
polyfills-HASH.js gzip 31.1 kB 31.1 kB
Overall change 31.1 kB 31.1 kB
Client Pages
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
_app-HASH.js gzip 801 B 801 B
_error-HASH.js gzip 3.07 kB 3.07 kB
amp-HASH.js gzip 527 B 527 B
css-HASH.js gzip 334 B 334 B
hooks-HASH.js gzip 890 B 890 B
index-HASH.js gzip 263 B 263 B
link-HASH.js gzip 1.64 kB 1.64 kB
routerDirect..HASH.js gzip 333 B 333 B
withRouter-HASH.js gzip 330 B 330 B
bb14e60e810b..30f.css gzip 125 B 125 B
Overall change 8.31 kB 8.31 kB
Client Build Manifests
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
_buildManifest.js gzip 392 B 392 B
Overall change 392 B 392 B
Serverless bundles
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
_error.js 16.9 kB 16.9 kB ⚠️ +2 B
404.html 2.44 kB 2.44 kB
500.html 2.43 kB 2.43 kB
amp.amp.html 10.8 kB 10.8 kB
amp.html 1.63 kB 1.63 kB
css.html 1.81 kB 1.81 kB
hooks.html 1.69 kB 1.69 kB
index.js 17.2 kB 17.2 kB -2 B
link.js 17.4 kB 17.4 kB -2 B
routerDirect.js 17.4 kB 17.4 kB
withRouter.js 17.4 kB 17.4 kB ⚠️ +2 B
Overall change 107 kB 107 kB

Webpack 4 Mode (Decrease detected ✓)
General
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
buildDuration 11.1s 10.7s -418ms
buildDurationCached 4.6s 4.4s -228ms
nodeModulesSize 46.5 MB 46.5 MB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
/ failed reqs 0 0
/ total time (seconds) 2.42 2.481 ⚠️ +0.06
/ avg req/sec 1032.99 1007.73 ⚠️ -25.26
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.266 1.282 ⚠️ +0.02
/error-in-render avg req/sec 1975.44 1949.98 ⚠️ -25.46
Client Bundles (main, webpack, commons)
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
677f882d2ed8..HASH.js gzip 13.4 kB 13.4 kB
framework.HASH.js gzip 39 kB 39 kB
main-HASH.js gzip 7.99 kB 7.99 kB
webpack-HASH.js gzip 751 B 751 B
Overall change 61.1 kB 61.1 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
polyfills-HASH.js gzip 31.3 kB 31.3 kB
Overall change 31.3 kB 31.3 kB
Client Pages
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
_app-HASH.js gzip 1.07 kB 1.07 kB
_error-HASH.js gzip 3.74 kB 3.74 kB
amp-HASH.js gzip 536 B 536 B
css-HASH.js gzip 339 B 339 B
hooks-HASH.js gzip 887 B 887 B
index-HASH.js gzip 227 B 227 B
link-HASH.js gzip 1.63 kB 1.63 kB
routerDirect..HASH.js gzip 303 B 303 B
withRouter-HASH.js gzip 302 B 302 B
e025d2764813..52f.css gzip 125 B 125 B
Overall change 9.17 kB 9.17 kB
Client Build Manifests
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
_buildManifest.js gzip 420 B 420 B
Overall change 420 B 420 B
Rendered Page Sizes
vercel/next.js canary ctjlewis/next.js create-next-app-typescript-docs Change
index.html gzip 627 B 627 B
link.html gzip 633 B 633 B
withRouter.html gzip 619 B 619 B
Overall change 1.88 kB 1.88 kB
Commit: 0a0976c

@kodiakhq kodiakhq bot merged commit eddf5e0 into vercel:canary Jun 11, 2021
janicklas-ralph pushed a commit to janicklas-ralph/next.js that referenced this pull request Jun 11, 2021
)

Since vercel#24655 landed in 10.2.1, I wanted to update the documentation, especially for the top Google results for "next typescript", so that users know how to create a TS project.

Please feel free to change anything you feel is appropriate.
flybayer pushed a commit to blitz-js/next.js that referenced this pull request Jun 16, 2021
)

Since vercel#24655 landed in 10.2.1, I wanted to update the documentation, especially for the top Google results for "next typescript", so that users know how to create a TS project.

Please feel free to change anything you feel is appropriate.
@vercel vercel locked as resolved and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
create-next-app Related to our CLI tool for quickly starting a new Next.js application.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants