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.

Sign up for GitHub

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

Jump to bottom

Verify our exports with arethetypeswrong #456

Closed
timostamm opened this issue Apr 13, 2023 · 2 comments
Closed

Verify our exports with arethetypeswrong #456

timostamm opened this issue Apr 13, 2023 · 2 comments
Labels
Cleanup Cleanup tasks Wishlist Things we'd want in the future

Comments

@timostamm
Copy link
Member

@fubhy pointed out https://arethetypeswrong.github.io/, written by one of the TypeScript maintainers.

A project that:

attempts to analyze npm package contents for issues with their TypeScript types, particularly ESM-related module resolution issues.

We should take a look whether we can use this tool to verify that our build artifacts are exported correctly for the cases we do not cover ourselves in the tests. This will also be interesting for our other repositories (including @bufbuild/connect, which uses subpath exports).
@fubhy
Copy link
Contributor

fubhy commented Apr 14, 2023

Mark Erikson has built a CI util that he uses in redux-thunk, redux-toolkit, etc.:

https://github.com/reduxjs/redux-toolkit/tree/master/examples/publish-ci/are-the-types-wrong

I was going to turn that into a reusable CLI & Github Action but didn't find the time yet.

@fubhy
Copy link
Contributor

fubhy commented Apr 14, 2023

Discussion here: arethetypeswrong/arethetypeswrong.github.io#15

@smaye81 smaye81 added the Wishlist Things we'd want in the future label Jun 21, 2023
@smaye81 smaye81 mentioned this issue Jul 28, 2023
Closed
@timostamm timostamm added the Cleanup Cleanup tasks label Aug 30, 2023
@timostamm timostamm mentioned this issue Aug 31, 2023
Closed
@timostamm timostamm mentioned this issue Sep 28, 2023
Merged
smaye81 added a commit that referenced this issue Sep 28, 2023
@smaye81
Integrate arethetypeswrong (#565)
1ad9d3d 
Fixes #456 

This integrates the
[`arethetypeswrong`](https://github.com/arethetypeswrong/arethetypeswrong.github.io/tree/main)
CLI tool for checking types in published packages. It also adds the call
to lint the types in CI that it is easy to spot regressions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Cleanup Cleanup tasks Wishlist Things we'd want in the future
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Integrate arethetypeswrong bufbuild/protobuf-es
3 participants
@smaye81 @fubhy @timostamm