Updated support for pnmp and yarn (#164)

This PR adds additional updates and fixes to better support pnmp and
yarn with `@github/local-action`.

Author: ncalteen

bin/local-action.js

@@ -29,10 +29,8 @@ function entrypoint() {
     // need to be double-escaped so the path resolves correctly.
     const bootstrapPath =
       process.platform === 'win32'
-        ? path
-            .join(packagePath, 'src', 'bootstrap.mts')
-            .replaceAll('\\', '\\\\')
-        : path.join(packagePath, 'src', 'bootstrap.mts')
+        ? path.join(packagePath, 'src', 'bootstrap.ts').replaceAll('\\', '\\\\')
+        : path.join(packagePath, 'src', 'bootstrap.ts')
 
     // Require the bootstrap script in NODE_OPTIONS.
     process.env.NODE_OPTIONS = process.env.NODE_OPTIONS

jest.config.ts

@@ -7,7 +7,7 @@ const config: JestConfigWithTsJest = {
   coverageDirectory: 'coverage',
   coveragePathIgnorePatterns: [
     'node_modules',
-    'src/bootstrap.mts',
+    'src/bootstrap.ts',
     'src/types/quibble.d.ts',
     'src/commands/run.ts',
     'src/stubs/artifact/artifact.ts'

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@github/local-action",
   "description": "Local Debugging for GitHub Actions",
-  "version": "3.0.5",
+  "version": "3.1.0",
   "type": "module",
   "author": "Nick Alteen <[email protected]>",
   "private": false,

package.json

@@ -0,0 +1,39 @@
+/* eslint-disable @typescript-eslint/no-require-imports */
+
+/**
+ * This file is used to bootstrap the environment for the action.
+ *
+ * It is added as a --require option to `npx tsx`. The purpose of this file is
+ * to handle various configuration options. For example, if an action repository
+ * makes use of TypeScript paths for module resolution, this bootstrap script
+ * will parse them and register them so that modules can be resolved correctly.
+ */
+
+const { existsSync, readFileSync } = require('fs')
+const { loadConfig, register } = require('tsconfig-paths')
+const { parse } = require('comment-json')
+
+if (process.env.TARGET_ACTION_PATH && process.env.TARGET_ACTION_PATH !== '') {
+  // Check if the action has a `tsconfig.json` file.
+  if (existsSync(`${process.env.TARGET_ACTION_PATH}/tsconfig.json`)) {
+    // Load the `tsconfig.json` from the action directory.
+    const actionTsConfig = parse(
+      readFileSync(`${process.env.TARGET_ACTION_PATH}/tsconfig.json`, 'utf-8')
+    )
+
+    // Load the current `tsconfig.json` from the root of this directory.
+    loadConfig(__dirname)
+
+    // Get the paths from the action's `tsconfig.json`, if any.
+    const paths = actionTsConfig.compilerOptions?.paths ?? {}
+
+    // Add any path mappings from the imported action. Replace the base URL with
+    // the target action path.
+    // @todo Should this take into account the previous `baseUrl` value?
+    register({
+      baseUrl: process.env.TARGET_ACTION_PATH,
+      paths,
+      addMatchAll: true
+    })
+  }
+}

src/bootstrap.mts

@@ -32,6 +32,8 @@ export async function action(): Promise<void> {
     yellow: (msg: string) => console.log(chalk.yellow(msg))
   }
 
+  const actionType = isESM() ? 'esm' : 'cjs'
+
   // Output the configuration
   printTitle(CoreMeta.colors.cyan, 'Configuration')
   console.log()
@@ -134,11 +136,23 @@ export async function action(): Promise<void> {
       'No package.json file found in the action directory or any parent directories.'
     )
 
-  // If the package manager is `npm` or `pnpm`, then a `node_modules` directory
-  // should exist somewhere in the project. If the package manager is `yarn`,
-  // then we need to first check for `node_modules` (for non-PnP versions), or
-  // we can try unplugging the dependencies from the yarn cache.
-  if (process.env.NODE_PACKAGE_MANAGER === 'npm') {
+  // If the package manager is `npm`, we can assume there is a `node_modules`
+  // directory somewhere in the project.
+  //
+  // Actions that use `pnpm` will also have a `node_modules` directory, however
+  // in testing it seems that the `node_modules/@actions/<pkg>` dependency can
+  // only be properly stubbed for CJS actions. For ESM actions, this should
+  // instead point to the pnpm cache.
+  //
+  // If the package manager is `yarn`, then we need to first check for
+  // `node_modules` (for non-PnP versions), or we can try unplugging the
+  // dependencies from the yarn cache.
+  if (
+    process.env.NODE_PACKAGE_MANAGER === 'npm' ||
+    (process.env.NODE_PACKAGE_MANAGER === 'pnpm' && actionType === 'cjs') ||
+    (process.env.NODE_PACKAGE_MANAGER === 'yarn' &&
+      fs.existsSync(path.join(EnvMeta.actionPath, 'node_modules')))
+  ) {
     /**
      * Get the path in the npm cache for each package.
      * `npm ls <package> --json --long`
@@ -179,7 +193,10 @@ export async function action(): Promise<void> {
     Object.keys(stubs).forEach(key => {
       stubs[key as keyof typeof stubs].base = npmList.dependencies?.[key]?.path
     })
-  } else if (process.env.NODE_PACKAGE_MANAGER === 'pnpm') {
+  } else if (
+    process.env.NODE_PACKAGE_MANAGER === 'pnpm' &&
+    actionType === 'esm'
+  ) {
     /**
      * Get the path in the pnpm cache for each package.
      * `pnpm list <package> --json`
@@ -217,87 +234,38 @@ export async function action(): Promise<void> {
         pnpmList[0].dependencies?.[key]?.path
     })
   } else if (process.env.NODE_PACKAGE_MANAGER === 'yarn') {
-    // Depending on the version and configuration for yarn, a `node_modules`
-    // directory may or may not exist. Also, the CLI commands are different
-    // across versions for getting the path to a dependency.
-
-    // First check if a `node_modules` directory exists in the target action
-    // path (or a parent path).
-    if (fs.existsSync(path.join(EnvMeta.actionPath, 'node_modules'))) {
-      // Get the path in the npm cache for each package. This will work if there
-      // is a `node_modules` directory (`yarn list` does not provide the path).
-      // `npm ls <package> --json --long`
-
-      /**
-       * Example Output
-       *
-       * {
-       *   "path": "<workspace>/typescript-action",
-       *   "_dependencies": {
-       *     "@actions/core": "^1.11.1",
-       *     "@actions/github": "^6.0.0"
-       *   },
-       *   "dependencies": {
-       *     "@actions/core": {
-       *       "path": "<workspace>/typescript-action/node_modules/@actions/core",
-       *     },
-       *     "@actions/github": {
-       *       "path": "<workspace>/typescript-action/node_modules/@actions/github",
-       *     }
-       *   }
-       * }
-       */
-      const npmList = JSON.parse(
-        execSync(
-          `npm ls ${Object.keys(stubs).join(' ')} --json --long`
-        ).toString()
-      ) as {
-        path: string
-        dependencies?: {
-          [key: string]: { path: string }
-        }
-      }
-
-      if (Object.keys(npmList.dependencies ?? {}).length === 0)
-        throw new Error('Something went wrong with npm list')
-
-      Object.keys(stubs).forEach(key => {
-        stubs[key as keyof typeof stubs].base =
-          npmList.dependencies?.[key]?.path
-      })
-    } else {
-      // At this point, it's likely yarn is running in PnP mode.
-      printTitle(CoreMeta.colors.magenta, 'Yarn: Unplugging Dependencies')
-      console.log()
-
-      // For now, we need to `unplug` each dependency to get the path to the
-      // package.
-      // TODO: Is there a better way to do this without unplugging?
-      needsReplug = true
-
-      for (const key of Object.keys(stubs)) {
-        // This may fail if the package is not a dependency for this action.
-        try {
-          const output = execSync(`yarn unplug ${key}`).toString()
-          console.log(`Unplugged: ${key}`)
-
-          // Next, get the path to the package. Unfortunately using the `--json`
-          // flag with `yarn unplug` does not output the target path, so we need
-          // to parse it from the plaintext output.
-          const packagePath = output.match(
-            /Will unpack .* to (?<packagePath>.*)/
-          )?.groups?.packagePath
-
-          if (!packagePath) throw new Error(`Could not unplug ${key}`)
-
-          stubs[key as keyof typeof stubs].base = path.join(
-            packagePath,
-            'node_modules',
-            key
-          )
-        } catch {
-          // This is fine...
-        }
+    // Note: The CLI commands are different across yarn versions for getting the
+    // path to a dependency.
+
+    // At this point, it's likely yarn is running in PnP mode.
+    printTitle(CoreMeta.colors.magenta, 'Yarn: Unplugging Dependencies')
+    console.log()
+
+    // For now, we need to `unplug` each dependency to get the path to the
+    // package.
+    needsReplug = true
+
+    for (const key of Object.keys(stubs)) {
+      // This may fail if the package is not a dependency for this action.
+      try {
+        const output = execSync(`yarn unplug ${key}`).toString()
+        console.log(`Unplugged: ${key}`)
+
+        // Next, get the path to the package. Unfortunately using the `--json`
+        // flag with `yarn unplug` does not output the target path, so we need
+        // to parse it from the plaintext output.
+        const packagePath = output.match(/Will unpack .* to (?<packagePath>.*)/)
+          ?.groups?.packagePath
+
+        if (!packagePath) throw new Error(`Could not unplug ${key}`)
+
+        stubs[key as keyof typeof stubs].base = path.join(
+          packagePath,
+          'node_modules',
+          key
+        )
+      } catch {
+        // This is fine...
       }
     }
   }
@@ -317,7 +285,7 @@ export async function action(): Promise<void> {
   // Stub the `@actions/toolkit` libraries and run the action. Quibble and
   // local-action require a different approach depending on if the called action
   // is written in ESM.
-  if (isESM()) {
+  if (actionType === 'esm') {
     await quibble.esm(
       path.resolve(
         stubs['@actions/github'].base ?? '',