feat(eslint-plugin): deprecate prefer-ts-expect-error in favor of ban-ts-comment

[auvred]

PR Checklist

• Addresses an existing open issue: fixes Rules: Deprecate prefer-ts-expect-error in favor of ban-ts-comment #8333
• That issue was marked as accepting prs
• Steps in Contributing were taken

Overview

prefer-ts-expect-error is just a subset of ban-ts-comment because ban-ts-comment also suggests replacing @ts-ignore with @ts-expect-error

[typescript-eslint]

Thanks for the PR, @auvred!

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.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	591fefa
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6641c3b1424c0300086d9786
😎 Deploy Preview	https://deploy-preview-9081--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (🟢 up 3 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

---

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

[nx-cloud]

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 31 targets

• nx test eslint-plugin --coverage=false
• nx test eslint-plugin
• nx test typescript-eslint --coverage=false
• nx test type-utils --coverage=false
• nx run types:build
• nx test utils --coverage=false
• nx test scope-manager --coverage=false
• nx run repo-tools:postinstall-script
• nx test visitor-keys --coverage=false
• nx test typescript-estree --coverage=false
• nx test rule-schema-to-typescript-types --coverage=false
• nx run-many --target=build --parallel --exclude=website --exclude=website-eslint
• nx test parser --coverage=false
• nx test ast-spec --coverage=false
• nx test repo-tools --coverage=false
• nx test eslint-plugin-internal --coverage=false
• nx run-many --target=lint --parallel --exclude eslint-plugin
• nx test visitor-keys
• nx test eslint-plugin-internal
• nx test type-utils
• nx test utils
• nx test typescript-eslint
• nx test typescript-estree
• nx test parser
• nx test rule-schema-to-typescript-types
• nx test scope-manager
• nx test repo-tools
• nx run-many --target=typecheck --parallel
• nx test ast-spec
• nx run integration-tests:test
• nx run repo-tools:generate-configs

---

Sent with 💌 from NxCloud.

[kirkwaiblinger]

It looks like the docs website doesn't have any accompanying changes to indicate the deprecation other than it showing in the deprecated column of the table... Consider adding a doc warning like the following?

typescript-eslint/packages/eslint-plugin/docs/rules/no-throw-literal.mdx

Lines 17 to 23 in 7ce6acd

	:::warning
	This rule is being renamed to [`only-throw-error`](./only-throw-error.mdx).
	When it was first created, it only prevented literals from being thrown (hence the name), but it has now been expanded to only allow expressions which have a possibility of being an `Error` object.
	With the `allowThrowingAny` and `allowThrowingUnknown` options, it can be configured to only allow throwing values which are guaranteed to be an instance of `Error`.
	The current name `no-throw-literal` will be removed in a future major version of typescript-eslint.
	:::

(though note that that's also being tweaked a bit in #8821 (comment))

[auvred]

Oops, I kept in mind to mention deprecation in the docs, but it slipped my mind for some reason 😄 Thanks!

It might be worth mentioning this in Rule Deprecation docs:

typescript-eslint/docs/maintenance/issues/Rule_Deprecations.mdx

Lines 28 to 34 in 7ce6acd

	## Timeline
	1. In any minor/patch version, add [rule `meta` properties](https://eslint.org/docs/latest/developer-guide/working-with-rules#rule-basics):
	- `deprecated: true`
	- `replacedBy`, if applicable
	2. In the next major version, you may delete the rule
	- If the rule is relatively popular with users, consider leaving a documentation page as a tombstone pointing to the new relevant rule or docs (see [`camelcase`](/rules/camelcase/) as an example)