use IntentionalPerennialAny, #369

eslint.config.mjs

@@ -2,21 +2,13 @@
 
 import nodeEslintConfig from './js/eslint/config/node.eslint.config.mjs';
 
-export const perennialRules = {
-  rules: {
-
-    // There is a complication about importing phet-core from perennial, so use `any` in this repo
-    '@typescript-eslint/no-explicit-any': 'off'
-  }
-};
 
 /**
  * @author Sam Reid (PhET Interactive Simulations)
  * @author Michael Kauzmann (PhET Interactive Simulations)
  */
 export default [
   ...nodeEslintConfig,
-  perennialRules,
   {
     rules: {
 

js/common/PerennialTypes.ts → js/browser-and-node/PerennialTypes.ts

@@ -4,4 +4,7 @@
  * @author Michael Kauzmann (PhET Interactive Simulations)
  */
 
-export type Repo = string;
+export type Repo = string;
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type IntentionalPerennialAny = any;

js/browser-and-node/affirm.ts

@@ -1,5 +1,16 @@
 // Copyright 2024, University of Colorado Boulder
 
+import { IntentionalPerennialAny } from './PerennialTypes.js';
+
+// Define an interface that includes the optional 'assert' property
+type GlobalWithAssert = {
+  assert?: boolean;
+};
+
+// Respect the global assert flag, which can be set to false to disable all assertions
+const isBrowser = globalThis.hasOwnProperty( 'window' );
+const isNode = !isBrowser;
+
 /**
  * Like assert.js, with the following differences:
  *
@@ -12,20 +23,9 @@
  * the term `affirm` is not otherwise used in our codebase.
  *
  * @author Sam Reid (PhET Interactive Simulations)
+ * @author Michael Kauzmann (PhET Interactive Simulations)
  */
-
-type IntentionalAny = any;
-
-// Define an interface that includes the optional 'assert' property
-type GlobalWithAssert = {
-  assert?: boolean;
-};
-
-// Respect the global assert flag, which can be set to false to disable all assertions
-const isBrowser = globalThis.hasOwnProperty( 'window' );
-const isNode = !isBrowser;
-
-export default function affirm( predicate: unknown, ...messages: IntentionalAny[] ): asserts predicate {
+export default function affirm( predicate: unknown, ...messages: IntentionalPerennialAny[] ): asserts predicate {
 
   // Cast 'globalThis' to 'GlobalWithAssert' to access 'assert' safely
   const isAssertEnabled = isNode || ( globalThis as GlobalWithAssert ).assert;

js/browser-and-node/eslint.config.mjs

@@ -1,14 +1,12 @@
 // Copyright 2024, University of Colorado Boulder
 
 
-import { perennialRules } from '../../eslint.config.mjs';
 import browserAndNodeEslintConfig from '../eslint/config/browser-and-node.eslint.config.mjs';
 
 /**
  * @author Sam Reid (PhET Interactive Simulations)
  * @author Michael Kauzmann (PhET Interactive Simulations)
  */
 export default [
-  ...browserAndNodeEslintConfig,
-  perennialRules
+  ...browserAndNodeEslintConfig
 ];

js/eslint/divideIntoBatches.ts

@@ -1,7 +1,7 @@
 // Copyright 2024, University of Colorado Boulder
 
 import os from 'os';
-import { Repo } from '../common/PerennialTypes.js';
+import { Repo } from '../browser-and-node/PerennialTypes.js';
 
 const MAX_BATCH_SIZE = 50;
 

js/eslint/getLintCLIOptions.ts

@@ -1,7 +1,7 @@
 // Copyright 2024, University of Colorado Boulder
 
 import getRepoList from '../common/getRepoList.js';
-import { Repo } from '../common/PerennialTypes.js';
+import { Repo } from '../browser-and-node/PerennialTypes.js';
 /**
  * Parse command line options for linting.
  *

js/eslint/lint-main.ts

@@ -26,7 +26,7 @@ import fs from 'fs';
 import _ from 'lodash';
 import path from 'path';
 import process from 'process';
-import { Repo } from '../common/PerennialTypes.js';
+import { Repo } from '../browser-and-node/PerennialTypes.js';
 import { tscCleanRepo } from '../grunt/check.js';
 import { DEBUG_PHET_LINT } from './lint.js';
 

js/eslint/lint.ts

@@ -15,7 +15,7 @@ import { spawn } from 'child_process';
 import _ from 'lodash';
 import path from 'path';
 import dirname from '../common/dirname.js';
-import { Repo } from '../common/PerennialTypes.js';
+import { Repo } from '../browser-and-node/PerennialTypes.js';
 import tsxCommand from '../common/tsxCommand.js';
 import divideIntoBatches from './divideIntoBatches.js';
 import { DEFAULT_MAX_PROCESSES, LintOptions } from './getLintCLIOptions.js';

js/grunt/check.ts

@@ -14,7 +14,7 @@ import os from 'os';
 import path from 'path';
 import fixEOL from '../common/fixEOL.js';
 import { PERENNIAL_ROOT } from '../common/perennialRepoUtils.js';
-import { Repo } from '../common/PerennialTypes.js';
+import { Repo } from '../browser-and-node/PerennialTypes.js';
 
 const ALL_CONFIG_PATH = `${PERENNIAL_ROOT}/../chipper/dist/tsconfig/all/`;
 const tscCommand = `${PERENNIAL_ROOT}/node_modules/typescript/bin/tsc`;

js/grunt/tasks/generate-data.ts

@@ -1,5 +1,7 @@
 // Copyright 2024, University of Colorado Boulder
 
+import { IntentionalPerennialAny } from '../../browser-and-node/PerennialTypes.js';
+
 /**
  * Generates the lists under perennial/data/, and if there were changes, will commit and push.
  *
@@ -39,7 +41,7 @@ async function generateData(): Promise<void> {
 
   const activeRepos: string[] = getActiveRepos();
 
-  function writeList( name: string, packageFilter: ( repo: any ) => void ): void {
+  function writeList( name: string, packageFilter: ( repo: IntentionalPerennialAny ) => void ): void {
     const repos = activeRepos.filter( repo => {
       // Make sure that if someone doesn't have all repositories checked out that this will FAIL. Otherwise bad things.
       assert( grunt.file.exists( `../${repo}` ) );

js/grunt/tasks/util/getOption.ts

@@ -7,10 +7,11 @@
 // Use nopt to guarantee compatibility with grunt. See usage site: https://github.com/phetsims/chipper/issues/1459
 // See usage in chipper/node_modules/grunt-cli/bin/grunt
 import nopt from 'nopt';
+import { IntentionalPerennialAny } from '../../../browser-and-node/PerennialTypes.js';
 
 const options = nopt( {}, {}, process.argv, 2 );
 
-export default function getOption( keyName: string ): any {
+export default function getOption( keyName: string ): IntentionalPerennialAny {
   return options[ keyName ];
 }
 

js/grunt/tasks/util/getRepo.ts

@@ -5,7 +5,7 @@ import { readFileSync } from 'fs';
 import path from 'path';
 import process from 'process';
 import dirname from '../../../common/dirname.js';
-import { Repo } from '../../../common/PerennialTypes.js';
+import { Repo } from '../../../browser-and-node/PerennialTypes.js';
 import getOption from './getOption.js';
 
 // @ts-expect-error - until we have "type": "module" in our package.json

js/phet-types.d.ts

@@ -13,16 +13,18 @@
  */
 
 // NOTE: we cannot use IntentionalAny in this file because it is a global file, and IntentionalAny is a module file
-// Therefore, we must use `any` directly in this file. See https://github.com/phetsims/perennial/issues/406
+// Therefore, we must a custom declaration. See https://github.com/phetsims/perennial/issues/406
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type Any = any;
 
-declare var assert: undefined | ( ( x: any, ...messages: any[] ) => void );
-declare var assertSlow: undefined | ( ( x: any, ...messages: any[] ) => void );
-declare var sceneryLog: null | false | ( Record<string, ( ob: any, style?: string ) => void> & {
+declare var assert: undefined | ( ( x: Any, ...messages: Any[] ) => void );
+declare var assertSlow: undefined | ( ( x: Any, ...messages: Any[] ) => void );
+declare var sceneryLog: null | false | ( Record<string, ( ob: Any, style?: string ) => void> & {
   push(): void;
   pop(): void;
   getDepth(): number;
 } );
-declare var phet: Record<string, any>;
+declare var phet: Record<string, Any>;
 
 // TODO: This can be moved to QueryStringMachine when it is moved to TypeScript, see https://github.com/phetsims/query-string-machine/issues/49
 declare type Warning = {
@@ -58,20 +60,20 @@ declare type QueryStringMachineSchema = {
     type: 'array';
     elementSchema: QueryStringMachineSchema;
     separator?: string;
-    defaultValue?: null | readonly any[];
-    validValues?: readonly any[][];
-    isValidValue?: ( n: any[] ) => boolean;
+    defaultValue?: null | readonly Any[];
+    validValues?: readonly Any[][];
+    isValidValue?: ( n: Any[] ) => boolean;
   } |
   {
     type: 'custom';
-    parse: ( str: string ) => any;
-    defaultValue?: any;
-    validValues?: readonly any[];
-    isValidValue?: ( n: any ) => boolean;
+    parse: ( str: string ) => Any;
+    defaultValue?: Any;
+    validValues?: readonly Any[];
+    isValidValue?: ( n: Any ) => boolean;
   } );
 
 // Converts a Schema's type to the actual Typescript type it represents
-declare type QueryMachineTypeToType<T> = T extends ( 'flag' | 'boolean' ) ? boolean : ( T extends 'number' ? number : ( T extends 'string' ? ( string | null ) : ( T extends 'array' ? any[] : any ) ) );
+declare type QueryMachineTypeToType<T> = T extends ( 'flag' | 'boolean' ) ? boolean : ( T extends 'number' ? number : ( T extends 'string' ? ( string | null ) : ( T extends 'array' ? Any[] : Any ) ) );
 
 type QSMSchemaObject = Record<string, QueryStringMachineSchema>;
 
@@ -88,7 +90,7 @@ declare var QueryStringMachine: {
   get: <Schema extends QueryStringMachineSchema>( a: string, schema: Schema ) => QueryMachineTypeToType<Schema[ 'type' ]>;
   containsKey: ( key: string ) => boolean;
   warnings: Warning[];
-  addWarning: ( key: string, value: any, message: string ) => void;
+  addWarning: ( key: string, value: Any, message: string ) => void;
   removeKeyValuePair: ( queryString: string, key: string ) => string;
   removeKeyValuePairs: ( queryString: string, keys: string[] ) => string;
   appendQueryString: ( url: string, tail: string ) => string;
@@ -103,7 +105,7 @@ declare var QueryStringMachine: {
 declare var phetSplashScreenDownloadComplete: () => void;
 declare var TWEEN: { update: ( dt: number ) => void };
 declare var phetSplashScreen: { dispose: () => void };
-declare var phetio: Record<string, any>;
+declare var phetio: Record<string, Any>;
 
 // Typing for linebreaker-1.1.0.js preload
 declare type LineBreakerBreak = {