README

find-test-names

Given a Mocha / Cypress spec file, returns the list of suite and test names

Install

# install using NPM, probably as a dev dependency
$ npm i -D find-test-names
# install using Yarn
$ yarn add -D find-test-names

Use

const { getTestNames } = require('find-test-names')
const result = getTestNames(specSourceCode)
// { "suiteNames": [], "testNames": [], "tests": [] }

The tests is a list with each test and suite name, and optional list of tags.

// spec.js
it('works', {tags: ['@user']}, () => { ... })
// found test names
// { tests: [{ name: 'works', tags: ['@user'] }] }

withStructure

You can get the entire structure of suites and tests by passing true argument

const result = getTestNames(specSourceCode, true)
// use the result.structure array

To view this in action, use npm run demo-structure which points at bin/find-tests.js

Pending tests

The tests it.skip are extracted and have the property pending: true

Bin

This package includes bin/find-test-names.js that you can use from the command line

$ npx find-test-names <path to the spec file>
# prints the describe and test names found in the spec file

print-tests

Print found suites an tests

$ npx print-tests <spec pattern>

For example, in this repo

$ npx print-tests 'test-cy/**/*.js'

test-cy/spec-a.js
└─ Suite A
  ├─ works 1
  └─ works 2

test-cy/spec-b.js
└─ Suite B
  ├─ works 1
  └─ works 2

Pending tests and suites are marked with ⊙ character like this:

├─ first
├⊙ second
└⊙ last

If there are tags, they are shown after the name

├─ first [tag1, tag2]
├─ second [@sanity]
└─ last

Debugging

Run with the environment variable DEBUG=find-test-names to see verbose logs

Small print

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!