import/require xit, fixes #2972

[solodynamo]

Description of the Change

Adds xit into the exports in the files lib/mocha.js and mocha.js.

Why should this be in core?

To individually require/import xit from the library.

Benefits

It will allow devs to skip a particular test. Another alternative is it.skip

[jsf-clabot]

All committers have signed the CLA.

[coveralls]

Coverage increased (+0.05%) to 89.072% when pulling 6042cb8 on solodynamo:master into 74fa66f on mochajs:master.

[ScottFreeCode]

Hi @solodynamo, thanks for submitting this!

I identified one thing that needs to be updated, see the code comment below for details.

In the process of looking into that, I also identified that there are the following x functions you can feel free to add all of if you'd like:

• xit
• xspecify (exactly the same as xit)
• xdescribe
• xcontext (exactly the same as xdescribe)

xdescribe and xcontext, like xit as explained below, can take from context.suite.skip for the TDD side, given its lack of an x version. Both the TDD and the BDD suite skip functions and the BDD suite x functions are all delegating to the same thing and will therefore be equivalent.

Now that I look at it, it seems we're also missing the BDD's specify (identical to it) and context (context.context in this code; identical to describe). You can add those here if you like too.

If you don't want to add all of these that's fine too, I just figured I'd point them out -- and have this comment listing them so they can be addressed at some point -- since I happened to identify them all when comparing how to handle xit with test.skip in the || branch.

[ScottFreeCode]

(This is the only change that should be needed to merge this. Any others suggested are optional.)

So, the context.test on the right side of the || isn't right, that's the same as for the non-skipped it. (With that said, you can skip to the very bottom for recommended fix; the rest here is explanation.) I'm not 100% certain whether this involves the QUnit interface at all, but it seems these are basically enabling require-based used of either the BDD or the TDD interface when either the BDD or TDD interface is used; so, the || here would be to replicate the BDD interface in the event the TDD interface is chosen. So, I double-checked what the TDD interface does for skipping.

In the BDD interface, xit, xspecify and it.skip are all set to a function that just calls it while only using the title. In the TDD interface, there are no x functions, and test.skip delegates to the "common interface" test.skip, which in turn relies on the TDD interface's test function and -- like the BDD function -- just passes it only the title. (Weird coupling between the "common interface" and the TDD interface... but nothing worth worrying about here.)

So it looks like it should be perfectly safe to change this to || context.test.skip.

[ScottFreeCode]

Small tip: you don't actually have to update the mocha.js file at the base of the project, as it is generated from the other files as part of the publication process. (On the other hand, for the same reason, you don't have to not update it either -- it will simply be overwritten later, as long as you update the other files in addition. I just mention this because it's useful to know you don't have search through the gigantic bundle for the code to update and do have to update other files for changes to actually be picked up.)

[solodynamo]

@ScottFreeCode Updated the PR with suggested changes. This time not updated mocha.js at root level.

[coveralls]

Coverage increased (+0.05%) to 89.072% when pulling 3fe7ae3 on solodynamo:master into 74fa66f on mochajs:master.

[ScottFreeCode]

Squashed commits and merged in 1cc0fc0 (sorry that didn't automatically update this PR); thanks again!