Print todo and skip descriptions when in verbose mode

[natealcedo]

Summary

Prints the text in test.todo and test.skip calls when in verbose mode

Fixes #7999

Test plan

Added some integration integration tests under testTodo

[SimenB]

seems silly to pass in the icons and title, but I see it's consistent

[natealcedo]

Yup. Didn't want to stray too far from what was being done. The same could be said for printing skipped tests

[mattphillips]

I think given that we are explicitly pulling this behaviour out into _logTodoTest we should just move the concrete data into the function definition.

 private _logTodoTest(
    todoTest: TestResult.AssertionResult,
    indentLevel: number,
  ) {
    const text = chalk.dim(`todo ${todoTest.title}`);
    this._logLine(`${this._getIcon('todo')} ${text}`, indentLevel);
  }

Then if you want to be fancy you could curry this to:

 private _logTodoTest = (indentLevel: number) => (todoTest: TestResult.AssertionResult) => {
    const text = chalk.dim(`todo ${todoTest.title}`);
    this._logLine(`${this._getIcon('todo')} ${text}`, indentLevel);
  }

and then you can just do the following in the forEach:

summedTests.todo.forEach(this._logTodoTest(indentLevel));

[natealcedo]

I like this approach. Should we do a similar approach to skipped tests then since their functions are very similar?

[SimenB]

Thanks! Just missing changelog

[natealcedo]

I've just pushed in some changes where skipped tests get the same treatment as per the original PR. One thing to note is that I wrap the description in quotes now since some descriptions might be long.
Let me know what you guys think.

Edit: I'll revert adding the quotes since I just noticed that they're not there for passing tests as well

[natealcedo]

Hey just following up. What else does this PR need to get merged?

[SimenB]

What else does this PR need to get merged?

Nothing!

[Akswii]

I know this is merged/closed, but is there anyway to list just the todos? When you have a lot of tests then showing it in verbose will be kind of hard to pickup.

[SimenB]

We could probably pass an option to the reporter enabling this. Wanna open a PR? If not, please open up an issue

[natealcedo]

I can pick this up. How would this work from a user’s point of view though? I imagine this would need another configuration option?

[SimenB]

Yeah, something like reporters: [['default', {showTodoTitleWhenVerbose: true}]] or something similar, without the horrible name

[natealcedo]

So I can foresee 2 things here.

1. We only show the 'showTodoTitleWhenVerbose' when it's passed as an option in
2. This behavior is not enabled by default when running jest with --verbose or when verbose: true is set.

That right?

[SimenB]

Default to showing it, I think? /cc @scotthovestadt @thymikee @jeysal @mattphillips

[natealcedo]

Ok I think I may have misread @Akswii 's request. Right now, in verbose mode. We print all test names. I think what he's asking is for the ability to show only the test names of the todo tests and everything else will be as per before. i.e. "3 skipped", Correct me if I'm wrong @Akswii

[Akswii]

@natealcedo Exactly! I wish to use test.todo to outline my future work load, and it would be a nice feature to be able to list only the todos. I'm working on a project with a ton of tests, and it's impossible to see what the todos are when the tests are running in verbose mode.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.