-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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: Remove display
key from generated tsconfig
#9225
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
8 Skipped Deployments
|
@Sensanaty is attempting to deploy a commit to the Vercel Team on Vercel. A member of the Team first needs to authorize it. |
display
key from package.json
& tsconfig
display
key from generated tsconfig
As a mental note, I just verified that TypeScript doesn't verify extra keys at the top-level of That for me helps to confirm that this was in the initial template from 3 years ago, kept getting copy-pasted and, since it never hurt anything, no one questioned it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Looks right to me.
Out of an abundance of caution, I've asked the rest of the team if anyone has any secret sage wisdom about why this key might be in these, just in case there's something I'm not realizing. I don't think this will be the case, but I'll come back and merge later today assuming I don't hear any objections.
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
1 similar comment
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Talked to colleagues and they're good with this, too!
The CI failures here are not related to these changes. I will fix in a separate PR.
Thank you for your contribution! 🚀
Description
#9221
I noticed that the default
create-turbo
command would createtsconfig
s that contained adisplay
key, which isn't part of the TS schema spec.I opened a discussion to ask about this, because it might've been a Turbo-specific feature, for example I thought it was maybe used to display the list of projects in the repo in a nice human-readable way, but according to Anthony it's not actually used for anything.
From a quick read through of the
create-turbo
code, what I gathered is that it basically just copies these files based on the hardcoded example repos, hence why I only modified thetsconfig
s themselves. It's possible I missed something as this is my first time interacting with this codebase (and the worddisplay
is generic enough that it shows up in a billion places all over the code), so please do let me know if my assumption here was wrong.Testing Instructions
create-turbo
tsconfig
s should no longer contain thedisplay
key.