recommended
config.
Mocha has a feature that allows you to skip tests by appending .skip
to a test-suite or a test-case, or by prepending it with an x
(e.g., xdescribe(...)
instead of describe(...)
).
Sometimes tests are skipped as part of a debugging process, and aren't intended to be committed. This rule reminds you to remove .skip
or the x
prefix from your tests.
This rule looks for describe.skip
, it.skip
, suite.skip
, test.skip
, context.skip
, specify.skip
, xdescribe
, xit
, xcontext
and xspecify
occurrences within the source code.
The following patterns are considered warnings:
// bdd
describe.skip("foo", function () {});
it.skip("foo", function () {});
describe["skip"]("bar", function () {});
it["skip"]("bar", function () {});
xdescribe("baz", function() {});
xit("baz", function() {});
// tdd
suite.skip("foo", function () {});
test.skip("foo", function () {});
suite["skip"]("bar", function () {});
test["skip"]("bar", function () {});
These patterns would not be considered warnings:
// bdd
describe("foo", function () {});
it("foo", function () {});
describe.only("bar", function () {});
it.only("bar", function () {});
// tdd
suite("foo", function () {});
test("foo", function () {});
suite.only("bar", function () {});
test.only("bar", function () {});
- If you really want to commit skipped tests to your repo, turn this rule off.
- If you use another library which exposes a similar API to mocha (e.g.
describe.skip
orxdescribe
), you should turn this rule off, because it would raise warnings.