X-Feature Reporter

Generates or updates documentation with the results of a test run. Not intended to be used directly. Rather, use it as a base for your custom reporter.

Existing reporters:

• playwright-feature-reporter
• jest-feature-reporter

(want to add your own? open a PR!)

Reporters

x-feature-reporter accepts a standardized javascript object that represents a test run with results. It then performs some transformations and hands off the data to an adapter for output.

Usually, a reporter will be created to convert a test framework's native output format into the standardized format. The reporter will instantiate XFeatureReporter with an adapter, and then call generateReport with the test results.

For example, if you're using Playwright and want to publish your test results to a markdown file (which is what this project is doing), you can use the playwright-feature-reporter project, which uses x-feature-reporter as a base.

An additional example is jest-feature-reporter, which publishes Jest test results to markdown.

Adapters

x-feature-reporter uses adapters to support different output formats. The default adapter is Markdown, but you can easily implement your own adapter. For example, you could implement an adapter for outputting to Word, PDF, or even publishing via an API to slack or notion.

x-feature-reporter is additionally bundled with a JSON adapter, which outputs the standardized, transformed data as a JSON file. This can be useful if you want to further process the data (for example, combine it with the results of other test runs).

You can supply your own adapter by implementing the XAdapter interface.

Usage example

In your own reporter, you can use x-feature-reporter as follows:

const xsuite = {/* your test results */} as XTestSuite;
const reporter = new XFeatureReporter(new MyCustomAdapter({
      ...myCustomAdapterOptions
}));
reporter.generateReport(xsuite);

Features

The below section was generated using Playwright-feature-reporter, which is based on this library.

Markdown generation

Suites (headings)

• ✅ Suites appear as headings. Nested Suites are nested headings
• ✅ Suites can be marked as transparent: They will not be printed but their children will be printed
• ✅ Suites with the same name have their results merged, and the heading is shown only once
• ✅ Suites containing only non-behavioral tests are not shown in the report

TestResults (features)

• ✅ TestResults appear as list items representing features. Each feature is visually marked as Passing ✅, Failing ❌ or Skipped 🚧
• ✅ Only XTestResults with testType 'behavior' appear as features. If testType is note specified, it's assumed to be 'behavior'
• ✅ Features can nest under other features using a '-' prefix
  • ✅ Features can nest multiple levels deep using multiple '-' prefixes

Embedding

• ✅ The features list is embedded in an existing file between placeholders
• ✅ The closing placeholder can be ommitted if the feature list is intended as the last content in the file

Options

• ✅ Placeholder prefix can be specified using the 'embeddingPlaceholder' option
• ✅ A link to a full test report will be included when the 'fullReportLink' option is provided

JSON generation

• ✅ Generates a JSON file
• 🚧 Suites can be marked as transparent: They will not be printed but their children will be printed

Test report