Skip to content

failing-test-url.md

Latest commit

 

History

History
31 lines (21 loc) · 807 Bytes

failing-test-url.md

File metadata and controls

31 lines (21 loc) · 807 Bytes

ava/failing-test-url

📝 Require a URL in a comment above test.failing().

🚫 This rule is disabled in the ✅ recommended config.

test.failing() marks tests that are expected to fail due to a known bug. Without a link to the issue tracker, it's easy to forget why the test was marked as failing.

This rule requires a comment with a URL (http:// or https://) directly above the test.failing() call.

Examples

import test from 'ava';

// https://github.com/avajs/ava/issues/123
test.failing('foo', t => { // ✅
	t.pass();
});

test.failing('bar', t => { // ❌
	t.pass();
});

// TODO: fix this
test.failing('baz', t => { // ❌ (comment has no URL)
	t.pass();
});