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

next-env.d.ts note in templates #27983

Merged
merged 9 commits into from Aug 12, 2021
Merged

Conversation

oBusk
Copy link
Contributor

@oBusk oBusk commented Aug 11, 2021

Hello! I was using npx create-next-app --ts to quickly bootstrap a basic next.js project with Typescript. It bothered me that I got git diff just from running npm run build inside the project, because the new notice in the next-env.d.ts file.

image

So I went ahead and updated the next-env.d.ts file in packages/create-next-app/templates/typescript to be exactly how the file looks after running once. (7417ecc)

Then I realized that I could probably do the same for all the next-env.d.ts that are spread out in the many examples, to make running those examples after cloning them feel a bit smoother. (fb67ce9)

However I skipped the with-typescript-graphql example since that next-env.d.ts actually has changes and I couldn't even run yarn build in that example, so I'm not sure what will happen with the next-env.d.ts. Someone who gets that example will have to fix it I suppose.

To avoid git diff after just running `npm run build` after using `create-next-app`.
@ijjk ijjk added create-next-app Related to our CLI tool for quickly starting a new Next.js application. examples Issue/PR related to examples labels Aug 11, 2021
@ijjk

This comment has been minimized.

@oBusk
Copy link
Contributor Author

oBusk commented Aug 11, 2021

I felt like there could probably be an automated check so that templates would include the most recent version but I don't know where that would fit..

Just looking around in the repo it looks like it could fit in the check-examples.sh script, but I can't see when that script is run?

Updating the loop where it goes through every example

for folder in examples/* ; do
  cp -n packages/create-next-app/templates/default/gitignore $folder/.gitignore;
  if [ -f "$folder/package.json" ]; then
    cat $folder/package.json | jq '.license = "MIT"' | sponge $folder/package.json
  fi
  if [ -f "$folder/next-env.d.ts" ]; then
    cp packages/create-next-app/templates/typescript/next-env.d.ts $folder/next-env.d.ts
  fi
done;

@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@oBusk
Copy link
Contributor Author

oBusk commented Aug 12, 2021

I fixed (c5450e1) the with-graphql-typescript .d.ts problem.

Also, in the spirit of seatbelt and airbag, I updated create-next-app to always copy the default next-env.d.ts whenever you create-next-app with an --example that is typescript (has tsconfig.json). That way, if example is added in the future that does not check in an uptodate next-env.d.ts, create-next-app will fix that for you.

@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Aug 12, 2021

Failing test suites

Commit: 7b2a3f3

test/acceptance/ReactRefreshLogBox.dev.test.js

  • server-side only compilation errors

Expand output

● server-side only compilation errors

ScriptTimeoutError: script timeout
  (Session info: headless chrome=92.0.4515.131)

  72 |
  73 |             // Wait for application to re-hydrate:
> 74 |             await browser.executeAsyncScript(function () {
     |             ^
  75 |               var callback = arguments[arguments.length - 1]
  76 |               if (window.__NEXT_HYDRATED) {
  77 |                 callback()

  at Object.throwDecodedError (../node_modules/selenium-webdriver/lib/error.js:550:15)
  at parseHttpResponse (../node_modules/selenium-webdriver/lib/http.js:565:13)
  at Executor.execute (../node_modules/selenium-webdriver/lib/http.js:491:26)
      at runMicrotasks (<anonymous>)
  at Proxy.execute (../node_modules/selenium-webdriver/lib/webdriver.js:700:17)
  at Object.patch (acceptance/helpers.js:74:13)
  at Object.<anonymous> (acceptance/ReactRefreshLogBox.dev.test.js:1422:3)

@ijjk

This comment has been minimized.

Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

Thanks!

@ijjk
Copy link
Member

ijjk commented Aug 12, 2021

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall decrease ✓
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
buildDuration 14.7s 14.5s -246ms
buildDurationCached 3.5s 3.3s -247ms
nodeModulesSize 49.1 MB 49.1 MB -2 B
Page Load Tests Overall increase ✓
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
/ failed reqs 0 0
/ total time (seconds) 2.904 2.742 -0.16
/ avg req/sec 860.79 911.58 +50.79
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.756 1.717 -0.04
/error-in-render avg req/sec 1423.77 1456.35 +32.58
Client Bundles (main, webpack, commons)
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
745.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 23.1 kB 23.1 kB
webpack-HASH.js gzip 1.5 kB 1.5 kB
Overall change 67 kB 67 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary oBusk/next.js next-env-note-in-examples 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 oBusk/next.js next-env-note-in-examples Change
_app-HASH.js gzip 980 B 980 B
_error-HASH.js gzip 194 B 194 B
amp-HASH.js gzip 312 B 312 B
css-HASH.js gzip 329 B 329 B
dynamic-HASH.js gzip 2.52 kB 2.52 kB
head-HASH.js gzip 350 B 350 B
hooks-HASH.js gzip 904 B 904 B
image-HASH.js gzip 4.13 kB 4.13 kB
index-HASH.js gzip 261 B 261 B
link-HASH.js gzip 1.66 kB 1.66 kB
routerDirect..HASH.js gzip 319 B 319 B
script-HASH.js gzip 387 B 387 B
withRouter-HASH.js gzip 320 B 320 B
bb14e60e810b..30f.css gzip 125 B 125 B
Overall change 12.8 kB 12.8 kB
Client Build Manifests
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
_buildManifest.js gzip 491 B 491 B
Overall change 491 B 491 B
Rendered Page Sizes
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
index.html gzip 532 B 532 B
link.html gzip 544 B 544 B
withRouter.html gzip 525 B 525 B
Overall change 1.6 kB 1.6 kB

Webpack 4 Mode (Increase detected ⚠️)
General Overall decrease ✓
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
buildDuration 12.7s 12.3s -399ms
buildDurationCached 4.8s 4.7s -67ms
nodeModulesSize 49.1 MB 49.1 MB -2 B
Page Load Tests Overall increase ✓
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
/ failed reqs 0 0
/ total time (seconds) 2.819 2.736 -0.08
/ avg req/sec 886.81 913.77 +26.96
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.73 1.683 -0.05
/error-in-render avg req/sec 1445 1485.51 +40.51
Client Bundles (main, webpack, commons)
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
17.HASH.js gzip 185 B 185 B
677f882d2ed8..HASH.js gzip 14 kB 14 kB
framework.HASH.js gzip 41.9 kB 41.9 kB
main-HASH.js gzip 10.6 kB 10.6 kB
webpack-HASH.js gzip 1.19 kB 1.19 kB
Overall change 67.8 kB 67.8 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary oBusk/next.js next-env-note-in-examples 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 oBusk/next.js next-env-note-in-examples Change
_app-HASH.js gzip 965 B 965 B
_error-HASH.js gzip 3.71 kB 3.71 kB
amp-HASH.js gzip 552 B 552 B
css-HASH.js gzip 333 B 333 B
dynamic-HASH.js gzip 2.71 kB 2.71 kB
head-HASH.js gzip 2.97 kB 2.97 kB
hooks-HASH.js gzip 911 B 911 B
index-HASH.js gzip 231 B 231 B
link-HASH.js gzip 1.64 kB 1.64 kB
routerDirect..HASH.js gzip 298 B 298 B
script-HASH.js gzip 2.95 kB 2.95 kB
withRouter-HASH.js gzip 294 B 294 B
e025d2764813..52f.css gzip 125 B 125 B
Overall change 17.7 kB 17.7 kB
Client Build Manifests
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
_buildManifest.js gzip 498 B 498 B
Overall change 498 B 498 B
Rendered Page Sizes
vercel/next.js canary oBusk/next.js next-env-note-in-examples Change
index.html gzip 577 B 577 B
link.html gzip 590 B 590 B
withRouter.html gzip 570 B 570 B
Overall change 1.74 kB 1.74 kB
Commit: 1f20f92

@kodiakhq kodiakhq bot merged commit 25df53d into vercel:canary Aug 12, 2021
@oBusk oBusk deleted the next-env-note-in-examples branch August 12, 2021 21:51
@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. examples Issue/PR related to examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants