Suppress prepack in test workflow (#2014)

* Rename `test-local` to `test`
Suppress `prepack` when building tarball for installation into fixture directory
Update contributing.md

* try e2es

* turn off e2es; they worked

Author: cspotcode

.github/workflows/e2e-git-installs.yml

@@ -4,6 +4,8 @@ on:
   # nightly
   schedule:
     - cron:  '0 0 * * *'
+  # To temporarily enable on your branch for verification
+  # push: {}
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
 permissions:

CONTRIBUTING.md

@@ -14,11 +14,11 @@ We use package.json scripts for building, testing, and linting.  Read the script
 ```
 yarn
 yarn build
-yarn test-local
+yarn test
 yarn fmt
 ```
 
-`npm prepare` / `yarn prepare` is maintained so that anyone can install `ts-node` from git, which is useful for testing experimental branches and unreleased features.
+`yarn prepack` / `pnpm prepack`/ `npm prepare` are maintained so that anyone can install `ts-node` from git, which is useful for testing experimental branches and unreleased features.
 
 Source lives in `src` and is compiled to `dist`.  Some shim files live outside of `src` so that they can be imported at
 certain paths.  For example, to allow users to import `ts-node/register`, we have `register/index.js` which is a shim to
@@ -28,15 +28,19 @@ compiled code in `dist`.
 
 ## Tests
 
-Test cases are declared in `src/test/*.spec.ts`, and test fixtures live in `./tests`.  They can be run with `yarn test-local`.
+Test cases are declared in `src/test/*.spec.ts`, and test fixtures live in `./tests`.  They can be run with `yarn test`.
 
 To run a subset of tests:
 
 ```
 # Use ava's --match flag to match the name of a test or suite
 # https://github.com/avajs/ava/blob/main/docs/05-command-line.md
 # Don't forget the * wildcards
-yarn test-local --match '*esm loader*'
+yarn test --match '*esm loader*'
+
+# Or pass a filename as it exists in the compiled output
+# To run the tests in ./src/test/diagnostics.spec.ts
+yarn test ./dist/test/diagnostics.spec.js
 ```
 
 Tests are run with AVA, but using a custom wrapper API to enable some TS-friendly features and grouped test suites.
@@ -83,7 +87,7 @@ By convention, if a macro function is meant to be imported and reused in multipl
 
 Macros can also be declared to require a certain "context," thanks to the namespace types described in "Test Context" above.
 
-See examples in `helpers.ts`.
+See examples in `helpers/*.ts`.
 
 ## Documentation
 

package.json

@@ -70,12 +70,13 @@
     "build-manifest": "node ./scripts/build-manifest.mjs",
     "test-spec": "ava",
     "test-cov": "nyc ava",
-    "test": "yarn build && yarn lint && yarn test-cov",
-    "test-local": "yarn fmt && yarn build-tsc && yarn build-pack && yarn test-spec",
+    "test": "yarn fmt && yarn build-tsc && yarn build-pack && yarn test-spec",
+    "test-full": "yarn build && yarn lint && yarn test-cov",
     "pre-debug": "yarn build-tsc && yarn build-pack",
     "coverage-report": "nyc report --reporter=lcov",
     "__prepack_template__": "yarn clean && yarn build-nopack",
-    "prepack": "rimraf temp dist tsconfig.schema.json tsconfig.schemastore-schema.json tsconfig.tsbuildinfo tests/ts-node-packed.tgz tests/node_modules tests/tmp && tsc -b ./tsconfig.build-dist.json && typescript-json-schema --topRef --refs --validationKeywords allOf --out tsconfig.schema.json tsconfig.build-schema.json TsConfigSchema && node --require ./register ./scripts/create-merged-schema",
+    "prepack": "node ./scripts/prepack.mjs",
+    "prepack-worker": "rimraf temp dist tsconfig.schema.json tsconfig.schemastore-schema.json tsconfig.tsbuildinfo tests/ts-node-packed.tgz tests/node_modules tests/tmp && tsc -b ./tsconfig.build-dist.json && typescript-json-schema --topRef --refs --validationKeywords allOf --out tsconfig.schema.json tsconfig.build-schema.json TsConfigSchema && node --require ./register ./scripts/create-merged-schema",
     "prepare": "workaround-broken-npm-prepack-behavior prepack",
     "api-extractor": "api-extractor run --local --verbose"
   },

scripts/build-manifest.mjs

@@ -8,11 +8,12 @@ const manifestPath = resolve(fileURLToPath(import.meta.url), '../../package.json
 const pkg = JSON.parse(readFileSync(manifestPath, 'utf8'));
 
 // Fully splat the "prepack" script so that it does not contain references to a package manager, neither `yarn` nor `npm`
-pkg.scripts.prepack = pkg.scripts.__prepack_template__;
-while (true) {
-  let before = pkg.scripts.prepack;
-  pkg.scripts.prepack = pkg.scripts.prepack.replace(/yarn (\S+)/g, ($0, $1) => pkg.scripts[$1]);
-  if (pkg.scripts.prepack === before) break;
+let before;
+let prepack = pkg.scripts.__prepack_template__;
+while (before !== prepack) {
+  before = prepack;
+  prepack = prepack.replace(/yarn (\S+)/g, ($0, $1) => pkg.scripts[$1]);
 }
+pkg.scripts['prepack-worker'] = prepack;
 
 writeFileSync(manifestPath, JSON.stringify(pkg, null, 2) + '\n');

scripts/build-pack.js

@@ -7,7 +7,13 @@ const { join } = require('path');
 const rootDir = join(__dirname, '..');
 const testDir = join(__dirname, '../tests');
 const tarballPath = join(testDir, 'ts-node-packed.tgz');
-exec(`yarn pack --out "${tarballPath}"`, { cwd: rootDir }, (err, stdout) => {
+
+const env = {
+  ...process.env,
+  TS_NODE_SKIP_PREPACK: 'true',
+};
+
+exec(`yarn pack --out "${tarballPath}"`, { cwd: rootDir, env }, (err, stdout) => {
   if (err) {
     console.error(err);
     process.exit(1);

scripts/prepack.mjs

@@ -0,0 +1,18 @@
+import { spawnSync } from 'child_process';
+const { npm_node_execpath, npm_execpath } = process.env;
+import { readFileSync } from 'fs';
+
+// prepack is executed by user's package manager when they install from git
+// So cannot assume yarn
+
+if (process.env.TS_NODE_SKIP_PREPACK == null) {
+  if (readFileSync(npm_execpath, 'utf8').match(/^#!.*sh/)) {
+    spawnSync(npm_execpath, ['run', 'prepack-worker'], {
+      stdio: 'inherit',
+    });
+  } else {
+    spawnSync(npm_node_execpath, [npm_execpath, 'run', 'prepack-worker'], {
+      stdio: 'inherit',
+    });
+  }
+}