Skip to content

docs: add v6 upgrade blog post #6515

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

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Feb 22, 2023

PR Checklist

Overview

Announces the v6 beta, including:

  • A brief intro on the project and the leadup to v6
  • Steps to set it up (mostly pointing to getting started & configuration docs)
  • Lists of user-facing changes, especially breaking changes
  • Lists of developer-facing changes, especially breaking changes
  • Acknowledgements

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

@nx-cloud
Copy link

nx-cloud bot commented Feb 22, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 183cc47. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 46 targets

Sent with 💌 from NxCloud.

@netlify
Copy link

netlify bot commented Feb 22, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit bf95384
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/640f75c93a32590008474c1b
😎 Deploy Preview https://deploy-preview-6515--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review February 24, 2023 02:37
@JoshuaKGoldberg JoshuaKGoldberg requested a review from a team February 24, 2023 02:37
@JamesHenry

This comment was marked as resolved.

@JoshuaKGoldberg

This comment was marked as resolved.

@JoshuaKGoldberg JoshuaKGoldberg added this to the 6.0.0 milestone Feb 25, 2023
JamesHenry
JamesHenry previously approved these changes Mar 13, 2023
Copy link
Member

@JamesHenry JamesHenry left a comment

Choose a reason for hiding this comment

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

Beautiful 🎉

@codecov
Copy link

codecov bot commented Mar 13, 2023

Codecov Report

Merging #6515 (bf95384) into main (8581031) will decrease coverage by 5.51%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6515      +/-   ##
==========================================
- Coverage   90.67%   85.16%   -5.51%     
==========================================
  Files         376      383       +7     
  Lines       12849    13025     +176     
  Branches     3783     3839      +56     
==========================================
- Hits        11651    11093     -558     
- Misses        854     1570     +716     
- Partials      344      362      +18     
Flag Coverage Δ
unittest 85.16% <ø> (-5.51%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 28 files with indirect coverage changes

@JoshuaKGoldberg JoshuaKGoldberg merged commit cea05c8 into typescript-eslint:main Mar 13, 2023
@JoshuaKGoldberg JoshuaKGoldberg deleted the v6-upgrading-to-typescript-eslint-post branch March 13, 2023 19:19
- `@typescript-eslint/no-parameter-properties`
- `@typescript-eslint/sort-type-union-intersection-members`
- [feat(eslint-plugin): [prefer-nullish-coalescing]: add support for assignment expressions](https://github.com/typescript-eslint/typescript-eslint/pull/5234): Enhances the [`@typescript-eslint/prefer-nullish-coalescing`](https://typescript-eslint.io/prefer-nullish-coalescing) rule to also check `||=` expressions.
- [fix(eslint-plugin): [prefer-function-type] check for merges with type checking](https://github.com/typescript-eslint/typescript-eslint/pull/6104): Fixes edge case bugs in the [`@typescript-eslint/prefer-function-type`](https://typescript-eslint.io/prefer-function-type) rule around function type merges, at the cost of making it require type information.
Copy link
Member

Choose a reason for hiding this comment

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

We didn't end up shipping this change!

Copy link
Member Author

Choose a reason for hiding this comment

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

Whoops!


- [feat: remove semantically invalid properties from TSEnumDeclaration, TSInterfaceDeclaration and TSModuleDeclaration](https://github.com/typescript-eslint/typescript-eslint/pull/4863): Removes some properties from those AST node types that should generally not have existed to begin with.
- [fix(utils): removed TRuleListener generic from the createRule](https://github.com/typescript-eslint/typescript-eslint/pull/5036): Makes `createRule`-created rules more portable in the type system.
- [feat(utils): remove (ts-)eslint-scope types](https://github.com/typescript-eslint/typescript-eslint/pull/5256): Removes no-longer-useful `TSESLintScope` types from the `@typescript-eslint/utils` package.
Copy link
Member

Choose a reason for hiding this comment

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

Might be good to mention that the alternative is to use @typescript-eslint/scope-manager

- ⏳ [Enhancement: Add test-only console warnings to deprecated AST properties](https://github.com/typescript-eslint/typescript-eslint/issues/6469): The properties will include a `console.log` that triggers only in test environments, to encourage developers to move off of them.
- [feat(scope-manager): ignore ECMA version](https://github.com/typescript-eslint/typescript-eslint/pull/5889): `@typescript-eslint/scope-manager` no longer includes properties referring to `ecmaVersion`, `isES6`, or other ECMA versioning options. It instead now always assumes ESNext.
- [feat: remove partial type-information program](https://github.com/typescript-eslint/typescript-eslint/pull/6066): When user configurations don't provide a `parserOptions.project`, parser services will no longer include a `program` with incomplete type information. `program` will be `null` instead.
- [feat(experimental-utils): console.warn on import of experimental-utils](https://github.com/typescript-eslint/typescript-eslint/pull/6179): The `@typescript-eslint/experimental-utils` package has since been renamed to `@typescript-eslint/utils`. The old package name now includes a `console.warn` message to indicate you should switch to the new package name.
Copy link
Member

Choose a reason for hiding this comment

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

We unshipped this by deleting the package entirely!


For example, a typical project that enables typed linting might have an ESLint configuration file like:

```js title=".eslintrc.cjs"
Copy link
Member

Choose a reason for hiding this comment

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

It might be good to use the "remove this line", "add this line" syntax to highlight the necessary changes - WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

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

I dig it!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Blog post describing changes & migration strategy for v5->v6
3 participants