no-done-callback.md

vitest/no-done-callback

📝 Disallow using a callback in asynchronous tests and hooks.

❌ This rule is deprecated.

💡 This rule is manually fixable by editor suggestions.

Rule Details

This rule aims to prevent the use of a callback in asynchronous tests and hooks.

Examples of incorrect code for this rule:

test('foo', (done) => {
  setTimeout(done, 1000)
})

test('foo', (done) => {
  setTimeout(() => done(), 1000)
})

test('foo', (done) => {
  setTimeout(() => {
    done()
  }, 1000)
})

test('foo', (done) => {
  setTimeout(() => {
    done()
  }, 1000)
})

Examples of correct code for this rule:

test('foo', async () => {
  await new Promise((resolve) => setTimeout(resolve, 1000))
})

test('foo', async () => {
  await new Promise((resolve) => setTimeout(() => resolve(), 1000))
})

test('foo', async () => {
  await new Promise((resolve) =>
    setTimeout(() => {
      resolve()
    }, 1000),
  )
})

test('foo', async () => {
  await new Promise((resolve) =>
    setTimeout(() => {
      resolve()
    }, 1000),
  )
})

test.concurrent('foo', ({ expect }) => {
  expect(1).toMatchSnapshot()
})

test.concurrent('foo', (context) => {
  context.expect(1).toBe(1)
})

describe.concurrent('foo', () => {
  test('foo', ({ expect }) => {
    expect(1).toBe(1)
  })
})