Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jasonetco/test-selector
🎭👈 Prompts the user to run specific test suites in a project.
https://github.com/jasonetco/test-selector
cli mocha npm-scripts suite test test-selector test-suite testing
Last synced: about 1 month ago
JSON representation
🎭👈 Prompts the user to run specific test suites in a project.
- Host: GitHub
- URL: https://github.com/jasonetco/test-selector
- Owner: JasonEtco
- Created: 2017-09-06T23:59:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-01T04:24:15.000Z (over 6 years ago)
- Last Synced: 2024-12-14T05:32:22.840Z (about 1 month ago)
- Topics: cli, mocha, npm-scripts, suite, test, test-selector, test-suite, testing
- Language: JavaScript
- Homepage:
- Size: 52.7 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Test Selector · [](https://www.npmjs.com/package/test-selector) [](https://travis-ci.org/JasonEtco/test-selector) [](https://coveralls.io/github/JasonEtco/test-selector?branch=master)
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
```bash
$ npm install -g test-selector --save
```
### Basic usage
```bash
$ 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`.
```bash
$ 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:
```json
{
"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:
```bash
$ 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.
```json
{
"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](https://mochajs.org/#-g---grep-pattern)
- [Jest CLI docs](http://facebook.github.io/jest/docs/en/cli.html)
## 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`