Add types

[Logicer16]

I just happened to already have types for this project in my own soon-to-be-published config. Ordinarily, configs, processors, parsers, and other custom exports would also need to be included, but as this plugin is quite simple 😉, only the basic plugin type needs to be used. For almost every use case, specific types for rules can be safely ignored as they are handled by ESLint internally with end users only referencing them by name.

fixes #163

[lydell]

Awesome, thanks!

How does this work?

import type {ESLint} from "eslint";

Does the user need to install something to get that working?

How do I test this manually that it works?

[maranomynet]

This is essentially what I was talking about here #163 (comment)

This asserts that what you're exporting is "an ESLint Plugin", but does not reflect the actual shape/contents of this particular plugin — i..e. which of the optinoal properties/objects (rules, config, etc.) it actually contains.

[Logicer16]

Does the user need to install something to get that working?

These types are coming from @types/eslint. In most cases, a type checked eslint config will already have this installed in order to set the type for their configs. If it's missing the typescript compiler will instruct users to install it. If you'd rather, it can be listed as an optional peerDependency.

How do I test this manually that it works?

All you should need to test the types is:

import simpleImportSortPlugin from "eslint-plugin-simple-import-sort";
import type {Linter} from "eslint";
const config: Linter.FlatConfig = {
  plugins: {
    "simple-import-sort": simpleImportSortPlugin
  }
}

does not reflect the actual shape/contents of this particular plugin

@maranomynet Were you looking to use the types of any of those optional properties?

[Logicer16]

@lydell Did you need anything else in this pr? If we want more specific types those can always be done later as those types would simply extend the ones we have here.

[lydell]

No, I’ve tested this now and think we’re ready to go! I was waiting for this reply, but it doesn’t bring anything useful for this repo it seems. I’ll try to make a release later today.

[lydell]

Released in 12.1.0. Thanks again for the help!

[lydell]

@JoshuaKGoldberg this plugin now has types, if you wanna update the table in eslint/eslint#18093 :)

[JoshuaKGoldberg]

Yay! Thanks 😄