skip-reason v1.1.1

skip-reason

A more verbose version of it.skip that requires a reason.

Pairs well with eslint-plugin-jest/no-disabled-tests or eslint-plugin-mocha/no-skipped-tests to ensure it.skip and describe.skip are only used for debugging, and don't get committed.

Example:

import { skipReason } from 'skip-reason';

const skip = skipReason("test fails due to issue #1111");
skip.it("example test", () => { 
  // This test is skipped, and the logs show the reason:
  //  - example test (skipped: test fails due to issue #1111)
});

All of the following test methods and hooks are available:

• skip.describe(...)
• skip.it(...)
• skip.before(...) or skip.beforeAll(...)
• skip.beforeEach(...)
• skip.after(...) or skip.afterAll(...)
• skip.afterEach(...)

skip-when

Skip tests when a condition is true:

import { skipWhen } from 'skip-reason';

const onMac = skipWhen(process.platform !== 'darwin', 'this test is only needed on Mac');

onMac.it('example test', () => {
  // This test only runs on Mac.  On Linux or Windows, it will log:
  //   - example test (skipped: this test is only needed on Mac)
});

Same return value as skipReason, but if the condition is false, then the real hooks are used.