convert ReleaseBranch to typescript, #369

js/browser-and-node/types/Dependencies.ts

@@ -0,0 +1,8 @@
+// Copyright 2024, University of Colorado Boulder
+/**
+ * Collection of usable types for build tools
+ * @author Michael Kauzmann (PhET Interactive Simulations)
+ */
+
+type Dependencies = Record<string, { sha: string; branch?: string }>;
+export default Dependencies;

js/build-server/taskWorker.js

@@ -16,7 +16,7 @@ const writePhetHtaccess = require( './writePhetHtaccess' );
 const writePhetioHtaccess = require( '../common/writePhetioHtaccess' );
 const deployImages = require( './deployImages' );
 const persistentQueue = require( './persistentQueue' );
-const ReleaseBranch = require( '../common/ReleaseBranch' );
+const ReleaseBranch = require( '../common/ReleaseBranch' ).default;
 const loadJSON = require( '../common/loadJSON' );
 
 /**

js/common/ChipperVersion.js

@@ -8,12 +8,8 @@
 const assert = require( 'assert' );
 const fs = require( 'fs' );
 
-/**
- * TODO:  remove this workaround jsdoc once this file is in TypeScript, https://github.com/phetsims/perennial/issues/369
- * @type
- */
-module.exports = ( function() {
 
+class ChipperVersion {
   /**
    * @public
    * @constructor
@@ -23,7 +19,7 @@ module.exports = ( function() {
    * @param {number} maintenance - The maintenance part of the version (the 2 in 3.1.2)
    * @param {boolean} chipperSupportsOutputJSGruntTasks - Flag that indicates whether grunt supports the family of commands like `output-js-project`
    */
-  function ChipperVersion( major, minor, maintenance, chipperSupportsOutputJSGruntTasks ) {
+  constructor( major, minor, maintenance, chipperSupportsOutputJSGruntTasks ) {
 
     assert( typeof major === 'number' && major >= 0 && major % 1 === 0, 'major version should be a non-negative integer' );
     assert( typeof minor === 'number' && minor >= 0 && minor % 1 === 0, 'minor version should be a non-negative integer' );
@@ -36,22 +32,22 @@ module.exports = ( function() {
     this.chipperSupportsOutputJSGruntTasks = chipperSupportsOutputJSGruntTasks;
   }
 
-  // Can't rely on inherit existing
-  ChipperVersion.prototype = {
-    constructor: ChipperVersion,
-
-    /**
-     * Returns a string form of the version.
-     * @public
-     *
-     * @returns {string}
-     */
-    toString: function() {
-      return `${this.major}.${this.minor}.${this.maintenance}`;
-    }
-  };
+  /**
+   * Returns a string form of the version.
+   * @public
+   *
+   * @returns {string}
+   */
+  toString() {
+    return `${this.major}.${this.minor}.${this.maintenance}`;
+  }
 
-  ChipperVersion.getFromPackageJSON = function( packageJSON ) {
+  /**
+   * @public
+   * @param packageJSON
+   * @returns {ChipperVersion}
+   */
+ static getFromPackageJSON( packageJSON ) {
     const versionString = packageJSON.version;
 
     const matches = versionString.match( /(\d+)\.(\d+)\.(\d+)/ );
@@ -66,19 +62,19 @@ module.exports = ( function() {
     const chipperSupportsOutputJSGruntTasks = packageJSON.phet && packageJSON.phet.chipperSupportsOutputJSGruntTasks;
 
     return new ChipperVersion( major, minor, maintenance, chipperSupportsOutputJSGruntTasks );
-  };
+  }
 
   /**
    * Returns the chipper version of the currently-checked-out chipper repository.
    * @public
    *
    * @returns {ChipperVersion}
    */
-  ChipperVersion.getFromRepository = function() {
+ static getFromRepository() {
     return ChipperVersion.getFromPackageJSON(
       JSON.parse( fs.readFileSync( '../chipper/package.json', 'utf8' ) )
     );
-  };
+  }
+}
 
-  return ChipperVersion;
-} )();
+module.exports = ChipperVersion;

js/common/Maintenance.js

@@ -11,7 +11,7 @@ const rc = require( '../grunt/rc' );
 const ChipperVersion = require( './ChipperVersion' );
 const ModifiedBranch = require( './ModifiedBranch' );
 const Patch = require( './Patch' );
-const ReleaseBranch = require( './ReleaseBranch' );
+const ReleaseBranch = require( './ReleaseBranch' ).default;
 const build = require( './build' );
 const checkoutMain = require( './checkoutMain' );
 const checkoutTarget = require( './checkoutTarget' );

js/common/ModifiedBranch.js

@@ -7,7 +7,7 @@
  */
 
 const Patch = require( './Patch' );
-const ReleaseBranch = require( './ReleaseBranch' );
+const ReleaseBranch = require( './ReleaseBranch' ).default;
 const SimVersion = require( '../browser-and-node/SimVersion' ).default;
 const checkoutDependencies = require( './checkoutDependencies' );
 const getDependencies = require( './getDependencies' );