assert no additional children, see phetsims/sun#860

phetsims · Aug 19, 2024 · f337fd3 · f337fd3
1 parent a176698
commit f337fd3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/js/NumberControl.ts b/js/NumberControl.ts
@@ -21,7 +21,7 @@ import optionize, { combineOptions } from '../../phet-core/js/optionize.js';
 import IntentionalAny from '../../phet-core/js/types/IntentionalAny.js';
 import PickOptional from '../../phet-core/js/types/PickOptional.js';
 import StrictOmit from '../../phet-core/js/types/StrictOmit.js';
-import { AlignBox, extendsWidthSizable, Font, HBox, isWidthSizable, Node, NodeOptions, PaintColorProperty, Text, TextOptions, VBox, WidthSizable } from '../../scenery/js/imports.js';
+import { AlignBox, assertNoAdditionalChildren, extendsWidthSizable, Font, HBox, isWidthSizable, Node, NodeOptions, PaintColorProperty, Text, TextOptions, VBox, WidthSizable } from '../../scenery/js/imports.js';
 import ArrowButton, { ArrowButtonOptions } from '../../sun/js/buttons/ArrowButton.js';
 import HSlider from '../../sun/js/HSlider.js';
 import Slider, { SliderOptions } from '../../sun/js/Slider.js';
@@ -576,6 +576,9 @@ export default class NumberControl extends WidthSizable( Node ) {
       arrowEnabledListener && options.enabledRangeProperty && options.enabledRangeProperty.unlink( arrowEnabledListener );
     };
 
+    // Decorating with additional content is an anti-pattern, see https://github.com/phetsims/sun/issues/860
+    assert && assertNoAdditionalChildren( this );
+
     // support for binder documentation, stripped out in builds and only runs when ?binder is specified
     assert && phet?.chipper?.queryParameters?.binder && InstanceRegistry.registerDataURL( 'scenery-phet', 'NumberControl', this );
   }

diff --git a/js/keyboard/help/KeyboardHelpSection.ts b/js/keyboard/help/KeyboardHelpSection.ts
@@ -21,7 +21,7 @@ import StringProperty from '../../../../axon/js/StringProperty.js';
 import TReadOnlyProperty, { isTReadOnlyProperty } from '../../../../axon/js/TReadOnlyProperty.js';
 import optionize, { combineOptions } from '../../../../phet-core/js/optionize.js';
 import StrictOmit from '../../../../phet-core/js/types/StrictOmit.js';
-import { HBox, Node, ReadingBlock, ReadingBlockOptions, RichText, RichTextOptions, VBox, VBoxOptions } from '../../../../scenery/js/imports.js';
+import { assertNoAdditionalChildren, HBox, Node, ReadingBlock, ReadingBlockOptions, RichText, RichTextOptions, VBox, VBoxOptions } from '../../../../scenery/js/imports.js';
 import ResponsePacket from '../../../../utterance-queue/js/ResponsePacket.js';
 import PhetFont from '../../PhetFont.js';
 import sceneryPhet from '../../sceneryPhet.js';
@@ -155,6 +155,9 @@ export default class KeyboardHelpSection extends ReadingBlock( VBox ) {
 
     const readingBlockResponseProperty = this.createReadingBlockResponseProperty();
     this.setReadingBlockNameResponse( readingBlockResponseProperty );
+
+    // Decorating with additional content is an anti-pattern, see https://github.com/phetsims/sun/issues/860
+    assert && assertNoAdditionalChildren( this );
   }
 
   /**