jest-docblock-runner

Run Jest tests by docBlock pragmas like those used in jest-circus-allure-environment

🚧 This is currently under development. 🚧

➕ Jest patches

This project is contingent on code changes to be approved and merged into the Jest project. For now I've implemented a workaround that applies patches to the Jest dependencies using patch-package. This should happen automatically after installing the dependencies with yarn install /npm install.

If for some reason the patches were not applied automatically you can apply them by running:

npx patch-package --patch-dir="./node_modules/jest-docblock-runner/patches"

🚀 Quick start

Add dependency to project

yarn add --dev jest-docblock-runner

Apply the patches to jest-circus, jest-jasmine2, jest-types, and jest-runner

npx patch-package --patch-dir="./node_modules/jest-docblock-runner/patches"

Update Jest configuration

See the Jest documentation for more information.

// Jest.config.js

{
  ...
  "runner": "jest-docblock-runner"
}

Add DocBlock pragmas to your tests

// example.test.js

test('bank records update, when I withdraw $100 USD', () => {
  /**
   * @severity critical
   */

  ...
})

Run specific marked tests

yarn run jest --severity=critical

Note: This will accept comma separated values and/or multiple flags.

TODO:

Get this Jest PR merged or work with the Jest team to implement another solution that resolves this issue.
Add support for describe blocks.
Reach 100% code coverage.

The automated release is failing 🚨

🚨 The automated release from the `master` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.

Good luck with your project ✨

Your semantic-release bot 📦🚀

ryparker / jest-docblock-runner Goto Github PK