# mocha/no-pending-tests

📝 Disallow pending tests.

⚠️ This rule _warns_ in the ✅ `recommended` [config](https://github.com/lo1tuma/eslint-plugin-mocha#configs).

💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).

<!-- end auto-generated rule header -->

Mocha supports pending tests. These are tests with no implementation, such as `it('unimplemented test');`, or tests that are explicitly skipped. This rule lets you warn or error on those cases.

This rule intentionally does not support the `--fix` CLI option. Many editors apply ESLint fixes on save, and silently enabling skipped tests again would be a bad default while debugging. For direct `.skip` and `xdescribe()`-style calls, the rule does provide ESLint suggestions so you can remove the pending modifier explicitly.

## Options

This rule supports the following options:

- `allowSkippedWithComment`: Allows explicit skip forms when they have an immediately preceding comment with no blank line. This applies to `.skip`, `xdescribe()`, `xit()`, `this.skip()`, and equivalent configured custom names. It does not allow bare pending tests such as `it('name');`. Defaults to `false`.

```json
{
    "rules": {
        "mocha/no-pending-tests": ["error", {
            "allowSkippedWithComment": true
        }]
    }
}
```

## Rule Details

This rule looks for `it`, `test`, and `specify` function calls with only one argument, where the argument is a string literal.

The following patterns are considered warnings:

```js
it('foo');
specify('foo');
test('foo');

describe.skip('foo', function () {});
it.skip('foo', function () {});
describe['skip']('bar', function () {});
it['skip']('bar', function () {});
xdescribe('baz', function () {});
xit('baz', function () {});
it('qux', function () {
    this.skip();
});

suite.skip('foo', function () {});
test.skip('foo', function () {});
suite['skip']('bar', function () {});
test['skip']('bar', function () {});
beforeEach(function () {
    this.skip();
});
```

These patterns are not considered warnings:

```js
it('foo', function () {});
specify('foo', function () {});
test('foo', function () {});

describe('foo', function () {});
it('foo', function () {});
describe.only('bar', function () {});
it.only('bar', function () {});

suite('foo', function () {});
test('foo', function () {});
suite.only('bar', function () {});
test.only('bar', function () {});
```

With `{ "allowSkippedWithComment": true }`, these explicit skip forms are also allowed:

```js
// SKIP pending #201
it.skip('foo', function () {});

/* SKIP pending #202 */
xdescribe('bar', function () {});

// SKIP pending #203
before(function () {
    this.skip();
});
```

## When Not To Use It

- If pending or skipped tests are acceptable in your project.

## Further Reading

- [Pending tests](https://mochajs.org/#pending-tests)