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

chore: ignore next-env.d.ts #786

Merged
merged 6 commits into from Nov 18, 2022
Merged

chore: ignore next-env.d.ts #786

merged 6 commits into from Nov 18, 2022

Conversation

skuridin
Copy link
Contributor

βœ… Checklist

  • I have followed every step in the contributing guide (updated 2022-10-06).
  • The PR title follows the convention we established conventional-commit
  • I performed a functional test on my final commit

Changelog

Added next-env.d.ts to .gitignore as recommended in Next.js documentation.


Screenshots

image

πŸ’―

@changeset-bot
Copy link

changeset-bot bot commented Nov 17, 2022

πŸ¦‹ Changeset detected

Latest commit: faa2821

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
create-t3-app Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link

vercel bot commented Nov 17, 2022

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Updated
create-t3-app βœ… Ready (Inspect) Visit Preview Nov 18, 2022 at 11:55PM (UTC)

@github-actions github-actions bot added πŸ“Œ area: cli Relates to the CLI πŸ“Œ area: t3-app Relates to the generated T3 App labels Nov 17, 2022
@juliusmarminge
Copy link
Member

Then we can remove this part in the docs maybe?

https://create.t3.gg/en/folder-structure#next-envdts

cc @nexxeln

Copy link
Member

@nexxeln nexxeln left a comment

Choose a reason for hiding this comment

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

Pretty sure the docs are incorrect here. This file is required for TypeScript to work in Next.js and it should not be removed or edited. So if someone clones a project they would have to make this file on their own.

In the latest create-next-app as well this is added and committed in the initial commit.

@juliusmarminge
Copy link
Member

Pretty sure the docs are incorrect here. This file is required for TypeScript to work in Next.js and it should not be removed or edited. So if someone clones a project they would have to make this file on their own.

In the latest create-next-app as well this is added and committed in the initial commit.

Please make this PR to the Next.js repo and fix their docs haha.

It's generated everytime you run dev or build

@nexxeln
Copy link
Member

nexxeln commented Nov 18, 2022

Pretty sure the docs are incorrect here. This file is required for TypeScript to work in Next.js and it should not be removed or edited. So if someone clones a project they would have to make this file on their own.
In the latest create-next-app as well this is added and committed in the initial commit.
Please make this PR to the Next.js repo and fix their docs haha.

It's generated everytime you run dev or build

Oh I didn't know that. But then why does create-next-app put it in initial commit?

@skuridin
Copy link
Contributor Author

Oh I didn't know that. But then why does create-next-app put it in initial commit?

I just created new create-next-app and while the file is present, it is not in the "Initial commit from Create Next App" git commit.

I can only assume it's copied to the new project to avoid surprises from sudden file appearance.

@nexxeln
Copy link
Member

nexxeln commented Nov 18, 2022

Oh I didn't know that. But then why does create-next-app put it in initial commit?

I just created new create-next-app and while the file is present, it is not in the "Initial commit from Create Next App" git commit.

I can only assume it's copied to the new project to avoid surprises from sudden file appearance.

Ah okay that makes sense.

@nexxeln
Copy link
Member

nexxeln commented Nov 18, 2022

Then we can remove this part in the docs maybe?

https://create.t3.gg/en/folder-structure#next-envdts

cc @nexxeln

It's still a file that is being generated, so I think we should keep it

Copy link
Member

@nexxeln nexxeln left a comment

Choose a reason for hiding this comment

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

LGTM

@github-actions
Copy link
Contributor

github-actions bot commented Nov 18, 2022

⚑️ Lighthouse report for the changes in this PR:

Category Score
🟒 Performance 100
🟒 Accessibility 100
🟒 Best practices 100
🟠 SEO 86
🟠 PWA 54

Lighthouse ran on https://create-t3-app-git-fork-skuridin-chore-next-env-gitignore-t3-oss.vercel.app/

@skuridin skuridin deleted the chore/next-env-gitignore branch November 19, 2022 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
πŸ“Œ area: cli Relates to the CLI πŸ“Œ area: t3-app Relates to the generated T3 App
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants