test: update tests

Author: iiroj

lib/getFunctionTasks.js renamed to lib/getFunctionTask.js

@@ -1,7 +1,6 @@
 import debug from 'debug'
 
 import { makeErr } from './getSpawnedTask.js'
-import { configurationError } from './messages.js'
 
 const debugLog = debug('lint-staged:getFunctionTasks')
 
@@ -18,25 +17,21 @@ export const isFunctionTask = (commands) => !Array.isArray(commands) && typeof c
  * @param {Array<string>} files
  * @throws {Error} If the function configuration is not valid
  */
-export const getFunctionTasks = async (command, files) => {
+export const getFunctionTask = async (command, files) => {
   debugLog('Creating Listr tasks for function %o', command)
-  if (typeof command.title === 'string' && typeof command.task === 'function') {
-    const task = async (ctx) => {
-      try {
-        await command.task(files)
-      } catch (e) {
-        throw makeErr(command.title, e, ctx)
-      }
-    }
 
-    return [{ title: command.title, task }]
-  } else {
-    throw new Error(
-      configurationError(
-        '[Function]',
-        'Function task should contain `title` and `task` where `title` should be string and `task` should be function.',
-        command
-      )
-    )
+  const task = async (ctx) => {
+    try {
+      await command.task(files)
+    } catch (e) {
+      throw makeErr(command.title, e, ctx)
+    }
   }
+
+  return [
+    {
+      title: command.title,
+      task,
+    },
+  ]
 }

lib/runAll.js

@@ -9,7 +9,7 @@ import { Listr } from 'listr2'
 import { chunkFiles } from './chunkFiles.js'
 import { execGit } from './execGit.js'
 import { generateTasks } from './generateTasks.js'
-import { getFunctionTasks, isFunctionTask } from './getFunctionTasks.js'
+import { getFunctionTask, isFunctionTask } from './getFunctionTask.js'
 import { getRenderer } from './getRenderer.js'
 import { getSpawnedTasks } from './getSpawnedTasks.js'
 import { getStagedFiles } from './getStagedFiles.js'
@@ -192,7 +192,7 @@ export const runAll = async (
       const chunkListrTasks = await Promise.all(
         generateTasks({ config, cwd: groupCwd, files, relative }).map((task) =>
           (isFunctionTask(task.commands)
-            ? getFunctionTasks(task.commands, files)
+            ? getFunctionTask(task.commands, files)
             : getSpawnedTasks({
                 commands: task.commands,
                 cwd: groupCwd,

lib/validateConfig.js

@@ -64,7 +64,7 @@ export const validateConfigLogic = (config, configPath, logger) => {
       errors.push(
         configurationError(
           pattern,
-          'Custom task should contain `title` and `task` fields, where `title` should be a string and `task` should be a function.',
+          'Function task should contain `title` and `task` fields, where `title` should be a string and `task` should be a function.',
           task
         )
       )

test/unit/__snapshots__/validateConfig.spec.js.snap

@@ -15,7 +15,7 @@ exports[`validateConfig should throw and should print validation errors for inva
 
   Invalid value for '*.js': { title: 'Running a custom task' }
 
-  Custom task should contain \`title\` and \`task\` fields, where \`title\` should be a string and \`task\` should be a function."
+  Function task should contain \`title\` and \`task\` fields, where \`title\` should be a string and \`task\` should be a function."
 `;
 
 exports[`validateConfig should throw for empty config 1`] = `"Configuration should not be empty"`;

test/unit/getFunctionTask.spec.js

@@ -0,0 +1,58 @@
+import { expect, jest } from '@jest/globals'
+
+import { getFunctionTask } from '../../lib/getFunctionTask.js'
+import { getInitialState } from '../../lib/state.js'
+import { TaskError } from '../../lib/symbols.js'
+
+describe('getFunctionTask', () => {
+  it('should return wrapped function task', async () => {
+    const files = ['file.js']
+
+    const cmd = {
+      title: 'My task',
+      task: jest.fn(),
+    }
+
+    const wrapped = await getFunctionTask(cmd, files)
+
+    expect(wrapped).toEqual([
+      {
+        title: 'My task',
+        task: expect.any(Function),
+      },
+    ])
+
+    wrapped[0].task()
+
+    expect(cmd.task).toHaveBeenCalledTimes(1)
+    expect(cmd.task).toHaveBeenCalledWith(files)
+  })
+
+  it('should wrap function task failure', async () => {
+    const files = ['file.js']
+
+    const cmd = {
+      title: 'My task',
+      task: jest.fn().mockImplementation(async () => {
+        throw new Error('test error')
+      }),
+    }
+
+    const wrapped = await getFunctionTask(cmd, files)
+
+    expect(wrapped).toEqual([
+      {
+        title: 'My task',
+        task: expect.any(Function),
+      },
+    ])
+
+    const context = getInitialState()
+
+    await expect(wrapped[0].task(context)).rejects.toThrowErrorMatchingInlineSnapshot(
+      `"My task [FAILED]"`
+    )
+
+    expect(context.errors.has(TaskError)).toEqual(true)
+  })
+})

test/unit/runAll.spec.js

@@ -365,4 +365,24 @@ describe('runAll', () => {
     await runAll({ configObject: { '*.js': ['echo "sample"'] }, diff: 'branch1...branch2' })
     expect(console.printHistory()).toMatch('Skipping backup because `--diff` was used')
   })
+
+  it('should support function tasks', async () => {
+    const staged = ['foo.js']
+    getStagedFiles.mockImplementationOnce(async () => staged)
+
+    const task = jest.fn()
+    const configObject = { '*.js': { title: 'My task', task } }
+
+    searchConfigs.mockImplementationOnce(async () => ({
+      '': configObject,
+    }))
+
+    await runAll({
+      configObject: { '*.js': { title: 'My task', task } },
+      relative: true, // make sure filenames are relative for easier assertion below
+    })
+
+    expect(task).toHaveBeenCalledTimes(1)
+    expect(task).toHaveBeenCalledWith(staged)
+  })
 })