search

phetsims / joist

Joist is the main framework for PhET Interactive Simulations. Joist creates and displays the simulation content, home screen, navigation bar, About dialog, enables switching between tabs, and other framework-related features.
MIT License
8 stars 6 forks source link

Standardize the tandem hierarchy under "preferencesPanels" #961

Open pixelzoom opened 2 months ago

pixelzoom commented 2 months ago

Over in https://github.com/phetsims/projectile-data-lab/issues/30#issuecomment-2045822832, these phetioID simplifications were made:

... for 2 reasons: (1) This approach of adding an intermediate tandem was inconsistent with the Studio tree structure for other Panels. (2) 'simPreferences' and 'audioPreferences' were duplicated in sim code.

Going forward, sims should use this new convention. PDL, FEL, and the gas-properties suite have already been modified, since PhET-iO versions have not been published yet.

PDL was the only sim using "audioPreferences".

The following sims have NOT been published with PhET-iO, and have "simPreferences" in their phet-io-api.json file. They should be changed ASAP, before they need a migration processor:

The following sims HAVE been published with PhET-iO, and have "simPreferences" in their phet-io-api.json file. They will required a (shared?) migration processor, and testing in the Migration wrapper. Publishing an MR for these sims is not recommended (or feasible?) because this is an API change.

Recommended to do all of the above sims at once -- probably 3-5 hours. Doing them one at a time as they are republished will likely double the cost.

Assigning to @brent-phet to schedule and prioritize.

@arouinfar @kathy-phet @samreid @matthew-blackman FYI.

zepumph commented 2 months ago

We can make simPreferences bad text with lint after this work.