eslint-plugin-promise icon indicating copy to clipboard operation
eslint-plugin-promise copied to clipboard

feat: add type validation / generate typescript declaration file

Open voxpelli opened this issue 1 year ago • 1 comments

What is the purpose of this pull request?

Fix #488

What changes did you make? (Give an overview)

  1. Added a tsconfig.json as well as a type compiling declaration.tsconfig.json
  2. Added a TypeScript oriented eslint-plugin-jsdoc and improved the JSDoc comments to be compliant with that
  3. Added a CI job that validates the types
  4. Added deactivated npm scripts that can be activated to build on publish once we pass

voxpelli avatar Jul 24 '24 14:07 voxpelli

I've made my own attempt so far at https://github.com/eslint-community/eslint-plugin-promise/compare/main...brettz9:ts . ~~I have not yet added types for __tests__, but~~ the rest are passing tsc.

I'm not partial to using my version or anything, but would you mind providing some general feedback on the general approach (which in my case at least seems to require quite a few type checks)?

brettz9 avatar Jul 24 '24 20:07 brettz9