feat: typescript-eslint@v6 #1476

JoshuaKGoldberg · 2023-06-19T13:19:07Z

Closes #1474 (ref: typescript-eslint/typescript-eslint#6760)

✅ 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

Upgraded typescript-eslint to v6, with reworked ESLint configurations.

You can read https://typescript-eslint.io/blog/announcing-typescript-eslint-v6-beta#user-facing-breaking-changes for the rationale behind the config changes. Essentially, the new recommended starter configs are:

"plugin:@typescript-eslint/recommended-type-checked"
"plugin:@typescript-eslint/stylistic-type-checked"

I've commented any changes I suspect you might disagree with inline, for discussion. Would love to know what you all think!

💯

changeset-bot · 2023-06-19T13:19:10Z

🦋 Changeset detected

Latest commit: 8f182d0

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	Minor

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 · 2023-06-19T13:19:12Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
create-t3-app	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 11, 2023 10:37pm

vercel · 2023-06-19T13:19:13Z

@JoshuaKGoldberg is attempting to deploy a commit to the t3-oss Team on Vercel.

A member of the Team first needs to authorize it.

JoshuaKGoldberg · 2023-06-19T13:20:52Z

.eslintrc.cjs

  rules: {
+    "@typescript-eslint/no-explicit-any": "error",


We right now have no-explicit-any moved into the strict config for v6. But I understand you were expecting it to be enabled. I'm now wondering if we should keep it at recommended?

For context, strict is something we recommend for more confident TypeScript users. https://v6--typescript-eslint.netlify.app/linting/configs#strict

so what's the main difference in strictness between

strict-type-checked and the old recommended-requiring-type-checking?

The strict & strict-type-checked rulesets are a lot more opinionated. We phrase them as "Additional strict rules that can also catch bugs but are more opinionated than recommended rules.". In v6 they're supersets of the respective recommended & recommended-type-checked configs.

https://v6--typescript-eslint.netlify.app/rules/?supported-rules=xrecommended-strict shows the rules that are in strict* and not recommended*.

after reading through the list, i would definitely want about 2/3 of the strict rules and am neutral-but-could-be-pushed-positive on the remaining 1/3.

for teams that are less experienced at typescript, i think autofixing where possible + good documentation for the errors could move quite a few of the rules into "reasonable for most teams" territory.

what is the motivation for moving no-explicit-any to the strict rules?

IIRC it was that a lot of projects end up needing to use any (or at least their developers think they do), and we're trying to not be in people's way as much with the recommended rulesets. In a sense this is us capitulating to how new & intermediate TypeScript developers write code (the occasional any, not always doing type safe things). Capitulating means less friction in turning on the recommended rulesets, at the cost of being less useful out-of-the-box.

Do you think educating those users to try to use unknown instead could help adoption?

Yes, definitely. A lot of these lint rules are better from user education - and can themselves act as user education!

Which reminds me, https://typescript-eslint.io/rules/no-explicit-any could do a bit better in that regard. Filed typescript-eslint/typescript-eslint#7136. Thanks! 😄

Just following up, I finally got around to documenting this: typescript-eslint/typescript-eslint#8370

github-actions · 2023-06-19T13:20:58Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟢 Performance	95
🟢 Accessibility	100
🟢 Best practices	100
🟢 SEO	100
🔴 PWA	30

Lighthouse ran on https://create-t3-app-git-fork-joshuakgoldberg-typescript-f05f1a-t3-oss.vercel.app/

JoshuaKGoldberg · 2023-06-19T13:22:47Z

cli/src/helpers/installDependencies.ts

@@ -7,9 +7,9 @@ import {
 } from "~/utils/getUserPkgManager.js";
 import { logger } from "~/utils/logger.js";

-type Options = {
+interface Options {


https://v6--typescript-eslint.netlify.app/rules/consistent-type-definitions is the rule to enforce which of interface or type you prefer to use consistently. In v6 right now it's moved from strict to stylistic. How does that make you feel?

For reference, a couple of full text regex searches on the next branch:

interface .+ \{: 44 results in 40 files

type .+ = \{: 14 results in 12 files

this is one of the few that i don't feel strongly about.

my personal preference is "type by default, interface only if necessary (ie need to extend)" but judging by these stats that's not actually what we're doing currently.

what's the eslint team's opinion on this?

We in typescript-eslint¹ have interface over type as the default in our recommended rulesets, but I don't believe any of us feel extremely strongly about it. I personally don't. IMO the most important thing for a codebase is to standardize on one to reduce confusion.

I personally have leaned towards interfaces because they've historically had better error messages in edge cases than type. Though over the last couple of years, TypeScript has gotten a lot better at using names for types. So that's not as powerful a motivator as it used to be...

Footnotes

Sorry to nitpick - we're a separate team from ESLint core and don't want to accidentally give the impression we're speaking for them 😅 ↩

I recommend using type for literals and primitives (also unions and intersections of them), and interface for all other types. The Performance page in the official TypeScript wiki recommends interface for object types because of performance options and the ability to augment types.

one big argument in favour of "type by default" is that you can't accidentally merge with globals, see https://tsplay.dev/wjanvW

and i guess it also lets you know when you read a signature that what you're looking at is what you'll get as no merging can happen anywhere down the line.

but i agree by far the most important thing is picking a set of rules and sticking with them. i'd like create-t3-app to use whatever can reasonably be called the "default" behaviour for this sort of stuff unless there's a very good reason not to.

Just to be clear - would you like me to disable the rule and revert its changes? I'm happy to, just not sure from the discussion 😅

cli/src/helpers/installDependencies.ts

JoshuaKGoldberg · 2023-06-19T13:25:45Z

cli/src/helpers/installPackages.ts

  packages: PkgInstallerMap;
-} & InstallerOptions;
+};


https://v6--typescript-eslint.netlify.app/rules/sort-type-constituents - is newly in the stylistic config. While it does have an autofixer, I do worry that it's too nitpicky and will annoy people. Thoughts?

i think i like it, makes it more like interface where the things you extend comes first

Great - if we end up removing it from the config, I can manually re-enable it in this PR.

i like this a lot as well. if i'm reading an interface, i don't want to miss the fact that it extends something.

cli/template/base/_eslintrc.cjs

JoshuaKGoldberg · 2023-06-19T13:27:03Z

cli/tsconfig.eslint.json

@@ -1,3 +1,4 @@
 {
+  "extends": "./tsconfig.json",


Without this, the type checked rules don't have the right compiler options: most notably strict: true.

upgrade/tsconfig.tsbuildinfo

JoshuaKGoldberg · 2023-06-19T13:44:46Z

package.json

+    "@typescript-eslint/parser": "6.0.0-alpha.158",
+    "@typescript-eslint/scope-manager": "6.0.0-alpha.158",
+    "@typescript-eslint/types": "6.0.0-alpha.158",
+    "@typescript-eslint/visitor-keys": "6.0.0-alpha.158"


Re versioning: I'm guessing you won't want to merge this PR until we're out of alpha/beta/rc and in 6.0.0 stable. Noting here explicitly because otherwise I think this PR is ready for review. 🙂

👍🏼

why are the resolutions needed though?

Some nested dependencies still rely on 5.x. If you remove them locally & re-run pnpm i then the pnpm-lock.yaml gets a bit bigger. Example:

/astro-eslint-parser@0.14.0: resolution: {integrity: sha512-3F8l1h7+5MNxzDg1cSQxEloalG7fj64K6vOERChUVG7RLnAzSoafADnPQlU8DpMM3WRNfRHSC4NwUCORk/aPrA==} engines: {node: ^14.18.0 || >=16.0.0} dependencies: '@astrojs/compiler': 1.4.1 '@typescript-eslint/scope-manager': 5.59.11 '@typescript-eslint/types': 5.59.11

i see - is this just needed when trying the beta and something that can be removed later?

It should be yeah. This PR was useful for me in seeing who in the community we need to ask to add || 6 support! 😄

juliusmarminge · 2023-06-19T15:49:18Z

Do you also have updates on the new config stuff in eslint? https://eslint.org/docs/latest/use/configure/configuration-files-new

I'm interested in trying that out but last time i tried it was a bit broken

JoshuaKGoldberg · 2023-06-19T18:24:01Z

Do you also have updates on the new config stuff in eslint? eslint.org/docs/latest/use/configure/configuration-files-new

Not yet 😞 but once it's past stage 3 (eslint/eslint#13481) I'd be happy to!

JoshuaKGoldberg · 2023-07-11T20:49:58Z

Btw, I just updated to typescript-eslint@v6.0.0 stable. 🥳

cli/template/base/package.json

package.json

juliusmarminge · 2023-07-12T12:12:23Z

Thank you @JoshuaKGoldberg

feat: typescript-eslint@v6

5a24c6c

github-actions bot added 📌 area: cli Relates to the CLI 📌 area: t3-app Relates to the generated T3 App 📚 documentation Improvements or additions to documentation labels Jun 19, 2023

vercel bot deployed to Preview – create-t3-app June 19, 2023 13:19 View deployment

JoshuaKGoldberg commented Jun 19, 2023

View reviewed changes

cli/src/helpers/installDependencies.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg commented Jun 19, 2023

View reviewed changes

cli/template/base/_eslintrc.cjs Show resolved Hide resolved

JoshuaKGoldberg commented Jun 19, 2023

View reviewed changes

upgrade/tsconfig.tsbuildinfo Outdated Show resolved Hide resolved

Corrected versions with resolutions

f4efe55

vercel bot deployed to Preview – create-t3-app June 19, 2023 13:36 View deployment

JoshuaKGoldberg commented Jun 19, 2023

View reviewed changes

JoshuaKGoldberg marked this pull request as ready for review June 19, 2023 13:45

JoshuaKGoldberg requested review from juliusmarminge, nexxeln, t3dotgg and c-ehrlich as code owners June 19, 2023 13:45

This was referenced Jun 19, 2023

Try out v6 beta on various important community repos typescript-eslint/typescript-eslint#6760

Closed

tooling: gitignore tsconfig.tsbuildinfo #1477

Closed

Switch _eslintrc.cjs back to const config

b9f5c96

vercel bot deployed to Preview – create-t3-app June 19, 2023 15:50 View deployment

Undid no-confusing-void-expression

0cc41a3

vercel bot deployed to Preview – create-t3-app June 19, 2023 15:59 View deployment

Merge branch 'next'

9772933

vercel bot deployed to Preview – create-t3-app June 19, 2023 17:31 View deployment

typescript-eslint@v6 stable 🥳

47bfca9

vercel bot deployed to Preview – create-t3-app July 11, 2023 20:29 View deployment

Merge branch 'next'

81b57af

vercel bot deployed to Preview – create-t3-app July 11, 2023 20:32 View deployment

juliusmarminge requested changes Jul 11, 2023

View reviewed changes

cli/template/base/package.json Outdated Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

Finished migrating to stable release

8f182d0

JoshuaKGoldberg requested a review from juliusmarminge July 11, 2023 22:37

vercel bot deployed to Preview – create-t3-app July 11, 2023 22:37 View deployment

juliusmarminge approved these changes Jul 12, 2023

View reviewed changes

juliusmarminge enabled auto-merge July 12, 2023 12:12

juliusmarminge merged commit f3fd50f into t3-oss:next Jul 12, 2023

github-actions bot mentioned this pull request Jul 12, 2023

chore(release): version packages #1509

Merged

JoshuaKGoldberg deleted the typescript-eslint-v6 branch July 12, 2023 17:24

JoshuaKGoldberg mentioned this pull request Jul 29, 2023

feat: Disable typescript-eslint's array-type and consistent-type-definitions #1520

Closed

devvianto605 pushed a commit to devvianto605/create-devviantex-nextjs-app-deprecated that referenced this pull request Jun 9, 2024

feat: typescript-eslint@v6 (t3-oss#1476)

deffff9

JoshuaKGoldberg mentioned this pull request Jul 6, 2024

chore: bump typescript-eslint to v8 #1936

Merged

JoshuaKGoldberg mentioned this pull request Jul 31, 2024

⚡ Performance: parserOptions.projectService sometimes no longer outperforms parserOptions.project typescript-eslint/typescript-eslint#9571

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: typescript-eslint@v6 #1476

feat: typescript-eslint@v6 #1476

JoshuaKGoldberg commented Jun 19, 2023 •

edited

Loading

changeset-bot bot commented Jun 19, 2023 •

edited

Loading

vercel bot commented Jun 19, 2023 •

edited

Loading

vercel bot commented Jun 19, 2023

JoshuaKGoldberg Jun 19, 2023

juliusmarminge Jun 19, 2023

JoshuaKGoldberg Jun 19, 2023

c-ehrlich Jun 19, 2023 •

edited

Loading

JoshuaKGoldberg Jun 19, 2023

nickserv Jun 23, 2023

JoshuaKGoldberg Jun 23, 2023

JoshuaKGoldberg Feb 4, 2024

github-actions bot commented Jun 19, 2023 •

edited

Loading

JoshuaKGoldberg Jun 19, 2023

c-ehrlich Jun 20, 2023

JoshuaKGoldberg Jun 20, 2023

nickserv Jun 23, 2023 •

edited

Loading

c-ehrlich Jun 28, 2023

JoshuaKGoldberg Jul 11, 2023

JoshuaKGoldberg Jun 19, 2023

juliusmarminge Jun 19, 2023

JoshuaKGoldberg Jun 19, 2023 •

edited

Loading

c-ehrlich Jun 20, 2023

JoshuaKGoldberg Jun 19, 2023

JoshuaKGoldberg Jun 19, 2023 •

edited

Loading

juliusmarminge Jun 19, 2023

JoshuaKGoldberg Jun 19, 2023

juliusmarminge Jun 19, 2023

JoshuaKGoldberg Jun 19, 2023

juliusmarminge commented Jun 19, 2023

JoshuaKGoldberg commented Jun 19, 2023

JoshuaKGoldberg commented Jul 11, 2023

juliusmarminge commented Jul 12, 2023

feat: typescript-eslint@v6 #1476

feat: typescript-eslint@v6 #1476

Conversation

JoshuaKGoldberg commented Jun 19, 2023 • edited Loading

✅ Checklist

Changelog

changeset-bot bot commented Jun 19, 2023 • edited Loading

🦋 Changeset detected

vercel bot commented Jun 19, 2023 • edited Loading

vercel bot commented Jun 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

c-ehrlich Jun 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jun 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Footnotes

nickserv Jun 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoshuaKGoldberg Jun 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoshuaKGoldberg Jun 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliusmarminge commented Jun 19, 2023

JoshuaKGoldberg commented Jun 19, 2023

JoshuaKGoldberg commented Jul 11, 2023

juliusmarminge commented Jul 12, 2023

JoshuaKGoldberg commented Jun 19, 2023 •

edited

Loading

changeset-bot bot commented Jun 19, 2023 •

edited

Loading

vercel bot commented Jun 19, 2023 •

edited

Loading

c-ehrlich Jun 19, 2023 •

edited

Loading

github-actions bot commented Jun 19, 2023 •

edited

Loading

nickserv Jun 23, 2023 •

edited

Loading

JoshuaKGoldberg Jun 19, 2023 •

edited

Loading

JoshuaKGoldberg Jun 19, 2023 •

edited

Loading