feat(plugin-commands-script-runners): support --resume-from for pnpm exec command

.changeset/silly-ties-arrive.md

@@ -0,0 +1,6 @@
+---
+"@pnpm/plugin-commands-script-runners": minor
+"pnpm": minor
+---
+
+the `pnpm exec` command support `--resume-from` option. When used, the command will executed from given package [#4690](https://github.com/pnpm/pnpm/issues/4690).

exec/plugin-commands-script-runners/src/exec.ts

@@ -16,6 +16,7 @@ import {
   PARALLEL_OPTION_HELP,
   shorthands as runShorthands,
 } from './run'
+import { PnpmError } from '@pnpm/error'
 
 export const shorthands = {
   parallel: runShorthands.parallel,
@@ -34,6 +35,7 @@ export function rcOptionsTypes () {
       'workspace-concurrency',
     ], types),
     'shell-mode': Boolean,
+    'resume-from': String,
   }
 }
 
@@ -66,6 +68,10 @@ The shell should understand the -c switch on UNIX or /d /s /c on Windows.',
             name: '--shell-mode',
             shortAlias: '-c',
           },
+          {
+            description: 'command executed from given package',
+            name: '--resume-from',
+          },
         ],
       },
     ],
@@ -83,6 +89,7 @@ export async function handler (
     sort?: boolean
     workspaceConcurrency?: number
     shellMode?: boolean
+    resumeFrom?: string
   } & Pick<Config, 'extraBinPaths' | 'extraEnv' | 'lockfileDir' | 'dir' | 'userAgent' | 'recursive' | 'workspaceDir'>,
   params: string[]
 ) {
@@ -120,6 +127,19 @@ export async function handler (
       }
     }
   }
+
+  if (opts.resumeFrom) {
+    const resumeFromPackagePrefix = Object.keys(opts.selectedProjectsGraph)
+      .find((prefix) => opts.selectedProjectsGraph?.[prefix]?.package.manifest.name === opts.resumeFrom)
+
+    if (!resumeFromPackagePrefix) {
+      throw new PnpmError('RECURSIVE_EXEC_FAIL', `Cannot find package ${opts.resumeFrom}. Could not determine where to resume from.`)
+    }
+
+    const chunkPosition = chunks.findIndex(chunk => chunk.includes(resumeFromPackagePrefix))
+    chunks = chunks.slice(chunkPosition)
+  }
+
   const existsPnp = existsInDir.bind(null, '.pnp.cjs')
   const workspacePnpPath = opts.workspaceDir && await existsPnp(opts.workspaceDir)
 

exec/plugin-commands-script-runners/test/exec.e2e.ts

@@ -552,3 +552,112 @@ testOnPosixOnly('pnpm recursive exec works with PnP', async () => {
   expect(outputs1).toStrictEqual(['project-1', 'project-2-prebuild', 'project-2', 'project-2-postbuild'])
   expect(outputs2).toStrictEqual(['project-1', 'project-3'])
 })
+
+test('pnpm recursive exec --resume-from should work', async () => {
+  preparePackages([
+    {
+      name: 'project-1',
+      version: '1.0.0',
+      dependencies: {
+        'json-append': '1',
+      },
+      scripts: {
+        build: 'node -e "process.stdout.write(\'project-1\')" | json-append ../output1.json',
+      },
+    },
+    {
+      name: 'project-2',
+      version: '1.0.0',
+      dependencies: {
+        'json-append': '1',
+        'project-1': '1',
+      },
+      scripts: {
+        build: 'node -e "process.stdout.write(\'project-2\')" | json-append ../output1.json',
+      },
+    },
+    {
+      name: 'project-3',
+      version: '1.0.0',
+      dependencies: {
+        'json-append': '1',
+        'project-1': '1',
+      },
+      scripts: {
+        build: 'node -e "process.stdout.write(\'project-3\')" | json-append ../output1.json',
+      },
+    },
+    {
+      name: 'project-4',
+      version: '1.0.0',
+      dependencies: {
+        'json-append': '1',
+      },
+      scripts: {
+        build: 'node -e "process.stdout.write(\'project-4\')" | json-append ../output1.json',
+      },
+    },
+  ])
+
+  const { selectedProjectsGraph } = await readProjects(process.cwd(), [])
+  await execa(pnpmBin, [
+    'install',
+    '-r',
+    '--registry',
+    REGISTRY_URL,
+    '--store-dir',
+    path.resolve(DEFAULT_OPTS.storeDir),
+  ])
+  await exec.handler({
+    ...DEFAULT_OPTS,
+    dir: process.cwd(),
+    selectedProjectsGraph,
+    recursive: true,
+    sort: true,
+    resumeFrom: 'project-3',
+  }, ['npm', 'run', 'build'])
+
+  const { default: outputs1 } = await import(path.resolve('output1.json'))
+  expect(outputs1).not.toContain('project-1')
+  expect(outputs1).not.toContain('project-4')
+  expect(outputs1).toContain('project-2')
+  expect(outputs1).toContain('project-3')
+})
+
+test('should throw error when the package specified by resume-from does not exist', async () => {
+  preparePackages([
+    {
+      name: 'foo',
+      version: '1.0.0',
+      dependencies: {
+        'json-append': '1',
+      },
+      scripts: {
+        build: 'echo foo',
+      },
+    },
+  ])
+
+  const { selectedProjectsGraph } = await readProjects(process.cwd(), [])
+  await execa(pnpmBin, [
+    'install',
+    '-r',
+    '--registry',
+    REGISTRY_URL,
+    '--store-dir',
+    path.resolve(DEFAULT_OPTS.storeDir),
+  ])
+
+  try {
+    await exec.handler({
+      ...DEFAULT_OPTS,
+      dir: process.cwd(),
+      selectedProjectsGraph,
+      recursive: true,
+      sort: true,
+      resumeFrom: 'project-2',
+    }, ['npm', 'run', 'build'])
+  } catch (err: any) { // eslint-disable-line
+    expect(err.code).toBe('ERR_PNPM_RECURSIVE_EXEC_FAIL')
+  }
+})