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

refactor(types): add tests and linting #154

Closed
wants to merge 3 commits into from

Conversation

fdebijl
Copy link
Collaborator

@fdebijl fdebijl commented Feb 10, 2021

This PR adds some much needed quality control to the types by adding tests, a linter and automatic checks on each PR.

Full changelog:

  • Move index.d.ts to 'types' directory
  • Move tsconfig.json to 'types' directory
  • Add dtslint as a devdependency
  • Add test.ts
    This file contains code that is not meant to be ran, but is used by dtslint to check for any errors in the types
  • Add tslint.json to 'types' directory
  • Add checks.yml to github actions directory
    This runs the tests, lint and dtslint on any pull request
  • Fix redundant jsdoc comments in index.d.ts
  • Fix extra whitespace in index.d.ts
  • Fix redundant public statements in index.d.ts
  • Add export statements in index.d.ts. There were implicit before but are now explicitly added for clarity.

@peterpme
Copy link
Contributor

💯 this is great! once these tests pass I'll merge this in :)

@fdebijl
Copy link
Collaborator Author

fdebijl commented Feb 10, 2021

@peterpme I should note that some of the problems in the typings are already adressed by other PR's, such as #113 and #139. If those are tested and merged first there should be no more errors with the types.

Edit: I can confirm #105 also fixes the issue mentioned in that PR

@rlueder rlueder added the enhancement New feature or request label Aug 10, 2021
@fdebijl
Copy link
Collaborator Author

fdebijl commented Nov 14, 2022

Closing this for now to keep my PR overview clean, feel free to re-open once this package is being worked on again 👌

@fdebijl fdebijl closed this Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

Successfully merging this pull request may close these issues.

3 participants