Add tandemSuffix option, specify and match conventions, see phetsims/…

…tandem#267
phetsims · Aug 26, 2022 · c884a30 · c884a30
1 parent 22a1097
commit c884a30
Show file tree

Hide file tree

Showing 28 changed files with 49 additions and 20 deletions.
diff --git a/js/BicyclePumpNode.ts b/js/BicyclePumpNode.ts
@@ -134,7 +134,8 @@ export default class BicyclePumpNode extends Node {
       handleCursor: 'ns-resize',
 
       // NodeOptions
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'PumpNode'
     }, providedOptions );
 
     const width = options.width;

diff --git a/js/ClapperboardButton.ts b/js/ClapperboardButton.ts
@@ -68,7 +68,8 @@ class ClapperboardButton extends Node {
       },
 
       // phet-io
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     super( options );

diff --git a/js/EyeDropperNode.ts b/js/EyeDropperNode.ts
@@ -84,7 +84,8 @@ export default class EyeDropperNode extends Node {
 
       // NodeOptions
       cursor: 'pointer',
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'DropperNode'
     }, provideOptions );
 
     super();

diff --git a/js/FaucetNode.ts b/js/FaucetNode.ts
@@ -106,6 +106,7 @@ export default class FaucetNode extends AccessibleSlider( Node, 0 ) {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'FaucetNode',
       phetioType: FaucetNode.FaucetNodeIO,
       phetioEventType: EventType.USER
     }, providedOptions );

diff --git a/js/FineCoarseSpinner.ts b/js/FineCoarseSpinner.ts
@@ -48,6 +48,7 @@ export default class FineCoarseSpinner extends Node {
       // NodeOptions
       disabledOpacity: 0.5, // {number} opacity used to make the control look disabled
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Spinner',
       phetioEnabledPropertyInstrumented: true
     }, providedOptions );
 

diff --git a/js/GaugeNode.ts b/js/GaugeNode.ts
@@ -82,7 +82,8 @@ export default class GaugeNode extends Node {
       updateWhenInvisible: true,
 
       // NodeOptions
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Node'
     }, providedOptions );
 
     assert && assert( options.span <= 2 * Math.PI, `options.span must be <= 2 * Math.PI: ${options.span}` );

diff --git a/js/HeaterCoolerFront.ts b/js/HeaterCoolerFront.ts
@@ -123,6 +123,7 @@ export default class HeaterCoolerFront extends Node {
 
       // NodeOptions
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'HeaterCoolerNode',
       phetioType: Node.NodeIO
     }, providedOptions );
 

diff --git a/js/HeaterCoolerNode.ts b/js/HeaterCoolerNode.ts
@@ -61,7 +61,8 @@ export default class HeaterCoolerNode extends Node {
       baseColor: HeaterCoolerFront.DEFAULT_BASE_COLOR,
 
       // NodeOptions
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'HeaterCoolerNode'
     }, providedOptions );
 
     this.heatCoolAmountProperty = heatCoolAmountProperty;

diff --git a/js/LaserPointerNode.ts b/js/LaserPointerNode.ts
@@ -112,7 +112,8 @@ const DEFAULT_OPTIONS = optionize<LaserPointerNodeOptions, SelfOptions, NodeOpti
     proportionStickingOut: 0.5
   },
 
-  tandem: Tandem.REQUIRED
+  tandem: Tandem.REQUIRED,
+  tandemSuffix: [ 'LaserPointerNode', 'LightNode' ]
 } );
 assert && Object.freeze( DEFAULT_OPTIONS );
 

diff --git a/js/NumberControl.ts b/js/NumberControl.ts
@@ -216,6 +216,7 @@ export default class NumberControl extends Node {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Control',
       phetioType: NumberControl.NumberControlIO,
       phetioEnabledPropertyInstrumented: true, // opt into default PhET-iO instrumented enabledProperty
       visiblePropertyOptions: { phetioFeatured: true }

diff --git a/js/RulerNode.ts b/js/RulerNode.ts
@@ -89,7 +89,8 @@ class RulerNode extends Node {
       tickMarksOnBottom: true,
 
       // NodeOptions
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'RulerNode'
     }, providedOptions );
 
     // things you're likely to mess up, add more as needed

diff --git a/js/SpectrumSlider.ts b/js/SpectrumSlider.ts
@@ -138,7 +138,8 @@ export default class SpectrumSlider extends AccessibleSlider( Node, 0 ) {
       cursorStroke: 'black',
 
       // phet-io
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Slider'
 
     }, providedOptions );
 

diff --git a/js/StopSignNode.ts b/js/StopSignNode.ts
@@ -43,7 +43,8 @@ export default class StopSignNode extends Node {
       outerStroke: 'black',
 
       // NodeOptions
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'StopSignNode'
     }, providedOptions );
 
     options.children = [

diff --git a/js/Stopwatch.ts b/js/Stopwatch.ts
@@ -65,6 +65,7 @@ export default class Stopwatch extends PhetioObject {
 
       // PhetioObjectOptions
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Stopwatch',
       phetioType: ReferenceIO( IOType.ObjectIO ),
       phetioState: false
     }, providedOptions );

diff --git a/js/TimeControlNode.ts b/js/TimeControlNode.ts
@@ -98,7 +98,8 @@ export default class TimeControlNode extends Node {
       disabledOpacity: SceneryConstants.DISABLED_OPACITY,
 
       // phet-io
-      tandem: Tandem.REQUIRED, // {Tandem}
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'TimeControlNode',
       visiblePropertyOptions: { phetioFeatured: true },
       phetioEnabledPropertyInstrumented: true, // opt into default PhET-iO instrumented enabledProperty
 
@@ -114,7 +115,7 @@ export default class TimeControlNode extends Node {
 
     this.playPauseStepButtons = new PlayPauseStepButtonGroup( isPlayingProperty,
       combineOptions<PlayPauseStepButtonGroupOptions>( {
-        tandem: options.tandem.createTandem( 'playPauseStepButtons' )
+        tandem: options.tandem.createTandem( 'playPauseStepButtonGroup' )
       }, options.playPauseStepButtonOptions ) );
     children.push( this.playPauseStepButtons );
 

diff --git a/js/TimeSpeedRadioButtonGroup.ts b/js/TimeSpeedRadioButtonGroup.ts
@@ -52,6 +52,7 @@ export default class TimeSpeedRadioButtonGroup extends VerticalAquaRadioButtonGr
 
       // phetio
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'RadioButtonGroup',
 
       // pdom
       labelTagName: 'h4',

diff --git a/js/WavelengthNumberControl.ts b/js/WavelengthNumberControl.ts
@@ -67,7 +67,8 @@ export default class WavelengthNumberControl extends NumberControl {
         height: DEFAULT_THUMB_HEIGHT,
         cursorHeight: DEFAULT_TRACK_SIZE.height
       },
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Control'
     }, providedOptions );
 
     const trackNode = new SpectrumSliderTrack( wavelengthProperty, options.range,

diff --git a/js/ZoomButtonGroup.ts b/js/ZoomButtonGroup.ts
@@ -69,7 +69,8 @@ export default class ZoomButtonGroup extends FlowBox {
       spacing: 0,
       orientation: 'horizontal',
       align: 'center',
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'ZoomButtonGroup'
     }, providedOptions );
 
     // zoom in

diff --git a/js/accessibility/GrabDragInteraction.js b/js/accessibility/GrabDragInteraction.js
@@ -166,7 +166,8 @@ class GrabDragInteraction extends EnabledComponent {
       },
 
       // {Tandem} - For instrumenting
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'GrabDragInteraction'
     }, options );
 
     // a second block for options that use other options, therefore needing the defaults to be filled in

diff --git a/js/bucket/BucketFront.ts b/js/bucket/BucketFront.ts
@@ -32,6 +32,7 @@ export default class BucketFront extends Node {
 
     const options = optionize<BucketFrontOptions, StrictOmit<SelfOptions, 'labelNode'>, NodeOptions>()( {
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'BucketFrontNode',
       cursor: 'pointer'
     }, providedOptions );
 

diff --git a/js/buttons/PlayPauseStepButtonGroup.ts b/js/buttons/PlayPauseStepButtonGroup.ts
@@ -92,6 +92,7 @@ export default class PlayPauseStepButtonGroup extends HBox {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'ButtonGroup',
 
       // pdom
       tagName: 'div', // so that it can receive descriptions

diff --git a/js/buttons/RefreshButton.ts b/js/buttons/RefreshButton.ts
@@ -31,7 +31,9 @@ export default class RefreshButton extends RectangularPushButton {
       iconHeight: 35,
 
       // RectangularPushButtonOptions
-      baseColor: PhetColorScheme.BUTTON_YELLOW
+      baseColor: PhetColorScheme.BUTTON_YELLOW,
+
+      tandemSuffix: 'RefreshButton'
     }, providedOptions );
 
     options.content = new Path( syncAltSolidShape, {

diff --git a/js/buttons/ResetAllButton.ts b/js/buttons/ResetAllButton.ts
@@ -55,6 +55,7 @@ export default class ResetAllButton extends ResetButton {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'ResetAllButton',
       phetioDocumentation: 'The orange, round button that can be used to restore the initial state',
 
       // sound generation

diff --git a/js/buttons/ResetButton.ts b/js/buttons/ResetButton.ts
@@ -49,7 +49,8 @@ export default class ResetButton extends RoundPushButton {
       xContentOffset: -0.03 * BUTTON_RADIUS,
       yContentOffset: -0.0125 * BUTTON_RADIUS,
 
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'ResetButton'
     }, providedOptions );
 
     // icon, with bounds adjusted so that center of circle appears to be centered on button, see sun#235

diff --git a/js/buttons/ZoomButton.ts b/js/buttons/ZoomButton.ts
@@ -37,7 +37,8 @@ export default class ZoomButton extends RectangularPushButton {
 
       // RectangularPushButtonOptions
       baseColor: PhetColorScheme.BUTTON_YELLOW,
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     // Plus or minus sign in middle of magnifying glass

diff --git a/js/input/MovableDragHandler.js b/js/input/MovableDragHandler.js
@@ -39,7 +39,8 @@ class MovableDragHandler extends SimpleDragHandler {
       // the target can be overridden here. This is useful when you need to attach a listener to a sub-component
       // of a node hierarchy
       targetNode: null,
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'DragListener'
     }, options );
 
     let startOffset; // where the drag started relative to positionProperty, in parent view coordinates

diff --git a/js/keypad/Keypad.js b/js/keypad/Keypad.js
@@ -67,7 +67,8 @@ class Keypad extends Node {
       accumulatorOptions: null,
 
       // phet-io
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Keypad'
     }, options );
 
     super();

diff --git a/js/keypad/NumberAccumulator.js b/js/keypad/NumberAccumulator.js
@@ -38,7 +38,8 @@ class NumberAccumulator extends AbstractKeyAccumulator {
     options = merge( {
       maxDigitsRightOfMantissa: 0,
       maxDigits: MAX_DIGITS,
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'NumberAccumulator'
     }, options );
 
     // verify option values