-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Open
Labels
accepting prsGo ahead, send a pull request that resolves this issueGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updatingDocumentation ("docs") that needs adding/updating
Description
Before You File a Documentation Request Please Confirm You Have Done The Following...
- I have looked for existing open or closed documentation requests that match my proposal.
- I have read the FAQ and my problem is not listed.
Suggested Changes
We have >=2 rules that interact with the interface
vs. type
hullabaloo:
@typescript-eslint/consistent-indexed-object-style
: around how to define arbitrary object/string keys@typescript-eslint/consistent-type-definitions
: about whether to useinterface
ortype
(when possible)
#10227 -> #10731 cleaned up the latter, but didn't touch the former. Coming over from #10731 (comment): we'd like to mention why one would or wouldn't care about the difference between Record<..., ...>
vs. { [i: ...]: ... }
. https://typescript-eslint.io/rules/consistent-indexed-object-style never explicitly says what those differences are. Proposal: let's add that in?
Affected URL(s)
https://typescript-eslint.io/rules/consistent-indexed-object-style
Additional Info
💖
Co-authored-by: @kirkwaiblinger
Metadata
Metadata
Assignees
Labels
accepting prsGo ahead, send a pull request that resolves this issueGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updatingDocumentation ("docs") that needs adding/updating