mirror of
https://github.com/hanzoai/lint-staged.git
synced 2026-10-30 19:37:36 +00:00
201 lines
5.9 KiB
JavaScript
201 lines
5.9 KiB
JavaScript
import { exec } from 'tinyexec'
|
|
import { beforeEach, describe, it, vi } from 'vitest'
|
|
|
|
import { getAbortController } from '../../lib/getAbortController.js'
|
|
const { getSpawnedTasks, getMaxArgLength } = await import('../../lib/getSpawnedTasks.js')
|
|
|
|
vi.mock('tinyexec', () => ({
|
|
exec: vi.fn().mockReturnValue({
|
|
async *[Symbol.asyncIterator]() {
|
|
yield 'test'
|
|
},
|
|
}),
|
|
}))
|
|
|
|
const abortController = getAbortController()
|
|
|
|
describe('getSpawnedTasks', () => {
|
|
const topLevelDir = process.cwd()
|
|
|
|
beforeEach(() => {
|
|
vi.mocked(exec).mockClear()
|
|
})
|
|
|
|
it('should return an array', async ({ expect }) => {
|
|
const array = await getSpawnedTasks({
|
|
abortController,
|
|
commands: 'test',
|
|
topLevelDir,
|
|
files: [{ filepath: 'test.js', status: 'M' }],
|
|
})
|
|
expect(array).toBeInstanceOf(Array)
|
|
})
|
|
|
|
it('should work with a single command', async ({ expect }) => {
|
|
expect.assertions(4)
|
|
const res = await getSpawnedTasks({
|
|
abortController,
|
|
commands: 'test',
|
|
topLevelDir,
|
|
files: [{ filepath: 'test.js', status: 'M' }],
|
|
})
|
|
expect(res.length).toBe(1)
|
|
const [linter] = res
|
|
expect(linter.title).toBe('test')
|
|
expect(linter.task).toBeInstanceOf(Function)
|
|
const taskPromise = linter.task()
|
|
expect(taskPromise).toBeInstanceOf(Promise)
|
|
await taskPromise
|
|
})
|
|
|
|
it('should work with multiple commands', async ({ expect }) => {
|
|
expect.assertions(9)
|
|
const res = await getSpawnedTasks({
|
|
abortController,
|
|
commands: ['test', 'test2'],
|
|
topLevelDir,
|
|
files: [{ filepath: 'test.js', status: 'M' }],
|
|
})
|
|
expect(res.length).toBe(2)
|
|
const [linter1, linter2] = res
|
|
expect(linter1.title).toBe('test')
|
|
expect(linter2.title).toBe('test2')
|
|
|
|
let taskPromise = linter1.task()
|
|
expect(taskPromise).toBeInstanceOf(Promise)
|
|
await taskPromise
|
|
expect(exec).toHaveBeenCalledTimes(1)
|
|
expect(exec).toHaveBeenLastCalledWith('test', ['test.js'], {
|
|
nodeOptions: {
|
|
cwd: process.cwd(),
|
|
env: { NO_COLOR: 'true' },
|
|
},
|
|
})
|
|
taskPromise = linter2.task()
|
|
expect(taskPromise).toBeInstanceOf(Promise)
|
|
await taskPromise
|
|
expect(exec).toHaveBeenCalledTimes(2)
|
|
expect(exec).toHaveBeenLastCalledWith('test2', ['test.js'], {
|
|
nodeOptions: {
|
|
cwd: process.cwd(),
|
|
env: { NO_COLOR: 'true' },
|
|
},
|
|
})
|
|
})
|
|
|
|
it('should work with function task returning a string', async ({ expect }) => {
|
|
const res = await getSpawnedTasks({
|
|
commands: () => 'test',
|
|
topLevelDir,
|
|
files: [{ filepath: 'test.js', status: 'M' }],
|
|
})
|
|
expect(res.length).toBe(1)
|
|
expect(res[0].title).toEqual('test')
|
|
})
|
|
|
|
it('should work with function task returning array of string', async ({ expect }) => {
|
|
const res = await getSpawnedTasks({
|
|
abortController,
|
|
commands: () => ['test', 'test2'],
|
|
topLevelDir,
|
|
files: [{ filepath: 'test.js', status: 'M' }],
|
|
})
|
|
expect(res.length).toBe(2)
|
|
expect(res[0].title).toEqual('test')
|
|
expect(res[1].title).toEqual('test2')
|
|
})
|
|
|
|
it('should work with function task accepting arguments', async ({ expect }) => {
|
|
const res = await getSpawnedTasks({
|
|
abortController,
|
|
commands: (filenames) => filenames.map((file) => `test ${file}`),
|
|
topLevelDir,
|
|
files: [
|
|
{ filepath: 'test.js', status: 'M' },
|
|
{ filepath: 'test2.js', status: 'A' },
|
|
],
|
|
})
|
|
expect(res.length).toBe(2)
|
|
expect(res[0].title).toEqual('test test.js')
|
|
expect(res[1].title).toEqual('test test2.js')
|
|
})
|
|
|
|
it('should work with array of mixed string and function tasks', async ({ expect }) => {
|
|
const res = await getSpawnedTasks({
|
|
abortController,
|
|
commands: [() => 'test', 'test2', (files) => files.map((file) => `test ${file}`)],
|
|
topLevelDir,
|
|
files: [
|
|
{ filepath: 'test.js', status: 'M' },
|
|
{ filepath: 'test2.js', status: 'A' },
|
|
{ filepath: 'test3.js', status: 'R' },
|
|
],
|
|
})
|
|
expect(res.length).toBe(5)
|
|
expect(res[0].title).toEqual('test')
|
|
expect(res[1].title).toEqual('test2')
|
|
expect(res[2].title).toEqual('test test.js')
|
|
expect(res[3].title).toEqual('test test2.js')
|
|
expect(res[4].title).toEqual('test test3.js')
|
|
})
|
|
|
|
it('should work with async function tasks', async ({ expect }) => {
|
|
const res = await getSpawnedTasks({
|
|
abortController,
|
|
commands: async () => 'test',
|
|
topLevelDir,
|
|
files: [{ filepath: 'test.js', status: 'M' }],
|
|
})
|
|
expect(res.length).toBe(1)
|
|
expect(res[0].title).toEqual('test')
|
|
})
|
|
|
|
it("should throw when function task doesn't return string | string[]", async ({ expect }) => {
|
|
await expect(
|
|
getSpawnedTasks({
|
|
abortController,
|
|
commands: () => null,
|
|
topLevelDir,
|
|
files: [{ filepath: 'test.js', status: 'M' }],
|
|
})
|
|
).rejects.toThrow(`✖ Validation Error:
|
|
|
|
Invalid value for '[Function]': null
|
|
|
|
Function task should return a string or an array of strings`)
|
|
})
|
|
|
|
it('should prevent function from mutating original file list', async ({ expect }) => {
|
|
const files = ['test.js']
|
|
|
|
const res = await getSpawnedTasks({
|
|
abortController,
|
|
commands: (stagedFiles) => {
|
|
/** Array.splice() mutates the array */
|
|
stagedFiles.splice(0, 1)
|
|
expect(stagedFiles).toEqual([])
|
|
return stagedFiles.map((file) => `test ${file}`)
|
|
},
|
|
topLevelDir,
|
|
files,
|
|
})
|
|
|
|
/** Because function mutated file list, it was empty and no tasks were created... */
|
|
expect(res.length).toBe(0)
|
|
|
|
/** ...but the original file list was not mutated */
|
|
expect(files).toEqual(['test.js'])
|
|
})
|
|
})
|
|
|
|
describe('getMaxArgLength', () => {
|
|
it.for([
|
|
['darwin', 262_144],
|
|
['win32', 8_191],
|
|
['linux', 131_072],
|
|
['foobar', 131_072],
|
|
])('should return $2 for $1', ([platform, expected], { expect }) => {
|
|
expect(getMaxArgLength(platform)).toEqual(expected)
|
|
})
|
|
})
|