consistent-test-it.md

vitest/consistent-test-it

📝 Enforce using test or it but not both.

⚠️ This rule warns in the 🌐 all config.

🔧 This rule is automatically fixable by the --fix CLI option.

Rule Details

Examples of incorrect code for this rule:

test('it works', () => {
  // ...
})

it('it works', () => {
  // ...
})

Examples of correct code for this rule:

test('it works', () => {
  // ...
})

test('it works', () => {
  // ...
})

Options

Name	Description	Type	Choices
fn	Preferred global test function keyword.	String	test, it
withinDescribe	Preferred test function keyword inside describe.	String	test, it

{
  "type": "object",
  "properties": {
    "fn": {
      "enum": ["it", "test"]
    },
    "withinDescribe": {
      "enum": ["it", "test"]
    }
  },
  "additionalProperties": false
}

fn

Decides whether to prefer test or it.

withinDescribe

Decides whether to prefer test or it when used within a describe block.

/*eslint vitest/consistent-test-it: ["error", {"fn": "test"}]*/

test('it works', () => {
  // <-- Valid
  // ...
})

test.only('it works', () => {
  // <-- Valid
  // ...
})

it('it works', () => {
  // <-- Invalid
  // ...
})

it.only('it works', () => {
  // <-- Invalid
  // ...
})

The default configuration is top level test and all tests nested with describe to use it.