TyphonJS•3mo ago

Discussion: TRL 0.2.0-next.1 Pre-release

Greets @FVTT ▹ Developer, I'd like to open a discussion prior to the initial 0.2.0-next.1 release to set expectations and address concerns. When released I recommend as many folks to upgrade as soon as possible to get a better testing pool. Like all of the TRL releases even the first "beta" release will be rock solid and production ready. The further next.X series of releases will mostly be refining types particularly new Foundry core types and other odds and ends. All of the major refactoring of sub-path exports will be present from the initial release as well as various fixes reported since v12 dropped and many other useful enhancements to TRL. The discussion below relates to 0.2.0 update concerns and not TRL 0.1.x. --- Repo and NPM package name changes. The main repo in typhonjs-fvtt-lib is now runtime instead of typhonjs. Likewise svelte-standard is now standard. I will be making a new NPM package release for the standard library: @typhonjs-fvtt/standard instead of svelte-standard and marking the older package as deprecated. --- This release is large and will require some package import refactoring depending on what parts of TRL you utilize in your projects. Please see the pre-release 0.2.0 API docs which have now been updated reflecting all of the sub-path changes. More or less a lot of these changes affect the standard component library as now instead of #standard/component the components are logically separated into associated groupings. like #standard/component/button for buttons, etc. The following changes will be the most likely: - All application shell components #runtime/svelte/component/core -> #runtime/svelte/component/application. - localize (helper function for i18n support): #runtime/svelte/helper -> #runtime/util/i18n. - Components from the standard library will now have more explicit groups / sub-paths. Expand the tree for #standard/components in the updated API docs. I was able to make tremendous progress in the last week cleanly separating all non-Foundry specific components from the FVTT standard library into a base standard component library that can be used anywhere. This significantly increases the timeline of the Svelte 5 transition because I can now iterate on the Svelte 5 conversion without involving Foundry itself. To facilitate this separation though the Vite config will need a small mod:

{
  resolve: { conditions: ['import', 'browser'] }
}

{
  resolve: { conditions: ['import', 'browser'] }
}

Adding the alias directive allows the generic components to compile against the FVTT runtime and not the "base runtime".

{
  resolve: {
    alias: { '#runtime/': '@typhonjs-fvtt/runtime/' },
    conditions: ['import', 'browser']
  }
}

{
  resolve: {
    alias: { '#runtime/': '@typhonjs-fvtt/runtime/' },
    conditions: ['import', 'browser']
  }
}

--- There is only one code / breaking change. In the past various callbacks whether for app header buttons, TJSDialog callbacks, or various components from the standard library that provide data defined callbacks took argument lists. Instead of a variable number of arguments a single object will be passed now. This allows flexibility in typing and further extension in the future without disruptive refactoring if those arguments would have changed. If you have a dialog callback for instance that previously was:

function onSomeButtonPress(application) { /* Do something */ }

function onSomeButtonPress(application) { /* Do something */ }

all you have to do is add {} to destructure:

function onSomeButtonPress({ application }) { /* Do something */ }

function onSomeButtonPress({ application }) { /* Do something */ }

That's the breaking change for 0.2.0. This does require naming the destructured properties correctly and being mindful that you need to find / replace all callbacks appropriately across your codebase. For most folks that might be TJSDialog usage and app header buttons. It's less likely folks are using the data defined callbacks from the components in the standard library.

51 Replies

Gaming

Programming

Discussion: TRL 0.2.0-next.1 Pre-release