denoland / denoland/std

@std/testing/bdd: .ignore() aliasing [xdescribe, xit]

Open
#6,200 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
3.6k
Forks
681
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**

> With the [@std/testing/bdd](https://jsr.io/@std/testing/doc/bdd/~) module you can write your tests in a familiar format for grouping tests and adding setup/teardown hooks used by other JavaScript testing frameworks like Jasmine, Jest, and Mocha.

[Source](https://docs.deno.com/runtime/fundamentals/testing/#behavior-driven-development)

A feature of the Jasmine/Jest/Mocha style of writing tests includes the ability to skip tests via prefixing `describe` or `it` with `x`. This would functionally be the same as adding `.ignore` to `describe` or `it`.

***
**Describe the solution you'd like**

As a developer that is familiar with the Jasmine, Jest, and Mocha style of writing tests,
I would like to ignore tests by prefixing `describe` and/or `it` with an `x`,
so that I can skip tests in a familiar way and won't have to find/replace `xdescribe` with `describe.ignore` (and with `it` as well).

***
**Describe alternatives you've considered**

In each test file I am able to include `const xdescribe = describe.ignore;` and `const xit = it.ignore;` to achieve this functionality but is obviously not ideal.

It would be great if `xdescribe` and `xit` could be included with the import of `describe` and `it` so that the developer doesn't need to always include four types. Not sure how feasible this is. MVP I'd be ok with importing all four.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.