public
public copied to clipboard
Publish TypeScript Types for Wallaby Configuration File
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!
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:
- missing
files
andtests
automated configuration overrides - missing Smart Start settings
- Incorrect Postprocessor setting
- Missing ability to add custom Compiler
- Missing ability to override autoDetect array
- Missing some defaults
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.
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.