Foundry VTT Types Announcements

Hello!

I've just added a new role@Foundry VTT Types Announcements—for announcements. I will be posting roughly weekly to biweekly updates about the progress of fvtt-types, if you'd like to be added please let me know!

Just as a general reminder the types are still in beta. We're not quite ready to open the floodgates to everyone because the average system will run into circularities but we're getting ever closer to that zero error dream! In fact I think most module should be able to work without errors.

Now even if most systems run into errors, that doesn't mean we haven't been working hard to massively reduce them. Most people should have been seeing a substantial drop in errors over time and we hope to get that even lower. In fact fvtt-types recently reached the milestone of compiling without an error when compiled alone!

For this reason I recommend developing with skipLibCheck off. Historically fvtt-types itself has had a number of errors that were all noise as dependants couldn't do anything to fix them but now the primary errors to fix crop up when systems configure fvtt-types and we need to be seeing those errors.

Important Branch Information


If your repo has been using the types for a while I'd recommend switching over to track the maintenance branch with npm add -D fvtt-types@github:League-of-Foundry-Developers/foundry-vtt-types#maintenance.

Don't worry about losing out new features and bugfixes. Until support is dropped (slated to be by the end of the beta period!) maintenance should get all same major feature updates as
main
unless complications occur.

However I am starting to shift gears to pushing a number of breaking changes to
main
so that all the breaking changes can be in before a proper stable release. I don't want to break all existing systems out there every time I push a breaking change.

Currently no new breaking changes have been pushed

I've held off on pushing anything breaking for the time being and so this does mean right now maintenance and
main
are completely identical but that certainly will be changing very soon. For a taste of what's to come I expect to change how you import helperTypes and utils, revamp configuration to be more convenient, reorganise globals and more!

We do still need testers for all of this and maintenance will eventually be dropped and so I would recommend working with an eye towards
main
. Whenever you're ready you can get started with npm add -D fvtt-types@github:League-of-Foundry-Developers/foundry-vtt-types#main.

I have just released v12.331.3-beta to npm but I don't personally recommend tracking that since updates are so often merged to main and I don't make point releases that often.
Was this page helpful?