prefer-todo.md

jest/prefer-todo

📝 Suggest using test.todo.

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

When test cases are empty then it is better to mark them as test.todo as it will be highlighted in the summary output.

Rule details

This rule triggers a warning if empty test cases are used without 'test.todo'.

test('i need to write this test');

The following pattern is considered warning:

test('i need to write this test'); // Unimplemented test case
test('i need to write this test', () => {}); // Empty test case body
test.skip('i need to write this test', () => {}); // Empty test case body

The following pattern is not warning:

test.todo('i need to write this test');