feat: add missing type definitions

[aryaemami59]

This PR:

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

[MichaelDeBoey]

We already have configs types defined, so I don't think it's necessary to declare them again in typesVersions?

[aryaemami59]

Without it Node10 module resolution will fail when importing from @eslint-community/eslint-plugin-eslint-comments/configs.

[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 :)

[scagood]

Should most of this not be const instead of import?

Suggested change

	import configs = require("@eslint-community/eslint-plugin-eslint-comments/configs")
	import expectTypeModule = require("expect-type")
	import type { Linter } from "eslint"
	import expectTypeOf = expectTypeModule.expectTypeOf
	const configs = require("@eslint-community/eslint-plugin-eslint-comments/configs")
	const { expectTypeOf } = require("expect-type")
	import type { Linter } from "eslint"

---

I have never seen this syntax before, so do correct me if I am wrong 😅

[aryaemami59]

In this file I'm testing the types to make sure they work with TypeScript's CJS syntax. So something like const configs = require("@eslint-community/eslint-plugin-eslint-comments/configs") becomes import configs = require("@eslint-community/eslint-plugin-eslint-comments/configs"). It's to test ESM/CJS Interoperability on a type level.

Reference

[scagood]

Oh, neat! Thanks for the explanation :)

---

Edit: I can't seem to mark this as resolved 👀

[aryaemami59]

@scagood It might be good to fully migrate to TypeScript so the types and runtime code don't get out of sync. Thoughts?

[scagood]

Here is the previous discussion in the eslint-plugin-n repo, I am okay with either tbh
eslint-community/eslint-plugin-n#371

---

That being said, that is more a question for @eslint-community/eslint-plugin-eslint-comments.

[aryaemami59]

ah I see, honestly I would be happy to do it, I've done a lot of TS migrations and I could definitely do this one too. We can bundle with tsup which would be even easier. Do you want me to put together a quick POC so you can kind of see what it will look like?

[ethanwu10]

I believe this should be LegacyConfig, since the configs export is lib/configs which contains legacy string-array plugins:

eslint-plugin-eslint-comments/lib/configs/recommended.js

Line 5 in 60c28f9

plugins: ["@eslint-community/eslint-comments"],

[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 🙂‍↕️🥳