lint-staged/lib/getFunctionTask.js

Lint files staged by git

import debug from 'debug'

import { makeErr } from './getSpawnedTask.js'

const debugLog = debug('lint-staged:getFunctionTasks')

/**
 * @typedef {{ title: string; task: Function }} FunctionTask
 * @type {(commands: FunctionTask|Array<string|Function>|string|Function) => boolean}
 * @returns `true` if command is a function task
 */
export const isFunctionTask = (commands) => typeof commands === 'object' && !Array.isArray(commands)

/**
 * Handles function configuration and pushes the tasks into the task array
 *
 * @param {object} command
 * @param {import('./getStagedFiles.js').StagedFile[]} files
 * @throws {Error} If the function configuration is not valid
 */
export const getFunctionTask = async (command, files) => {
  debugLog('Creating Listr tasks for function %o', command)

  const task = async (ctx) => {
    try {
      await command.task(files.map((file) => file.filepath))
    } catch (e) {
      throw makeErr(command.title, e, ctx)
    }
  }

  return [
    {
      title: command.title,
      task,
    },
  ]
}