Docs: Mention verbatimModuleSyntax in docs for rules that encourage ESM import syntax

[kirkwaiblinger]

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 several rules that promote ESM syntax over CJS syntax. However, these won't necessarily play well with CJS projects using verbatimModuleSyntax. I propose we should mention caveats or inapplicability for rules that don't make sense with verbatimModuleSyntax.

Off the top of my head:

• https://typescript-eslint.io/rules/no-require-imports - verbatimModuleSyntax users should enable allowAsImport
• no-namespace - I'm pretty sure namespaces are the only way to export both named types and named values from a CJS module with verbatimModuleSyntax (I have a TS issue open about this that may give more information, Cannot export both types and values from CJS microsoft/TypeScript#60852). Therefore, namespaces may be necessary in some circumstances for CJS projects currently written using ESM syntax, but which are trying to adopt verbatimModuleSyntax

Affected URL(s)

https://typescript-eslint.io/rules/no-require-imports
https://typescript-eslint.io/rules/no-namespace/
possibly others?

Additional Info

No response

[JoshuaKGoldberg]

I like this - we should definitely better document this case. Maybe it deserves a standalone blog post as a guide, to put everything in one place?

[kirkwaiblinger]

Maybe just an FAQ unless we find more cases? We have a long blog post backlog and I'm not sure this quite warrants it. What do you think?

[JoshuaKGoldberg]

Heh, I always forget we have such thorough FAQs... definitely. +1