fix: pnpx context awareness + e2e tests (#7324)

* fix: make unlink command highlighting consistent with other command output

* fix: accurately capture command for pnpx vs pnpm exec

* test: split standard package manager calls from npx/pnpx

* chore: update test description

Co-authored-by: Philippe Serhal <[email protected]>

---------

Co-authored-by: Philippe Serhal <[email protected]>

Author: mrstork

e2e/install.e2e.ts

@@ -157,7 +157,7 @@ type Test = { packageName: string }
 type InstallTest = Test & { install: [cmd: string, args: string[]]; lockfile: string }
 type RunTest = Test & { run: [cmd: string, args: string[]] }
 
-const tests: [packageManager: string, config: InstallTest | RunTest][] = [
+const installTests: [packageManager: string, config: InstallTest][] = [
   [
     'npm',
     {
@@ -182,62 +182,104 @@ const tests: [packageManager: string, config: InstallTest | RunTest][] = [
       lockfile: 'yarn.lock',
     },
   ],
+]
+
+describe.each(installTests)('%s → installs the cli and runs commands without errors', (_, config) => {
+  // TODO: Figure out why this flow is failing on Windows.
+  const npxOnWindows = platform() === 'win32' && 'run' in config
+
+  itWithMockNpmRegistry.skipIf(npxOnWindows)('runs the commands without errors', async ({ registry }) => {
+    // Install
+
+    const cwd = registry.cwd
+    await execa(...config.install, {
+      cwd,
+      env: { npm_config_registry: registry.address },
+      stdio: debug.enabled ? 'inherit' : 'ignore',
+    })
+
+    expect(
+      existsSync(path.join(cwd, config.lockfile)),
+      `Generated lock file ${config.lockfile} does not exist in ${cwd}`,
+    ).toBe(true)
+
+    const binary = path.resolve(path.join(cwd, `./node_modules/.bin/netlify${platform() === 'win32' ? '.cmd' : ''}`))
+
+    // Help
+
+    const helpOutput = (await execa(binary, ['help'], { cwd })).stdout
+
+    expect(helpOutput.trim(), `Help command does not start with '⬥ Netlify CLI'\\n\\nVERSION: ${helpOutput}`).toMatch(
+      /^⬥ Netlify CLI\n\nVERSION/,
+    )
+    expect(
+      helpOutput,
+      `Help command does not include '${config.packageName}/${pkg.version}':\n\n${helpOutput}`,
+    ).toContain(`${config.packageName}/${pkg.version}`)
+    expect(helpOutput, `Help command does not include '$ netlify [COMMAND]':\n\n${helpOutput}`).toMatch(
+      '$ netlify [COMMAND]',
+    )
+
+    // Unlink
+
+    const unlinkOutput = (await execa(binary, ['unlink'], { cwd })).stdout
+    expect(unlinkOutput, `Unlink command includes command context':\n\n${unlinkOutput}`).toContain(
+      `Run netlify link to link it`,
+    )
+  })
+})
+
+const runTests: [packageManager: string, config: RunTest][] = [
   [
     'npx',
     {
       packageName: 'netlify',
       run: ['npx', ['-y', 'netlify@testing']],
     },
   ],
+  [
+    'pnpx',
+    {
+      packageName: 'netlify',
+      run: ['pnpx', ['netlify@testing']],
+    },
+  ],
 ]
 
-describe.each(tests)('%s → installs the cli and runs the help command without error', (_, config) => {
+describe.each(runTests)('%s → runs cli commands without errors', (_, config) => {
   // TODO: Figure out why this flow is failing on Windows.
   const npxOnWindows = platform() === 'win32' && 'run' in config
 
-  itWithMockNpmRegistry.skipIf(npxOnWindows)(
-    'installs the cli and runs the help command without error',
-    async ({ registry }) => {
-      const cwd = registry.cwd
-
-      let stdout: string
-
-      if ('install' in config) {
-        await execa(...config.install, {
-          cwd,
-          env: { npm_config_registry: registry.address },
-          stdio: debug.enabled ? 'inherit' : 'ignore',
-        })
-
-        expect(
-          existsSync(path.join(cwd, config.lockfile)),
-          `Generated lock file ${config.lockfile} does not exist in ${cwd}`,
-        ).toBe(true)
-
-        const binary = path.resolve(
-          path.join(cwd, `./node_modules/.bin/netlify${platform() === 'win32' ? '.cmd' : ''}`),
-        )
-        const result = await execa(binary, ['help'], { cwd })
-
-        stdout = result.stdout
-      } else {
-        const [cmd, args] = config.run
-        const result = await execa(cmd, args, {
-          env: {
-            npm_config_registry: registry.address,
-          },
-        })
+  itWithMockNpmRegistry.skipIf(npxOnWindows)('runs commands without errors', async ({ registry }) => {
+    const [cmd, args] = config.run
+    const env = {
+      npm_config_registry: registry.address,
+    }
 
-        stdout = result.stdout
-      }
+    // Install
 
-      expect(stdout.trim(), `Help command does not start with '⬥ Netlify CLI'\\n\\nVERSION: ${stdout}`).toMatch(
-        /^⬥ Netlify CLI\n\nVERSION/,
-      )
-      expect(stdout, `Help command does not include '${config.packageName}/${pkg.version}':\n\n${stdout}`).toContain(
-        `${config.packageName}/${pkg.version}`,
-      )
-      expect(stdout, `Help command does not include '$ netlify [COMMAND]':\n\n${stdout}`).toMatch('$ netlify [COMMAND]')
-    },
-  )
+    await execa(cmd, [...args], { env })
+
+    // Help
+
+    const helpOutput = (await execa(cmd, [...args, 'help'], { env })).stdout
+
+    expect(helpOutput.trim(), `Help command does not start with '⬥ Netlify CLI'\\n\\nVERSION: ${helpOutput}`).toMatch(
+      /^⬥ Netlify CLI\n\nVERSION/,
+    )
+    expect(
+      helpOutput,
+      `Help command does not include '${config.packageName}/${pkg.version}':\n\n${helpOutput}`,
+    ).toContain(`${config.packageName}/${pkg.version}`)
+    expect(helpOutput, `Help command does not include '$ netlify [COMMAND]':\n\n${helpOutput}`).toMatch(
+      '$ netlify [COMMAND]',
+    )
+
+    // Unlink
+
+    const unlinkOutput = (await execa(cmd, [...args, 'unlink'], { env })).stdout
+    expect(unlinkOutput, `Unlink command includes command context':\n\n${unlinkOutput}`).toContain(
+      `Run ${cmd} netlify link to link it`,
+    )
+  })
 })

src/commands/unlink/unlink.ts

@@ -3,13 +3,14 @@ import { OptionValues } from 'commander'
 import { exit, log } from '../../utils/command-helpers.js'
 import { track } from '../../utils/telemetry/index.js'
 import BaseCommand from '../base-command.js'
+import { chalk, netlifyCommand } from '../../utils/command-helpers.js'
 
 export const unlink = async (_options: OptionValues, command: BaseCommand) => {
   const { site, siteInfo, state } = command.netlify
   const siteId = site.id
 
   if (!siteId) {
-    log(`Folder is not linked to a Netlify project. Run 'netlify link' to link it`)
+    log(`Folder is not linked to a Netlify project. Run ${chalk.cyanBright(`${netlifyCommand()} link`)} to link it`)
     return exit()
   }
 

src/utils/command-helpers.ts

@@ -364,8 +364,13 @@ export const netlifyCommand = () => {
     return `npx netlify`
   }
 
-  // Captures both `pnpx netlify ...` and `pnpm exec netlify ...`
+  // Captures `pnpm exec netlify ...`
   if (pkgFromUserAgent(npm_config_user_agent) === 'pnpm' && npm_command === 'exec') {
+    return `pnpm exec netlify`
+  }
+
+  // Captures `pnpx netlify ...`
+  if (pkgFromUserAgent(npm_config_user_agent) === 'pnpm' && npm_command === 'run-script') {
     return `pnpx netlify`
   }