Address lint, update credits, see #1

js/common/MembraneChannelsColors.ts

@@ -11,7 +11,8 @@
  * each of which is required to have a default color. Note that dynamic colors can be edited by running the sim from
  * phetmarks using the "Color Edit" mode.
  *
- * @author Sam Reid (PhET Interactive Simulations, and Jesse Greenberg (PhET Interactive Simulations)
+ * @author Sam Reid (PhET Interactive Simulations
+ * @author Jesse Greenberg (PhET Interactive Simulations)
  */
 
 import { ProfileColorProperty } from '../../../scenery/js/imports.js';

js/common/MembraneChannelsConstants.ts

@@ -3,17 +3,15 @@
 /**
  * Constants used throughout this simulation.
  *
- * @author Sam Reid (PhET Interactive Simulations, and Jesse Greenberg (PhET Interactive Simulations)
+ * @author Sam Reid (PhET Interactive Simulations
+ * @author Jesse Greenberg (PhET Interactive Simulations)
  */
 
 import membraneChannels from '../membraneChannels.js';
 
 const MembraneChannelsConstants = {
-
   SCREEN_VIEW_X_MARGIN: 15,
   SCREEN_VIEW_Y_MARGIN: 15
-
-  //TODO
 };
 
 membraneChannels.register( 'MembraneChannelsConstants', MembraneChannelsConstants );

js/common/MembraneChannelsQueryParameters.ts

@@ -4,14 +4,14 @@
  * Defines query parameters that are specific to this simulation.
  * Run with ?log to print query parameters and their values to the browser console at startup.
  *
- * @author Sam Reid (PhET Interactive Simulations, and Jesse Greenberg (PhET Interactive Simulations)
+ * @author Sam Reid (PhET Interactive Simulations
+ * @author Jesse Greenberg (PhET Interactive Simulations)
  */
 
 import logGlobal from '../../../phet-core/js/logGlobal.js';
 import membraneChannels from '../membraneChannels.js';
 
 const SCHEMA_MAP = {
-  //TODO add schemas for query parameters
 };
 
 const MembraneChannelsQueryParameters = QueryStringMachine.getAll( SCHEMA_MAP );

js/membrane-channels-main.ts

@@ -3,7 +3,8 @@
 /**
  * Main entry point for the sim.
  *
- * @author Sam Reid (PhET Interactive Simulations, and Jesse Greenberg (PhET Interactive Simulations)
+ * @author Sam Reid (PhET Interactive Simulations
+ * @author Jesse Greenberg (PhET Interactive Simulations)
  */
 
 import Sim, { SimOptions } from '../../joist/js/Sim.js';
@@ -25,11 +26,10 @@ simLauncher.launch( () => {
 
   const options: SimOptions = {
 
-    //TODO fill in credits, all of these fields are optional, see joist.CreditsNode
     credits: {
-      leadDesign: '',
-      softwareDevelopment: '',
-      team: '',
+      leadDesign: 'Brett Fiedler',
+      softwareDevelopment: 'Jesse Greenberg, Sam Reid',
+      team: 'Holly Basta, Mike Klymkowsky, Mark Nielsen, Kathy Perkins, Amy Rouinfar, Taliesin Smith',
       contributors: '',
       qualityAssurance: '',
       graphicArts: '',

js/membrane-channels/MembraneChannelsScreen.ts

@@ -1,22 +1,19 @@
 // Copyright 2024, University of Colorado Boulder
 
 /**
- * TODO Describe this class and its responsibilities.
- *
- * @author Sam Reid (PhET Interactive Simulations, and Jesse Greenberg (PhET Interactive Simulations)
+ * @author Sam Reid (PhET Interactive Simulations
+ * @author Jesse Greenberg (PhET Interactive Simulations)
  */
 
 import Screen, { ScreenOptions } from '../../../joist/js/Screen.js';
-import optionize from '../../../phet-core/js/optionize.js';
+import optionize, { EmptySelfOptions } from '../../../phet-core/js/optionize.js';
 import MembraneChannelsColors from '../common/MembraneChannelsColors.js';
 import membraneChannels from '../membraneChannels.js';
 import MembraneChannelsStrings from '../MembraneChannelsStrings.js';
 import MembraneChannelsModel from './model/MembraneChannelsModel.js';
 import MembraneChannelsScreenView from './view/MembraneChannelsScreenView.js';
 
-type SelfOptions = {
-  //TODO add options that are specific to MembraneChannelsScreen here
-};
+type SelfOptions = EmptySelfOptions;
 
 type MembraneChannelsScreenOptions = SelfOptions & ScreenOptions;
 
@@ -26,10 +23,6 @@ export default class MembraneChannelsScreen extends Screen<MembraneChannelsModel
 
     const options = optionize<MembraneChannelsScreenOptions, SelfOptions, ScreenOptions>()( {
       name: MembraneChannelsStrings.screen.nameStringProperty,
-
-      //TODO add default values for optional SelfOptions here
-
-      //TODO add default values for optional ScreenOptions here
       backgroundColorProperty: MembraneChannelsColors.screenBackgroundColorProperty
     }, providedOptions );
 

js/membrane-channels/model/MembraneChannelsModel.ts

@@ -1,41 +1,39 @@
 // Copyright 2024, University of Colorado Boulder
 
 /**
- * TODO Describe this class and its responsibilities.
- *
- * @author Sam Reid (PhET Interactive Simulations, and Jesse Greenberg (PhET Interactive Simulations)
+ * @author Sam Reid (PhET Interactive Simulations
+ * @author Jesse Greenberg (PhET Interactive Simulations)
  */
 
 import TModel from '../../../../joist/js/TModel.js';
+import { EmptySelfOptions } from '../../../../phet-core/js/optionize.js';
 import PickRequired from '../../../../phet-core/js/types/PickRequired.js';
 import { PhetioObjectOptions } from '../../../../tandem/js/PhetioObject.js';
 import membraneChannels from '../../membraneChannels.js';
 
-type SelfOptions = {
-  //TODO add options that are specific to MembraneChannelsModel here
-};
+type SelfOptions = EmptySelfOptions;
 
 type MembraneChannelsModelOptions = SelfOptions & PickRequired<PhetioObjectOptions, 'tandem'>;
 
 export default class MembraneChannelsModel implements TModel {
 
   public constructor( providedOptions: MembraneChannelsModelOptions ) {
-    //TODO
+    console.log( 'TODO' );
   }
 
   /**
    * Resets the model.
    */
   public reset(): void {
-    //TODO
+    console.log( 'TODO' );
   }
 
   /**
    * Steps the model.
    * @param dt - time step, in seconds
    */
   public step( dt: number ): void {
-    //TODO
+    console.log( 'TODO' );
   }
 }
 

js/membrane-channels/view/MembraneChannelsScreenView.ts

@@ -1,21 +1,18 @@
 // Copyright 2024, University of Colorado Boulder
 
 /**
- * TODO Describe this class and its responsibilities.
- *
- * @author Sam Reid (PhET Interactive Simulations, and Jesse Greenberg (PhET Interactive Simulations)
+ * @author Sam Reid (PhET Interactive Simulations
+ * @author Jesse Greenberg (PhET Interactive Simulations)
  */
 
 import ScreenView, { ScreenViewOptions } from '../../../../joist/js/ScreenView.js';
-import optionize from '../../../../phet-core/js/optionize.js';
+import optionize, { EmptySelfOptions } from '../../../../phet-core/js/optionize.js';
 import ResetAllButton from '../../../../scenery-phet/js/buttons/ResetAllButton.js';
 import MembraneChannelsConstants from '../../common/MembraneChannelsConstants.js';
 import membraneChannels from '../../membraneChannels.js';
 import MembraneChannelsModel from '../model/MembraneChannelsModel.js';
 
-type SelfOptions = {
- //TODO add options that are specific to MembraneChannelsScreenView here
-};
+type SelfOptions = EmptySelfOptions;
 
 type MembraneChannelsScreenViewOptions = SelfOptions & ScreenViewOptions;
 
@@ -24,10 +21,6 @@ export default class MembraneChannelsScreenView extends ScreenView {
   public constructor( model: MembraneChannelsModel, providedOptions: MembraneChannelsScreenViewOptions ) {
 
     const options = optionize<MembraneChannelsScreenViewOptions, SelfOptions, ScreenViewOptions>()( {
-
-      //TODO add default values for optional SelfOptions here
-
-      //TODO add default values for optional ScreenViewOptions here
     }, providedOptions );
 
     super( options );
@@ -49,15 +42,15 @@ export default class MembraneChannelsScreenView extends ScreenView {
    * Resets the view.
    */
   public reset(): void {
-    //TODO
+    console.log( 'TODO' );
   }
 
   /**
    * Steps the view.
    * @param dt - time step, in seconds
    */
   public override step( dt: number ): void {
-    //TODO
+    console.log( 'TODO' );
   }
 }
 

js/membraneChannels.ts

@@ -3,7 +3,8 @@
 /**
  * Creates the namespace for this simulation.
  *
- * @author Sam Reid (PhET Interactive Simulations, and Jesse Greenberg (PhET Interactive Simulations)
+ * @author Sam Reid (PhET Interactive Simulations
+ * @author Jesse Greenberg (PhET Interactive Simulations)
  */
 
 import Namespace from '../../phet-core/js/Namespace.js';