feat(eslint-plugin): deprecate formatting (meta.type: layout) rules #8073
Conversation
|
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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
just to confirm - all the deprecated rules are the ones that have been moved to eslint-stylistic, right? Are there any others?
Also accepted but you should mark them all as replacedBy: ['eslint-stylistic/foo'].
Final note (follow up?) we should add a banner to deprecated rules using this metadata and point them at the replacement docs.
Just did another pass - I did miss one, 👍 on the other two suggestions, good call! Done. |
| deprecated: true, | ||
| docs: { | ||
| description: 'Enforce consistent spacing inside braces', | ||
| extendsBaseRule: true, | ||
| }, | ||
| replacedBy: ['@stylistic/object-curly-spacing'], |
There was a problem hiding this comment.
OCD eye twitch: all the other ones you added on consecutive lines
There was a problem hiding this comment.
Heh, the other ones are placed before a type:. So they somewhat don't make the sorting less alphabetical. This one doesn't have a type:...
packages/website/plugins/generated-rule-docs/insertions/insertFormattingNotice.ts
Outdated
Show resolved
Hide resolved
JoshuaKGoldberg
merged commit 04dea84
into
typescript-eslint:main
…ypescript-eslint#8073) * feat(eslint-plugin): deprecate formatting (meta.type: layout) rules * fix: whoops, forgot to commit all.ts changes * Add replacedBy * Update formatting admonition * Missed object-curly-spacing * areOptionsValid undo * Correct configs and tweak deprecation notice
PR Checklist
Overview
For every rule whose
metaincludestype: 'layout', addsdeprecated: trueand removes the rule from theallconfig.Note that changes to the
allconfig are explicitly not considered breaking. Per https://typescript-eslint.io/linting/configs (added in #5719, back in v5):