[feat] bench.todo()

[loynoir]

Before

if(!foobar_has_test_bug) bench.add(foobar.name, foobar)

• Table of hello, world, foobar
• Or table of hello, world

Which might let dev forget to watch upstream bug.

After

if(foobar_has_test_bug) {
  bench.todo(foobar.name, foobar)
} else {
  bench.add(foobar.name, foobar)
}

• Table of hello, world, foobar, while foobar maybe N/A

Related

isomorphic-git/isomorphic-git#1163 (comment)

[Aslemammad]

Nice additions, are you interested in adding them yourself?

[kamiloox]

Hey, I can try to create a PR for that. But one question - how the API could look like? Because if we want to be consistent between different versions it might not be the best thing to set a result with values of N/A. Marking them as number | 'N/A' will be a major change. My idea is to make a todo: boolean = false flag in Task. Example:

WDYT guys about this API? It's not the best but it's one of the possible solution 😄

[Aslemammad]

@kamiloox I don't think any calculation is going to be there, and we just make it todo and the rest is handled by the user, no need to worry about that.

[kamiloox]

@Aslemammad In the README there is an example of how to use this library. The results are multiplied by 1000. If it is okay to leave it up to user decision then fine

So if the bench case is marked as todo I can make the result field as undefined 👌

[Aslemammad]

As I say, It's ok to leave it to the users. And if we do not do anything with the todo, that way the user won't even see it, so this is even better. this way it won't even be in bench.tasks