Registry / testing / find-test-names-tags

find-test-names-tags

JSON →
library1.0.4jsnpmunverified

The `find-test-names-tags` package, currently at stable version 1.0.4, is a utility designed for parsing JavaScript test files, specifically those written for Mocha and Cypress frameworks. Its primary function is to extract comprehensive information about test suites and individual test cases, including their names and any associated tags. A significant feature is its ability to compute "effective tags" for each test, which involves aggregating tags from the test itself and its parent suites. This allows for powerful filtering capabilities, enabling users to isolate tests based on specific tags or combinations thereof. The package also provides command-line interfaces for printing structured test outlines, including marking pending tests and displaying their tags. While a precise release cadence isn't specified, the package appears to be actively maintained and developed. It stands out by offering fine-grained control over test metadata extraction and analysis, making it valuable for dynamic test reporting, selective test execution in CI/CD pipelines, or building custom test dashboards. It effectively bridges the gap between raw test code and actionable test metadata.

testing
npm install find-test-names-tags
github ↗package ↗
INSTALL
IMPORT
SIG · FIND-TEST-NAMES-TA
F
find-test-names-tags
testingjavascriptv1.0.4
Install
—
Import
—
Disk
—
Pass rate
0/ 6
Env Coverage0 / 6
glibc
18–22
musl
18–22
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18–226 runs
build_error
glibc
node 18–226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

getTestNames
✓ const { getTestNames } = require('find-test-names-tags')
✗ import { getTestNames } from 'find-test-names-tags'
Package primarily uses CommonJS `require` syntax as shown in documentation.
setEffectiveTags
✓ const { setEffectiveTags } = require('find-test-names-tags')
✗ import { setEffectiveTags } from 'find-test-names-tags'
A named export function to compute and set effective tags on a parsed test structure.
filterByEffectiveTags
✓ const { filterByEffectiveTags } = require('find-test-names-tags')
✗ import { filterByEffectiveTags } from 'find-test-names-tags'
This function can accept either the parsed structure or the raw source code directly for convenience.

Demonstrates parsing a mock spec file, retrieving the full test structure, computing effective tags for tests, and then filtering these tests based on specific tag criteria.

const specSourceCode = ` describe(['@user'], 'User Features', () => { describe(['@auth'], 'Authentication', () => { it(['@smoke'], 'should allow login', () => { // test implementation }); it(['@regression', '@critical'], 'should handle failed login attempts', () => { // test implementation }); }); describe('Profile', () => { const dynamicName = 'should update profile'; it(dynamicName, () => { // test implementation }); }); }); `; const { getTestNames, setEffectiveTags, filterByEffectiveTags } = require('find-test-names-tags'); // Get the full test structure (important: pass true for structure) const result = getTestNames(specSourceCode, true); console.log('Parsed structure root keys:', Object.keys(result)); // Compute effective tags for each test within the structure setEffectiveTags(result.structure); console.log('Effective tags for "should allow login":', result.structure[0].suites[0].tests[0].effectiveTags); // Filter tests by effective tags (e.g., find all smoke tests) const smokeTests = filterByEffectiveTags(result.structure, ['@smoke'], []); console.log('Found smoke tests:', smokeTests.map(t => t.name)); // Filter by multiple tags, excluding others (e.g., regression but not critical) const regressionExcludingCritical = filterByEffectiveTags(specSourceCode, ['@regression'], ['@critical']); console.log('Regression tests (excluding critical):', regressionExcludingCritical.map(t => t.name));
find-test-names-tags --version
Debug
Known issues
gotchaWhen `getTestNames` encounters test names defined by variables instead of literal strings, it will extract and process them, but the name in the output will be reported as `<unknown test>`.
fix
This is expected behavior and not an error. If exact variable-defined names are critical, ensure test names are always literal strings where possible.
affects: >=1.0.0
gotchaTo utilize functions like `setEffectiveTags` and access the nested test structure, you *must* pass `true` as the second argument to `getTestNames`. Omitting this argument returns a flat list of names, lacking the hierarchical structure required for tag propagation.
fix
Always call `getTestNames(sourceCode, true)` when you intend to work with the full `result.structure` for advanced tag processing.
affects: >=1.0.0
Errors
Common errors & fixes
TypeError: Cannot read properties of undefined (reading 'structure')
This error typically occurs when trying to access `result.structure` after calling `getTestNames()` without the `true` argument, which means the `structure` property was not populated.
fix
Ensure you call `const result = getTestNames(specSourceCode, true)` to correctly populate the `structure` property.
TypeError: getTestNames is not a function
This indicates an incorrect import statement. The package primarily uses CommonJS named exports, and attempting to use an ESM `import` or an incorrect `require` pattern will lead to this error.
fix
Use the CommonJS destructuring assignment: `const { getTestNames } = require('find-test-names-tags')`.
Upgrade
Version history
1.0.4latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/ManuelBuslon/find-test-names ↗
packagehttps://www.npmjs.com/package/find-test-names-tags ↗
find-test-names-tags — npm install find-test-names-tags · libregistry