Add a way to print reminders with test.failing, test.skip, etc.

[tommy-mitchell]

When using test.failing (and others), you might add a comment explaining why the test isn't working yet:

// TODO: waiting on some/repo#123
test.failing("does foo", t => // ...

While this comment may show up in a lint reporter, it doesn't when running tests:

✔ does bar
✔ [expected fail] does foo
✔ does baz

Maybe the reporter could print an optional message?

test.failing("does foo", t => {
	// ...
}, "waiting on some/repo#123");

✔ does bar
✔ [expected fail] does foo
  - waiting on some/repo#123
✔ does baz

[novemberborn]

Could you use t.log() within the test implementation?

[tommy-mitchell]

t.log does report a message with test.failing, but not for test.skip or test.todo.

[novemberborn]

True. We'd have to chain something:

test.failing("does foo", t => t.fail()).because("waiting on some/repo#123")

Something like that? Or test.because().todo() etc.

[tommy-mitchell]

I think test.failing().because() reads better semantically, but it might be better in front so the reason is at the top of the test.

[novemberborn]

Thanks @tommy-mitchell, I've opened #3227.