Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add type validation / generate typescript declaration file #512

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

voxpelli
Copy link
Member

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 voxpelli changed the title Add type validation / generate typescript declaration file feat: add type validation / generate typescript declaration file Jul 24, 2024
@voxpelli voxpelli force-pushed the voxpelli/issue488 branch from d9b9cc4 to c2e7e6d Compare July 24, 2024 15:02
@brettz9
Copy link
Member

brettz9 commented Jul 24, 2024

I've made my own attempt so far at 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)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add TypeScript declaration file
2 participants