chore: stop aliasing typescript in dependencies (#3623)

Aliasing `typescript` to `typescript-3.9` results in occasionally
surprising hoisting behavior, in particular using `npm 18`. In
particular, if two distinct  versions of `typescript` are installed,
aliasing allows both to be hoisted at the top-level, which results in
ambiguity as to which of them gets to have the `node_modules/.bin/tsc`
symlink.

This PR stops aliasing `typescript` to `typescript-3.9` and does the
necessary work to ensure builds continue to operate smoothly, menaing
it replaced TypeScript configuration files for jest with plain ESM
configuration files including typed JSDoc comments (for IDE supprot to
continue working as before), as `jest` otherwise uses `ts-node` to
transform the configuration files, and  `ts-node` uses the "most local"
`typescript` library to perform this parsing (and unfortunately,
`[email protected]` does not support the `ES2020` target we are using).


This also required allowing `jsii.tsc.types` to be specified in the
`package.json` file of jsii projects, as otherwise the TypeScript
compiler attempts to load `@types/*` packages that are not compatible
with `[email protected]` (for example, `@synclair/typebox` requires
`typescript@>=4.5`). This setting is anyway generally useful in
complex monorepo situations.

---

By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license].

[Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0

Author: RomainMuller

eslint-config.yaml

@@ -1,5 +1,6 @@
 ---
 env:
+  es2020: true
   jest: true
   node: true
 
@@ -10,9 +11,9 @@ plugins:
 
 parser: '@typescript-eslint/parser'
 parserOptions:
-  ecmaVersion: 2018
+  ecmaVersion: 2020
   impliedStrict: true
-  sourceType: module
+  sourceType: script
   project: ./**/tsconfig.json
 
 extends:

gh-pages/content/user-guides/lib-author/configuration/index.md

@@ -1,4 +1,4 @@
-import type { Config } from '@jest/types';
+import jest from '@jest/types';
 import { defaults } from 'jest-config';
 import { cpus } from 'os';
 import { env } from 'process';
@@ -10,8 +10,10 @@ import { env } from 'process';
  * be overridden (for example, the coverage threshold), then a new
  * `jest.config.ts` file should be created that imports from this one and
  * modifies just what needs to be modified, typically using `overriddenConfig`.
+ *
+ * @type {jest.Config.InitialOptions}
  */
-const config: Config.InitialOptions = {
+const config = {
   ...defaults,
 
   collectCoverage: true,
@@ -41,32 +43,31 @@ const config: Config.InitialOptions = {
  * operation works deeply on objects, but overrides that are not objects (e.g:
  * arrays, strings, ...) simply replace the original value.
  *
- * @param overrides values to be used for overriding the orignal configuration.
+ * @param {jest.Config.InitialOptions} overrides values to be used for overriding the orignal configuration.
+ *
+ * @return {jest.Config.InitialOptions}
  */
-export function overriddenConfig(overrides: Config.InitialOptions) {
+export function overriddenConfig(overrides) {
   return merge(config, overrides);
 
-  function merge<T>(original: T, override: T): T {
+  function merge(original, override) {
     if (typeof original === 'object') {
       // Arrays are objects, too!
       if (Array.isArray(override)) {
         return override;
       }
 
-      const result: any = {};
+      const result = {};
       const allKeys = new Set([
         ...Object.keys(original),
         ...Object.keys(override),
       ]);
 
       // TypeScript appears to choke if we do the "as any" in the same
       // expression as the key access, so we delcare surrogate varibales...
-      const originalAsAny = original as any;
-      const overrideAsAny = override as any;
-
       for (const key of Array.from(allKeys).sort()) {
-        const originalValue: unknown = originalAsAny[key];
-        const overrideValue: unknown = overrideAsAny[key];
+        const originalValue = original[key];
+        const overrideValue = override[key];
         if (originalValue == null) {
           result[key] = overrideValue;
         } else if (overrideValue == null) {

jest.config.ts renamed to jest.config.mjs

@@ -50,10 +50,14 @@
     ],
     "nohoist": [
       "**/@fixtures/jsii-calc-bundled",
-      "**/@fixtures/jsii-calc-bundled/**"
+      "**/@fixtures/jsii-calc-bundled/**",
+      "**/typescript"
     ]
   },
   "resolutions": {
-    "@types/prettier": "2.6.0"
+    "minipass": "3.2.1"
+  },
+  "resolutions_info": {
+    "minipass": "https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/60901"
   }
 }

package.json

@@ -2,7 +2,7 @@ import { Compiler } from 'jsii/lib/compiler';
 import { loadProjectInfo } from 'jsii/lib/project-info';
 import * as path from 'node:path';
 import * as process from 'node:process';
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import type { Context } from '.';
 

packages/@jsii/benchmarks/lib/suite/aws-cdk-lib/build-with-jsii.ts

@@ -1,7 +1,7 @@
 import * as fs from 'fs-extra';
 import * as path from 'node:path';
 import * as process from 'node:process';
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import type { Context } from '.';
 

packages/@jsii/benchmarks/lib/suite/aws-cdk-lib/build-with-tsc.ts

@@ -9,7 +9,7 @@
     "jsii": "^0.0.0",
     "npm": "^8.12.1",
     "tar": "^6.1.11",
-    "typescript-3.9": "npm:typescript@~3.9.10",
+    "typescript": "~3.9.10",
     "yargs": "^16.2.0"
   },
   "devDependencies": {

packages/@jsii/benchmarks/package.json

@@ -4,7 +4,7 @@ import * as glob from 'glob';
 import * as os from 'os';
 import * as path from 'path';
 import * as tar from 'tar';
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { cdkTagv2_21_1, cdkv2_21_1 } from '../lib/constants';
 

packages/@jsii/benchmarks/scripts/snapshot-package.ts

@@ -1,4 +1,4 @@
-import { overriddenConfig } from '../../../jest.config';
+import { overriddenConfig } from '../../../jest.config.mjs';
 
 export default overriddenConfig({
   coveragePathIgnorePatterns: [

packages/@jsii/runtime/jest.config.ts renamed to packages/@jsii/check-node/jest.config.mjs

@@ -1,4 +1,4 @@
-import { overriddenConfig } from '../../../jest.config';
+import { overriddenConfig } from '../../../jest.config.mjs';
 
 export default overriddenConfig({
   // We don't need coverage for the integration tests

packages/@jsii/integ-test/jest.config.ts renamed to packages/@jsii/integ-test/jest.config.mjs

@@ -0,0 +1,3 @@
+import config from '../../../jest.config.mjs';
+
+export default config;

packages/@jsii/kernel/jest.config.mjs

@@ -1,4 +1,4 @@
-import { overriddenConfig } from '../../../jest.config';
+import { overriddenConfig } from '../../../jest.config.mjs';
 
 export default overriddenConfig({
   coveragePathIgnorePatterns: [

packages/@jsii/kernel/jest.config.ts

@@ -1,4 +1,4 @@
-import { overriddenConfig } from '../../../jest.config';
+import { overriddenConfig } from '../../../jest.config.mjs';
 
 export default overriddenConfig({
   coverageThreshold: {

packages/@jsii/check-node/jest.config.ts renamed to packages/@jsii/runtime/jest.config.mjs

@@ -58,7 +58,8 @@
     },
     "tsc": {
       "outDir": "./build",
-      "rootDir": "."
+      "rootDir": ".",
+      "types": []
     },
     "versionFormat": "short",
     "metadata": {

packages/@jsii/spec/jest.config.ts renamed to packages/@jsii/spec/jest.config.mjs

@@ -72,6 +72,9 @@
         "module": "scope.jsii_calc_base"
       }
     },
+    "tsc": {
+      "types": []
+    },
     "versionFormat": "short"
   }
 }

packages/@scope/jsii-calc-base-of-base/package.json

@@ -70,7 +70,8 @@
     },
     "tsc": {
       "outDir": "build",
-      "sourceMap": false
+      "sourceMap": false,
+      "types": []
     },
     "versionFormat": "short",
     "metadata": {

packages/@scope/jsii-calc-base/package.json

@@ -0,0 +1,3 @@
+import config from '../../jest.config.mjs';
+
+export default config;

packages/@scope/jsii-calc-lib/package.json

@@ -81,6 +81,11 @@
         ]
       }
     },
+    "tsc": {
+      "types": [
+        "node"
+      ]
+    },
     "metadata": {
       "jsii:boolean": true,
       "jsii:number": 1337,

packages/codemaker/jest.config.mjs

@@ -0,0 +1,3 @@
+import config from '../../jest.config.mjs';
+
+export default config;

packages/codemaker/jest.config.ts

@@ -0,0 +1,3 @@
+import config from '../../jest.config.mjs';
+
+export default config;

packages/jsii-calc/package.json

@@ -1,4 +1,4 @@
-import { overriddenConfig } from '../../jest.config';
+import { overriddenConfig } from '../../jest.config.mjs';
 
 export default overriddenConfig({
   coveragePathIgnorePatterns: ['/node_modules/', '<rootDir>/test'],

packages/jsii-config/jest.config.mjs

@@ -1,4 +1,4 @@
-import { overriddenConfig } from '../../jest.config';
+import { overriddenConfig } from '../../jest.config.mjs';
 
 export default overriddenConfig({
   coverageThreshold: {

packages/jsii-config/jest.config.ts

@@ -0,0 +1,6 @@
+import { createRequire } from 'node:module';
+import { overriddenConfig } from '../../jest.config.mjs';
+
+export default overriddenConfig({
+  setupFiles: [createRequire(import.meta.url).resolve('./jestsetup.js')],
+});

packages/jsii-diff/jest.config.mjs

@@ -1,6 +1,6 @@
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { createSourceFile, ScriptKind, ScriptTarget, SyntaxKind } from 'typescript-3.9';
+import { createSourceFile, ScriptKind, ScriptTarget, SyntaxKind } from 'typescript';
 
 import { TypeScriptSnippet, SnippetParameters, ApiLocation } from './snippet';
 

packages/jsii-diff/jest.config.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { inferredTypeOfExpression, BuiltInType, builtInTypeName, mapElementType } from '../typescript/types';
 import { hasAnyFlag, analyzeStructType, JsiiSymbol } from './jsii-utils';

packages/jsii-pacmak/jest.config.ts renamed to packages/jsii-pacmak/jest.config.mjs

@@ -1,6 +1,6 @@
 import * as spec from '@jsii/spec';
 import { symbolIdentifier } from 'jsii';
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { AstRenderer } from '../renderer';
 import { typeContainsUndefined } from '../typescript/types';

packages/jsii-reflect/jest.config.ts renamed to packages/jsii-reflect/jest.config.mjs

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { determineJsiiType, JsiiType, ObjectLiteralStruct } from '../jsii/jsii-types';
 import { JsiiSymbol, simpleName, namespaceName } from '../jsii/jsii-utils';

packages/jsii-rosetta/jest.config.mjs

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { analyzeObjectLiteral, ObjectLiteralStruct } from '../jsii/jsii-types';
 import { isNamedLikeStruct, isJsiiProtocolType } from '../jsii/jsii-utils';

packages/jsii-rosetta/jest.config.ts

@@ -1,7 +1,7 @@
 // import { JsiiSymbol, simpleName, namespaceName } from '../jsii/jsii-utils';
 // import { jsiiTargetParameter } from '../jsii/packages';
 import { AssertionError } from 'assert';
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { analyzeObjectLiteral, determineJsiiType, JsiiType, ObjectLiteralStruct } from '../jsii/jsii-types';
 import { OTree } from '../o-tree';

packages/jsii-rosetta/lib/fixtures.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { determineJsiiType, JsiiType, analyzeObjectLiteral, ObjectLiteralStruct } from '../jsii/jsii-types';
 import { JsiiSymbol, simpleName, namespaceName } from '../jsii/jsii-utils';

packages/jsii-rosetta/lib/jsii/jsii-types.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { determineJsiiType, JsiiType, ObjectLiteralStruct } from '../jsii/jsii-types';
 import {

packages/jsii-rosetta/lib/jsii/jsii-utils.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { lookupJsiiSymbol } from '../jsii/jsii-utils';
 import { TargetLanguage } from '../languages/target-language';

packages/jsii-rosetta/lib/languages/csharp.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { OTree } from '../o-tree';
 import { AstRenderer, AstHandler, nimpl, CommentSyntax } from '../renderer';

packages/jsii-rosetta/lib/languages/default.ts

@@ -11,7 +11,7 @@ export class ReplaceTypeScriptTransform extends ReplaceCodeTransform {
   public constructor(api: ApiLocation, strict: boolean, replacer: TypeScriptReplacer) {
     super((block, line) => {
       const languageParts = block.language ? block.language.split(' ') : [];
-      if (languageParts[0] !== 'typescript-3.9' && languageParts[0] !== 'ts') {
+      if (languageParts[0] !== 'typescript' && languageParts[0] !== 'ts') {
         return block;
       }
 

packages/jsii-rosetta/lib/languages/go.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { TargetLanguage } from './languages';
 import { NO_SYNTAX, OTree, UnknownSyntax, Span } from './o-tree';

packages/jsii-rosetta/lib/languages/java.ts

@@ -259,7 +259,7 @@ export class RosettaTabletReader {
 
     const translated = this.translateSnippet(snippet, targetLang);
 
-    return translated ?? { language: 'typescript-3.9', source: example };
+    return translated ?? { language: 'typescript', source: example };
   }
 
   /**

packages/jsii-rosetta/lib/languages/python.ts

@@ -206,7 +206,7 @@ export class TranslatedSnippet {
   public get originalSource(): Translation {
     return {
       source: this.snippet.translations[ORIGINAL_SNIPPET_KEY].source,
-      language: 'typescript-3.9',
+      language: 'typescript',
       didCompile: this.snippet.didCompile,
     };
   }

packages/jsii-rosetta/lib/languages/record-references.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 import { inspect } from 'util';
 
 import { TARGET_LANGUAGES, TargetLanguage } from './languages';

packages/jsii-rosetta/lib/languages/visualize.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { AstRenderer } from '../renderer';
 

packages/jsii-rosetta/lib/markdown/replace-typescript-transform.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { JsiiSymbol, parentSymbol, lookupJsiiSymbolFromNode } from '../jsii/jsii-utils';
 import { AstRenderer } from '../renderer';

packages/jsii-rosetta/lib/renderer.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 import { Spans } from './visible-spans';
 

packages/jsii-rosetta/lib/rosetta-reader.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript-3.9';
+import * as ts from 'typescript';
 
 export class TypeScriptCompiler {
   private readonly realHost = ts.createCompilerHost(STANDARD_COMPILER_OPTIONS, true);