jasonetco / test-selector

🎭👈 Prompts the user to run specific test suites in a project.

Test Selector ·

A helper CLI tool to make it easier to run just the tests you want to run.

test-selector will look through your package.json file's scripts object and pick out the ones following the test:testName scheme. It will then ask you which one of those tests you want to run! Or, if you already know the test you want to run, you can include its name in the command.

Installation

$ npm install -g test-selector --save

Basic usage

$ tst

Run a specific test

Already know which test you want to run? Cool! The following command is the same as npm run test:api.

$ tst api

Output:

[tst] Running the test suite: api

Setting up your tests

tst assumes that your package.json file's scripts object is formatted like this:

{
  "scripts": {
    "test": "test for things",
    "test:api": "test just the api",
    "test:compiler": "test just the compiler"
  }
}

Available options

Option	Default	Description
-p, --prefix	'test'	A string that comes before all tests.
-s, --separator	':'	Character that separates the prefix from the test name.

You can use these options like this:

$ tst --prefix unit-test --separator -

This will suggest any scripts that look like unit-test-TESTNAME.

Configuration in your package.json file

You may also add a "tst" object to your project's package.json file.

{
  "scripts": {
    "test": "test for things",
    "unit-test-api": "test just the api",
  },
  "tst": {
    "prefix": "unit-test",
    "separator": "-"
  }
}

Writing your tests

For each testing library, there's a different way to separate your tests if you don't want to run them all. I'm not an expert in every testing library, so here are a few resources you can look at:

• Mocha's --grep option
• Jest CLI docs

Contributing

I'd love your contributions! Feel free to open up an issue or submit a PR. Thanks 💖

Changelog

• 1.0.0 - Initial release
• 1.0.1 - Enable settings in package.json

test-selector's Issues

Add support for running multiple tests

Currently, you can do one of three things:

1. Run tst and pick "All of them."
2. Run tst and pick the test suite you want to run.
3. Run tst TEST and run that test suite.

Wouldn't it be great if you could pick two, unrelated test suites and run them in isolation, but sequentially?

Either by way of a checkbox list instead of a single-choice list, or by allowing multiple arguments in the CLI (like tst api compiler).

Leaving this open as a hacktoberfest issue in case anyone wants to tackle it!