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

Publish TypeScript Types for Wallaby Configuration File #3338

Open
boneskull opened this issue Mar 1, 2024 · 2 comments
Open

Publish TypeScript Types for Wallaby Configuration File #3338

boneskull opened this issue Mar 1, 2024 · 2 comments

Comments

@boneskull
Copy link

I'm maintaining @types/wallabyjs, and it'd make my life easier if any changes to the configuration were highlighted, tagged, or otherwise easily findable in the public CHANGELOG. The information on these changes is good, but they are difficult to find.

As long as I'm here: I'm always interested in feedback on the types if we have something wrong. 😄

thanks!

@smcenlly
Copy link
Member

smcenlly commented Mar 3, 2024

Thanks for creating/maintaining these types!

We took a brief look at the types, and they are mostly correct. There are definitely some things to fix. Going through it thoroughly will take some time, here are a few things we noticed:


Wallaby started life as a JavaScript project, but we've been gradually migrating to TypeScript over time. I am wondering if it makes sense for us to update / fix and take ownership of these types? Updating the types automatically as required could then be an automated part of our build process. We've not contributed to @types before, so not sure what needs to happen to make that possible?

Let us know what you think. If you agree for us to maintain, I'll update the issue title to reflect and we'll likely get to doing this in the next few months.

@boneskull
Copy link
Author

If you're looking to automate, I'd recommend just shipping your own types as a new package (e.g., @wallabyjs/types or something); we can easily deprecate the DT types once you publish. To publish a change to DT types, you'd need to get a human "owner" (right now that's me and another dude) of the types to approve the change. You could set it up such that, say, both you and Artem are owners--and try to automate the publishing that way. But that seems painful.

So yeah, just give a heads up once you have something published, and I'll deprecate the types on the DT side.

@smcenlly smcenlly changed the title meta: highlight/breakout config file changes in CHANGELOG? Publish TypeScript Types for Wallaby Configuration File Mar 4, 2024
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

No branches or pull requests

2 participants