Before You File a Documentation Request Please Confirm You Have Done The Following...

• I have looked for existingopen or closed documentation requests that match my proposal.
• I haveread the FAQ and my problem is not listed.

Suggested Changes

Forking out of#10935:

Now that ESLint has launcheddefineConfig(), it would be nice to update the typescript-eslint docs to use that insteadtseslint.config() (and perhaps deprecatetseslint.config() altogether?).

We'd really, really like to do that. But we're currently blocked from suggestingdefineConfig due to type incompatibilities (#10899). Those type incompatibilities are quite a difficult, long process (#11190 ->eslint/rewrite#226, etc.). Which means we're stuck in this awkward state right now:

• Users are getting confused about the relationship between the newdefineConfig and soon-to-be-legacytseslint.config
• We can't recommenddefineConfig because it causes type errors and resultantno-unsafe-* lint reports when configs are type-checked

In the meantime, we can do a compromise of mentioningdefineConfig in the docs. We've ideated having it as either:

• An admonition underFlat Config saying something like like"ESLint also hasdefineConfig(), which we will soon recommend pending "
• A third tab alongsideFlat Config with a name likeESLint'sdefineConfig, with that indication inside it

Affected URL(s)

https://typescript-eslint.io/getting-started
https://typescript-eslint.io/getting-started/legacy-eslint-setup
https://typescript-eslint.io/getting-started/typed-linting
https://typescript-eslint.io/packages/typescript-eslint#config

Additional Info

This came out of some internal brainstorming on how we can try to help+inform users without leading them down unnecessary config rabbit holes.

Co-authored-by:@bradzacher,@kirkwaiblinger

💖