Registry / testing / mocha-ctrf-json-reporter

mocha-ctrf-json-reporter

library0.0.11jsnpmunverified

This package provides a Mocha test reporter that generates test results in the Common Test Report Format (CTRF) as a JSON file. CTRF is an open, community-driven standard for normalizing test reports across different programming languages and test frameworks, enabling consistent validation, merging, comparison, and analysis of test results. The current stable version is `0.0.11`. Releases appear to be ad-hoc, primarily driven by dependency updates or feature additions, without a strict cadence. Its key differentiator is its adherence to the CTRF specification, providing a standardized output that integrates into a broader ecosystem of tools designed to consume CTRF data, abstracting away framework-specific report parsing. This allows for unified reporting in CI/CD pipelines.

testing

npm install mocha-ctrf-json-reporter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MOCHA-CTRF-JSON-RE

mocha-ctrf-json-reporter

testingjavascriptv0.0.11

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.

CTRFReporter

✓ import CTRFReporter from 'mocha-ctrf-json-reporter';

✗ import { CTRFReporter } from 'mocha-ctrf-json-reporter';

The reporter class is a default export, though direct import is rare as it's typically configured via a string in Mocha's runner.

ReporterOptions

✓ import type { ReporterOptions } from 'mocha-ctrf-json-reporter';

✗ import { ReporterOptions } from 'mocha-ctrf-json-reporter';

This type is not explicitly exported by the package but would be ideal for type-checking the `reporterOptions` object in user configurations. It's listed here as a conceptual import for comprehensive type usage.

CTRFReport

✓ import type { CTRFReport } from 'mocha-ctrf-json-reporter';

✗ import { CTRFReport } from 'mocha-ctrf-json-reporter';

This type, representing the structure of the generated CTRF JSON report, is not exported by this package. Users typically rely on the external CTRF specification for validation. Listed as a conceptual import for type safety if it were available.

Demonstrates installation, configuration via `.mocharc.js` with custom options including environment variables, and running example Mocha tests to generate a CTRF-compliant JSON report.

npm install --save-dev mocha mocha-ctrf-json-reporter // .mocharc.js module.exports = { reporter: 'mocha-ctrf-json-reporter', reporterOptions: { outputFile: 'my-custom-ctrf-report.json', outputDir: './test-reports', appName: 'MyAwesomeApp', appVersion: '1.0.0', buildName: 'CI Build', buildNumber: process.env.CI_BUILD_NUMBER ?? 'local-run', testEnvironment: process.env.NODE_ENV ?? 'development' } }; // test/example.test.js const assert = require('assert'); describe('Application Feature', function() { it('should handle basic arithmetic correctly', function() { assert.strictEqual(2 + 2, 4); }); it('should skip this test as an example', function() { this.skip(); assert.fail('This test should not be executed'); }); it('should correctly identify string length', function() { assert.strictEqual('hello'.length, 5); }); }); // To run the tests, add to package.json scripts: // "scripts": { // "test": "mocha" // } // Then run: npm test // The report will be found at ./test-reports/my-custom-ctrf-report.json

Debug

Known issues

gotchaReporter options are typically defined in `.mocharc.js`, `.mocharc.json`, or via CLI arguments. Programmatic configuration of Mocha reporters with specific `reporterOptions` can sometimes be less intuitive or require direct instantiation of the reporter class, which is not the primary use case for this package.

fix

Prefer using `.mocharc.js` or `.mocharc.json` for reporter configuration. For dynamic options, leverage environment variables within `.mocharc.js` and use nullish coalescing (e.g., `process.env.VAR ?? 'default'`) for robustness.

affects: >=0.0.1

gotchaThe default output file location is `ctrf/ctrf-report.json`. If not explicitly configured, multiple test runs or CI/CD pipelines might overwrite previous reports. Furthermore, ensure the output directory is accessible for writing.

fix

Always specify `outputDir` and `outputFile` in `reporterOptions` to control where reports are saved. Consider using dynamic filenames (e.g., with timestamps or build numbers) to prevent overwrites, potentially utilizing the `[hash]` token if supported by the underlying Mocha version and reporter configuration.

affects: >=0.0.10

gotchaThe Common Test Report Format (CTRF) is an evolving open standard. While this reporter aims for compliance with the latest specification, users consuming CTRF reports in other tools should ensure all components (reporter, consuming tools) are compatible with the specific CTRF version being generated to avoid parsing errors or data interpretation mismatches.

fix

Monitor the CTRF specification repository (github.com/ctrf-io/ctrf) for updates and ensure your entire test reporting toolchain is updated accordingly. Review generated reports against the latest CTRF schema if inconsistencies are observed.

affects: >=0.0.1

Errors

Common errors & fixes

Error: Cannot find module 'mocha-ctrf-json-reporter'

The reporter package has not been installed or is not accessible in the current execution environment.

fix

Run `npm install --save-dev mocha-ctrf-json-reporter` to install the package as a development dependency.

Report file 'ctrf-report.json' not found in 'ctrf/' directory.

Mocha tests might not have executed successfully, the reporter encountered an error, or the `outputDir` and `outputFile` configuration was incorrect, leading the report to be generated elsewhere or not at all.

fix

Verify that your Mocha tests are running and passing. Double-check the `reporterOptions` in your `.mocharc.js` or command-line arguments for correct `outputDir` and `outputFile` settings. Also, ensure the specified output directory exists or can be created by the reporter.

Mocha exited with error code 1 without generating a report.

This typically indicates that tests failed, or Mocha itself encountered a critical error before the reporter could finalize and write the report. The reporter will only write a report if the test run completes, even with failures.

fix

Examine Mocha's console output for specific test failures or critical errors. Address any failing tests or configuration issues. Ensure Mocha is configured to run at least one test; an empty test run might not produce a report.

Upgrade

Version history

0.0.11latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/ctrf-io/mocha-ctrf-json-reporter ↗

packagehttps://www.npmjs.com/package/mocha-ctrf-json-reporter ↗

homepagehttps://ctrf.io ↗