Merge branch 'kinland-feature/117-pnpm-support'

Author: bcomnes

lib/run-task.js

@@ -10,6 +10,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
+const fs = require('fs')
 const path = require('path')
 const parseArgs = require('shell-quote').parse
 const createHeader = require('./create-header')
@@ -128,65 +129,96 @@ function cleanTaskArg (arg) {
  *   An array of options which are inserted before the task name.
  * @param {object} options.labelState - A state object for printing labels.
  * @param {boolean} options.printName - The flag to print task names before running each task.
+ * @param {object} options.packageInfo - A package.json's information.
+ * @param {object} options.packageInfo.body - A package.json's JSON object.
+ * @param {string} options.packageInfo.path - A package.json's file path.
  * @returns {Promise}
  *   A promise object which becomes fullfilled when the npm-script is completed.
  *   This promise object has an extra method: `abort()`.
  * @private
  */
 module.exports = function runTask (task, options) {
   let cp = null
-  const promise = new Promise((resolve, reject) => {
-    ansiStylesPromise.then(({ default: ansiStyles }) => {
-      const stdin = options.stdin
-      const stdout = wrapLabeling(task, options.stdout, options.labelState, ansiStyles)
-      const stderr = wrapLabeling(task, options.stderr, options.labelState, ansiStyles)
-      const stdinKind = detectStreamKind(stdin, process.stdin)
-      const stdoutKind = detectStreamKind(stdout, process.stdout)
-      const stderrKind = detectStreamKind(stderr, process.stderr)
-      const spawnOptions = { stdio: [stdinKind, stdoutKind, stderrKind] }
-
-      // Print task name.
-      if (options.printName && stdout != null) {
-        stdout.write(createHeader(
-          task,
-          options.packageInfo,
-          options.stdout.isTTY,
-          ansiStyles
-        ))
+
+  async function asyncRunTask () {
+    const { default: ansiStyles } = await ansiStylesPromise
+
+    const stdin = options.stdin
+    const stdout = wrapLabeling(task, options.stdout, options.labelState, ansiStyles)
+    const stderr = wrapLabeling(task, options.stderr, options.labelState, ansiStyles)
+    const stdinKind = detectStreamKind(stdin, process.stdin)
+    const stdoutKind = detectStreamKind(stdout, process.stdout)
+    const stderrKind = detectStreamKind(stderr, process.stderr)
+    const spawnOptions = { stdio: [stdinKind, stdoutKind, stderrKind] }
+
+    // Print task name.
+    if (options.printName && stdout != null) {
+      stdout.write(createHeader(
+        task,
+        options.packageInfo,
+        options.stdout.isTTY,
+        ansiStyles
+      ))
+    }
+
+    // Execute.
+    let npmPath = options.npmPath
+    if (!npmPath && process.env.npm_execpath) {
+      const basename = path.basename(process.env.npm_execpath)
+      let newBasename = basename
+      if (basename.startsWith('npx')) {
+        newBasename = basename.replace('npx', 'npm') // eslint-disable-line no-process-env
+      } else if (basename.startsWith('pnpx')) {
+        newBasename = basename.replace('pnpx', 'pnpm') // eslint-disable-line no-process-env
       }
 
-      // Execute.
-      const npmPath = options.npmPath || path.basename(process.env.npm_execpath).startsWith('npx') // eslint-disable-line no-process-env
-        ? path.join(path.dirname(process.env.npm_execpath), path.basename(process.env.npm_execpath).replace('npx', 'npm')) // eslint-disable-line no-process-env
+      npmPath = newBasename === basename
+        ? path.join(path.dirname(process.env.npm_execpath), newBasename)
         : process.env.npm_execpath // eslint-disable-line no-process-env
-      const npmPathIsJs = typeof npmPath === 'string' && /\.m?js/.test(path.extname(npmPath))
-      const execPath = (npmPathIsJs ? process.execPath : npmPath || 'npm')
-      const isYarn = process.env.npm_config_user_agent && process.env.npm_config_user_agent.startsWith('yarn') // eslint-disable-line no-process-env
-      const spawnArgs = ['run']
+    }
 
-      if (npmPathIsJs) {
-        spawnArgs.unshift(npmPath)
-      }
-      if (!isYarn) {
-        Array.prototype.push.apply(spawnArgs, options.prefixOptions)
-      } else if (options.prefixOptions.indexOf('--silent') !== -1) {
-        spawnArgs.push('--silent')
+    const npmPathIsJs = typeof npmPath === 'string' && /\.(c|m)?js/.test(path.extname(npmPath))
+    let execPath = (npmPathIsJs ? process.execPath : npmPath || 'npm')
+
+    if (!npmPath && !process.env.npm_execpath) {
+      // When a script is being run via pnpm, npmPath and npm_execpath will be null or undefined
+      // Attempt to figure out whether we're running via pnpm
+      const projectRoot = path.dirname(options.packageInfo.path)
+      const hasPnpmLockfile = fs.existsSync(path.join(projectRoot, 'pnpm-lock.yaml'))
+      const { status: pnpmFound, output: pnpmWhichOutput } = await spawn('which', 'pnpm', { silent: true })
+      if (hasPnpmLockfile && __dirname.split(path.delimiter).includes('.pnpm') && pnpmFound) {
+        execPath = pnpmWhichOutput
       }
-      Array.prototype.push.apply(spawnArgs, parseArgs(task).map(cleanTaskArg))
+    }
 
-      cp = spawn(execPath, spawnArgs, spawnOptions)
+    const isYarn = process.env.npm_config_user_agent && process.env.npm_config_user_agent.startsWith('yarn') // eslint-disable-line no-process-env
 
-      // Piping stdio.
-      if (stdinKind === 'pipe') {
-        stdin.pipe(cp.stdin)
-      }
-      if (stdoutKind === 'pipe') {
-        cp.stdout.pipe(stdout, { end: false })
-      }
-      if (stderrKind === 'pipe') {
-        cp.stderr.pipe(stderr, { end: false })
-      }
+    const spawnArgs = ['run']
 
+    if (npmPathIsJs) {
+      spawnArgs.unshift(npmPath)
+    }
+    if (!isYarn) {
+      Array.prototype.push.apply(spawnArgs, options.prefixOptions)
+    } else if (options.prefixOptions.indexOf('--silent') !== -1) {
+      spawnArgs.push('--silent')
+    }
+    Array.prototype.push.apply(spawnArgs, parseArgs(task).map(cleanTaskArg))
+
+    cp = spawn(execPath, spawnArgs, spawnOptions)
+
+    // Piping stdio.
+    if (stdinKind === 'pipe') {
+      stdin.pipe(cp.stdin)
+    }
+    if (stdoutKind === 'pipe') {
+      cp.stdout.pipe(stdout, { end: false })
+    }
+    if (stderrKind === 'pipe') {
+      cp.stderr.pipe(stderr, { end: false })
+    }
+
+    return new Promise((resolve, reject) => {
       // Register
       cp.on('error', (err) => {
         cp = null
@@ -197,7 +229,9 @@ module.exports = function runTask (task, options) {
         resolve({ task, code, signal })
       })
     })
-  })
+  }
+
+  const promise = asyncRunTask()
 
   promise.abort = function abort () {
     if (cp != null) {