npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mocha-tags-ts

v1.0.6

Published

Add tags to your mocha test suite, and filter them at runtime

Downloads

1

Readme

mocha-tags-ts

Typescript version of the Mocha Tags module

NPM License

  • Do you have integration tests that connect to your internal network?
  • Do you need to skip them when running on CI pipelines?
  • Or do you want to tag "slow" and "fast" tests, and run them separately?
npm install mocha-tags-ts --save-dev

Quick example

tags('network')
  .describe(/* ... */)

tags('integration', 'fast')
  .it(/* ... */)

By default all tests will run as usual, but you can use the --tags option to filter them:

mocha --tags "is:integration not:slow not:network"

Tests that don't match the criteria are skipped with the xdescribe or xit commands, and appear as pending in the test output.

Filtering

Note: because of the way filtering works, tags have to be a single word, without any spaces.

is:<tag>

Run tests with the X tag

mocha --tags "is:X"

Run tests with the X or Y tags

mocha --tags "is:X is:Y"

Run tests with the X and Y tag

mocha --tags "is:X+Y"

not:<tag>

Don't run tests with the X flag

mocha --tags "not:X"

Don't run tests with the X or Y flag

mocha --tags "not:X not:Y"

Don't run tests with the X and Y flag

mocha --tags "not:X+Y"

Programmatic usage

You might want to exclude certain tags based on complex logic. This is not easy to define from the command line, so mocha-tags-ts exposes its filter programmatically.

const tags = require('mocha-tags-ts')
// OR
import tags from 'mocha-tags-ts'

// either replace the entire filter
tags.filter = new tags.Filter('not:trading-hours')

// or simply modify the existing one
if (moment().hours() < 8 || moment().hours() > 18) {
  tags.filter.remove('not:unit')
  tags.filter.add('not:trading-hours')
}

tags('trading-hours').it(
  // some integration test than can only run during core hours
)

Troubleshooting

Skipped tests appear as pending in the test output, so you should always notice any test that was skipped by accident.

It also helps to add the following at the top of your main test file / spec helper.

const tags = require('mocha-tags-ts')
// OR
import tags from 'mocha-tags-ts'

console.log('Test filter: ', tags.filter)

Custom test hooks

mocha-tags-ts supports the following keywords:

  • tags().describe : normal usage
  • tags().describe.only : ignores any tags and filters, and runs by itself
  • tags().xdescribe : ignored regardless of tags. Also can be used as tags().describe.skip.

...and the same pattern for it. You can also add custom test hooks by setting the following property:

tags.hooks = function(either) {
  this.mytest = either(fnMatch, fnSkip);
};

// to be used as
tags('hello', 'world')
  .mytest(/* arguments */);

// which will call either
fnMatch(/* arguments */);
fnSkip(/* arguments */);