Add API validation for preferences phetioState, see phetsims/joist#744

phetsims · Sep 21, 2022 · f104162 · f104162
1 parent 91abe06
commit f104162
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/js/phetioAPIValidation.ts b/js/phetioAPIValidation.ts
@@ -109,8 +109,13 @@ class PhetioAPIValidation {
         }
         assert && assert( !phetioObject.phetioReadOnly, 'preferences model and its descendants should be phetioReadOnly: false, key=' + preferencesKey );
 
-        // Audio manager, color profile property and localeProperty are supposed to be stateful.
-        // assert && assert( !phetioObject.phetioState, 'preferences model and its descendants should be phetioState: false, key=' + preferencesKey );
+        // Audio manager, color profile property and localeProperty are supposed to be stateful. All other preferences
+        // should be phetioState: false so they are not captured in the state
+        assert && assert( phetioObject.phetioState ===
+                          ( phetioObject.phetioID.endsWith( '.colorProfileProperty' ) ||
+                            phetioObject.phetioID.endsWith( '.audioEnabledProperty' ) ||
+                            phetioObject.phetioID.endsWith( '.localeProperty' ) ),
+          'most preferences should be phetioState: false, key=' + preferencesKey );
       } );
   }