[Feature Request] [ESLint-Plugin] [Rules] Include TypeScript typings and Options interfaces/types in published npm package.

[AllySummers]

Apologies for not using the issue template, it didn't seem to fit in with a feature request. Also sorry if this is breaking any rules.

I'm trying to make a package (even if it's only me who uses it) for eslint rule configs in TypeScript, and I can see that in your repo you already create TypeScript interfaces/types for the config a rule accepts, however these aren't present (from what I could see at least) when installing from npm in the node_modules.

I can see in all/most of your rules you have an Options interface/type (like here) and it would be very appreciated if it could be somehow changed to include these in what is published to npm, as it would save me a lot of duplication and time of having to copy what's already been done.

What my project is so far (it's extremely early, I just spent the last few hours TypeScript-ifying the core ESLint rules)

[bradzacher]

There's an old issue for this but I CBF finding it amongst the pile of issues we have.

The answer to the request is no, sorry.
The option types declared for rules are often not 100% correct - they are based on some idealistic view of the world or they make some assumptions. In short - they are designed purely for internal development and not intended to 100% match the JSON schema.

In terms of getting types for the rules - the better way to do so is to generate the types yourself from the rule's JSON schema. This way you can be sure the types 100% match the rule's schema.

I've played with this idea before - #1296 and other users have too - #3227.
It's a great idea and I wish I had the time to build out the tooling and infra to make this a reality.

#1296 has some links to scripts and examples for generating the types from the schema.