makeCmdTasks.js

'use strict'

const resolveTaskFn = require('./resolveTaskFn')

const debug = require('debug')('lint-staged:make-cmd-tasks')

/**
 * Creates and returns an array of listr tasks which map to the given commands.
 *
 * @param {object} options
 * @param {Array<string|Function>|string|Function} options.commands
 * @param {Array<string>} options.files
 * @param {string} options.gitDir
 * @param {Boolean} shell
 */
module.exports = async function makeCmdTasks({ commands, files, gitDir, shell }) {
  debug('Creating listr tasks for commands %o', commands)
  const commandsArray = Array.isArray(commands) ? commands : [commands]

  return commandsArray.reduce((tasks, command) => {
    // command function may return array of commands that already include `stagedFiles`
    const isFn = typeof command === 'function'
    const resolved = isFn ? command(files) : command
    const commands = Array.isArray(resolved) ? resolved : [resolved] // Wrap non-array command as array

    // Function command should not be used as the task title as-is
    // because the resolved string it might be very long
    // Create a matching command array with [file] in place of file names
    let mockCommands
    if (isFn) {
      const mockFileList = Array(files.length).fill('[file]')
      const resolved = command(mockFileList)
      mockCommands = Array.isArray(resolved) ? resolved : [resolved]
    }

    commands.forEach((command, i) => {
      // If command is a function, use the matching mock command as title,
      // but since might include multiple [file] arguments, shorten to one
      const title = isFn ? mockCommands[i].replace(/\[file\].*\[file\]/, '[file]') : command
      const task = { title, task: resolveTaskFn({ gitDir, isFn, command, files, shell }) }
      tasks.push(task)
    })

    return tasks
  }, [])
}