Convert modulify-generated files to TypeScript

[zepumph]

From TypeScript meeting today, @samreid volunteered to take the lead. Thanks!

[samreid]

This issue will take longer since we will want to track the js=>ts changes as renames, not as delete/creates.

[zepumph]

I personally do not think we need to keep git history for these generated files. Git history for the asset itself (the image/mp3/etc) would be more important. I'm happy to be outvoted though.

[samreid]

I accept the vote above that we should not devote time to maintaining the history as renames for JS=>TS. However, I realized we still need to expend about as much effort to delete the former JS files. So I think they can be renamed like so:

execute( 'git', [ 'mv', path.basename( jsFilePath ), path.basename( tsFilePath ) ], path.dirname( jsFilePath ) );

[samreid]

I posted to slack:

As decided in this week’s dev meeting, I’m going to start converting images, sounds mipmaps, etc to TS as part of the modulify step. Please be aware and report any problems in #1218

[samreid]

In the course of working on this issue, I tested the image files and discovered that in a TypeScript sim, it correctly infers the HTMLImageElement type from both *.js and *.ts image files. Also, no changes or type annotations are required in the image files. Therefore the value of this step is questionable--might it slow down the type checker? Still, it seems we agreed on this for consistency and we will get more benefit out of the more complex modulified types.

[samreid]

I git mv renamed the modulified mipmap files from js to ts. Using this script, and manual for function-builder:

import { existsSync } from 'https://deno.land/std/fs/mod.ts';
import { extname, join } from 'https://deno.land/std/path/mod.ts';

const activeReposFile = './perennial/data/active-repos';

try {
  const data = await Deno.readTextFile( activeReposFile );
  const repos = data.split( '\n' ).filter( ( repo: string ) => repo.trim() !== '' );

  for ( const repo of repos ) {
    const mipmapsDir = `${repo}/mipmaps`;

    if ( existsSync( mipmapsDir ) ) {
      console.log( `Processing ${repo}` );

      const renameJsToTs = async ( dir: string ) => {
        for await ( const entry of Deno.readDir( dir ) ) {
          if ( entry.isFile && extname( entry.name ) === '.js' ) {
            const jsFilePath = join( 'mipmaps', entry.name );
            const tsFilePath = jsFilePath.replace( /\.js$/, '.ts' );

            // Execute the git mv command with the cwd option set to the repo directory
            const process = Deno.run( {
              cmd: [ 'git', 'mv', jsFilePath, tsFilePath ],
              cwd: repo, // Set the cwd to the repository directory
              stdout: 'piped',
              stderr: 'piped'
            } );

            const { code } = await process.status();
            if ( code === 0 ) {
              console.log( `Renamed ${jsFilePath} to ${tsFilePath}` );
            }
            else {
              const rawError = await process.stderrOutput();
              console.error( `Failed to rename ${jsFilePath}:`, new TextDecoder().decode( rawError ) );
            }

            process.close();
          }
        }
      };

      await renameJsToTs( mipmapsDir );

      // if ( repo === 'function-builder' && existsSync( `${mipmapsDir}/functions` ) ) {
      //   await renameJsToTs( `${mipmapsDir}/functions` );
      // }
    }
  }

  console.log( 'Renaming completed. Please review the changes.' );
}
catch( error ) {
  console.error( 'Error processing the repositories:', error );
}

I changed the output of grunt modulify so that mipmaps output to *.ts in this commit. I tested by running grunt modulify in buoyancy and saw that there were no changes. I tested running a built sim and unbuilt sim. All seems well.

Current status:

Output ts

• Images
• Mipmaps
• Strings
• SVG

Still in js

• Shaders
• Sounds

I am uncertain whether the value will exceed the effort for converting shaders and sounds, let's assign to @jonathanolson and @jbphet about those steps and see if they would like to work on it.

[zepumph]

Side note: All repos will get a grunt modulify tonight for the daily grunt work. That may be a good thing to look at tomorrow morning to see if any changes come in unexpectedly.

[samreid]

I also ran for-each.sh active-repos grunt modulify

[jonathanolson]

@AgustinVallejo is my-solar-system's PathsPainter (.shader and .vert, under shaders/) being used? It looks vestigial.

I've also removed the files needing transpilation in alpenglow, and I don't think we have '.glsl' suffix files, so I'm hoping we can just remove support for shader transpilation. (The alpenglow approach won't rely on the transpiler for this at all).

Also, my personal opinion is that it would be nice to move the sound files to .ts.

[jbphet]

Note to self: If I work on this, it might be a good time to also try and tackle phetsims/tambo#153.