samreid
commented
5 days ago Patch to go into npx tsx:
```diff
Subject: [PATCH] Revert multi-modal transpilation output, see https://github.com/phetsims/chipper/issues/1459
---
Index: js/grunt/typescript-test.ts
===================================================================
diff --git a/js/grunt/typescript-test.ts b/js/grunt/typescript-test.ts
deleted file mode 100644
--- a/js/grunt/typescript-test.ts (revision 00b31dedbb416ba07f5291c27f63c904ccf929b2)
+++ /dev/null (revision 00b31dedbb416ba07f5291c27f63c904ccf929b2)
@@ -1,18 +0,0 @@
-// Copyright 2024, University of Colorado Boulder
-
-/**
- * TODO: delete as part of https://github.com/phetsims/chipper/issues/1437
- * @author Michael Kauzmann (PhET Interactive Simulations)
- * @author Sam Reid (PhET Interactive Simulations)
- */
-
-module.exports = function typescriptTest() {
-
- const myTestNumber = 9;
-
- function myPrintFunc( x: number ): void {
- console.log( x );
- }
-
- myPrintFunc( myTestNumber );
-};
\ No newline at end of file
Index: js/grunt/.eslintrc.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/js/grunt/.eslintrc.js b/js/grunt/.eslintrc.js
--- a/js/grunt/.eslintrc.js (revision 00b31dedbb416ba07f5291c27f63c904ccf929b2)
+++ b/js/grunt/.eslintrc.js (date 1726152280519)
@@ -4,5 +4,31 @@
module.exports = {
// Use all of the default rules from eslint file for node code.
- extends: '../../../chipper/eslint/chipper_eslintrc.js'
+ extends: process.cwd().substring( 0, process.cwd().lastIndexOf( 'chipper' ) + 'chipper'.length ) + '/eslint/chipper_eslintrc.js',
+
+ parserOptions: {
+ sourceType: 'module'
+ },
+
+ overrides: [ {
+ files: [ '**/*.ts' ],
+
+ parserOptions: {
+
+ // Provide a tsconfig so that we can use rules that require type information.
+ // NOTE: Providing this slows down eslint substantially, see https://github.com/phetsims/chipper/issues/1114#issuecomment-1065927717
+
+ // IntelliJ runs this from chipper/js/grunt so the path is different than when running from chipper/, so we must normalize
+ // to support both IDE and command line
+ // for debugging here, you can put variables into the project then navigate to a file using this (like a *.ts file)
+ // and see the output in the bad path, or you can write to the file system.
+ project: [ process.cwd().substring( 0, process.cwd().lastIndexOf( 'chipper' ) + 'chipper'.length ) + '/tsconfig/all/tsconfig.json' ]
+ },
+
+ // disable rules @typescript-eslint/no-require-imports,@typescript-eslint/no-var-requires
+ rules: {
+ '@typescript-eslint/no-require-imports': 'off',
+ '@typescript-eslint/no-var-requires': 'off'
+ }
+ } ]
};
\ No newline at end of file
Index: tsconfig/all/tsconfig.json
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/tsconfig/all/tsconfig.json b/tsconfig/all/tsconfig.json
--- a/tsconfig/all/tsconfig.json (revision 00b31dedbb416ba07f5291c27f63c904ccf929b2)
+++ b/tsconfig/all/tsconfig.json (date 1726151891950)
@@ -32,7 +32,7 @@
"../../../center-and-variability/images/**/*",
"../../../chipper/phet-types.d.ts",
"../../../chipper/phet-types-module.d.ts",
- "../../../chipper/js/grunt/typescript-test.ts",
+ "../../../chipper/js/grunt/**/*",
"../../../circuit-construction-kit-ac/js/**/*",
"../../../circuit-construction-kit-ac-virtual-lab/js/**/*",
"../../../circuit-construction-kit-common/js/**/*",
Index: js/grunt/tasks/update.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/js/grunt/tasks/update.js b/js/grunt/tasks/update.js
--- a/js/grunt/tasks/update.js (revision 00b31dedbb416ba07f5291c27f63c904ccf929b2)
+++ b/js/grunt/tasks/update.js (date 1726152358767)
@@ -25,6 +25,7 @@
// modulify is graceful if there are no files that need modulifying.
// TODO: This used to be grunt.task.run, is plain require correct here? https://github.com/phetsims/chipper/issues/1459
+ // TODO: Does this process the command line args correctly? see https://github.com/phetsims/chipper/issues/1459
require( './modulify' );
// update README.md only for simulations
Index: js/grunt/tasks/build.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/js/grunt/tasks/build.js b/js/grunt/tasks/build.ts
rename from js/grunt/tasks/build.js
rename to js/grunt/tasks/build.ts
--- a/js/grunt/tasks/build.js (revision 00b31dedbb416ba07f5291c27f63c904ccf929b2)
+++ b/js/grunt/tasks/build.ts (date 1726152524910)
@@ -16,6 +16,8 @@
const grunt = require( 'grunt' );
const getRepo = require( './getRepo' );
+
+// @ts-expect-error - overlaps with global assert in phet-types.d.ts TODO https://github.com/phetsims/chipper/issues/1459
const assert = require( 'assert' );
const Transpiler = require( '../../common/Transpiler' );
const getBrands = require( './getBrands' );
@@ -29,12 +31,12 @@
const transpiler = new Transpiler( { silent: true } );
-( async () => {
+( async () => { /* eslint-disable-line @typescript-eslint/no-floating-promises */ // TODO: https://github.com/phetsims/chipper/issues/1459 ???
await phetTimingLog.startAsync( 'grunt-build', async () => {
// Parse minification keys
const minifyKeys = Object.keys( minify.MINIFY_DEFAULTS );
- const minifyOptions = {};
+ const minifyOptions: Record = {};
minifyKeys.forEach( minifyKey => {
const option = grunt.option( `minify.${minifyKey}` );
if ( option === true || option === false ) {
@@ -101,7 +103,7 @@
else {
const localPackageObject = grunt.file.readJSON( `../${repo}/package.json` );
- assert( localPackageObject.phet.runnable, `${repo} does not appear to be runnable` );
+ assert && assert( localPackageObject.phet.runnable, `${repo} does not appear to be runnable` );
grunt.log.writeln( `Building runnable repository (${repo}, brands: ${brands.join( ', ' )})` );
// Other options
Index: js/grunt/Gruntfile.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/js/grunt/Gruntfile.js b/js/grunt/Gruntfile.js
--- a/js/grunt/Gruntfile.js (revision 00b31dedbb416ba07f5291c27f63c904ccf929b2)
+++ b/js/grunt/Gruntfile.js (date 1726151489505)
@@ -41,13 +41,22 @@
// TODO switch to npx tsx, see https://github.com/phetsims/chipper/issues/1459 via npx ../chipper/node_modules/tsx
// TODO: test on windows, see https://github.com/phetsims/chipper/issues/1459
- const command = 'node';
+ const command = 'npx';
return () => {
const done = grunt.task.current.async();
try {
- const child = spawn( command, [ `../chipper/js/grunt/tasks/${taskFilename}`, ...process.argv.slice( 2 ) ], { stdio: [ 'inherit', 'pipe', 'pipe' ] } );
+ const child = spawn( command, [
+
+ // so we don't have to install tsx globally or in every sim repo
+ '../chipper/node_modules/tsx',
+
+ `../chipper/js/grunt/tasks/${taskFilename}`,
+ ...process.argv.slice( 2 )
+ ], {
+ stdio: [ 'inherit', 'pipe', 'pipe' ]
+ } );
child.stdout.on( 'data', data => process.stdout.write( data.toString() ) );
child.stderr.on( 'data', data => process.stderr.write( data.toString() ) );
Index: package.json
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/package.json b/package.json
--- a/package.json (revision 00b31dedbb416ba07f5291c27f63c904ccf929b2)
+++ b/package.json (date 1726146952884)
@@ -58,6 +58,7 @@
"taffydb": "~2.7.3",
"terser": "~4.6.4",
"ts-morph": "^21.0.1",
+ "tsx": "^4.19.1",
"typescript": "~5.5.4",
"webpack": "~5.76.3",
"webpack-cli": "~5.0.0",
zepumph
From an idea in https://github.com/phetsims/chipper/issues/1437, we could use grunt as a thin wrapper that spawns a new process in a runtime under our control. This will help us modularize and isolate our dependence on grunt, and allow us flexibility to use alternate runtimes such as
tsxand TypeScript.npx ../chipper/node_modules/.bin/tsx"allowSyntheticDefaultImports": trueoresModuleInteropfor imports?