feat: add type definitions

[aryaemami59]

This PR:

• Adds missing type definitions.
• Resolves missing TypeScript declaration file #214.

[scagood]

Generally looks good to me 🙇‍♂️

[aryaemami59]

I'm thinking about adding some type tests to instill some more confidence, let me know if that's something you would be interested in.

[scagood]

That very much would be!

We have an issue in a different eslint-community repo to do exactly that (eslint-community/eslint-plugin-n#212). So I would (possibly) look to 'borrow' the prior art if you do end up adding some tests :)

[carlocorradini]

Any update? Thanks 🙌

[aryaemami59]

Any update? Thanks 🙌

Sorry about that, I kind of got busy and neglected this, I did mention a while back that I think it's better if we do a full TS migration so the types remain accurate and stay in sync with the runtime code. That offer still stands, I would love to do that if you guys are okay with it.

[carlocorradini]

@aryaemami59 Awesome thanks 🙂‍↕️🥳

[tomer-dev]

Looks great! Thank you 🚀

[JoshuaKGoldberg]

LGTM! 🚀

+1 to shipping this now to resolve types issues for users of the plugin, then considering a full TS migration later.

[michaelfaith]

🙌

[MichaelDeBoey]

LGTM, but let's rebase onto latest main & revert all unrelated changes

[aryaemami59]

I'll make the requested adjustmentts shortly.

[MichaelDeBoey]

Maybe we should make release dependent on these new workflows?
Otherwise a release could happen even if types aren't correct

CC/ @JoshuaKGoldberg

[github-actions]

🎉 This PR is included in version 4.6.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[nnmrts]

Sorry for pinging everybody in here, but shouldn't the type definitions also have a default export?

Before this PR, this line of code was fine:

import eslintComments from "@eslint-community/eslint-plugin-eslint-comments";

But now, with the type definitions, tools think this package has no default export. For example, I get this error from eslint-plugin-import-x: No default export found in imported module "@eslint-community/eslint-plugin-eslint-comments".

https://github.com/un-ts/eslint-plugin-import-x/blob/v4.16.1/docs/rules/default.md