# @saucelabs/cucumber-reporter

> Reports your tests to Sauce Labs

Latest version **1.2.0** (published 2024-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @saucelabs/cucumber-reporter
pnpm add @saucelabs/cucumber-reporter
yarn add @saucelabs/cucumber-reporter
bun add @saucelabs/cucumber-reporter
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2024-10-10 |
| First published | 2022-09-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 18.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | devx |
| Maintainers | christina.tonkonogaya, joaquin.hurtado, webdev-saucelabs, gracjan.grala, david.missmann, thomas.fett, pawel-sauce, diego.molina, sakhi-sl, navrajsingh, it10403npm, rillgen-saucelabs, saucebot, krzysztof.sulejczak.sauce |

## Links

- npm: https://www.npmjs.com/package/@saucelabs/cucumber-reporter
- Homepage: https://github.com/saucelabs/sauce-cucumber-reporter#readme
- npm.io page: https://npm.io/package/@saucelabs/cucumber-reporter

## Dependencies (2)

- [@saucelabs/testcomposer](https://npm.io/package/@saucelabs/testcomposer.md) 3.0.1
- [@saucelabs/sauce-json-reporter](https://npm.io/package/@saucelabs/sauce-json-reporter.md) 4.1.0

## Recent versions

- 1.2.0 (latest) — 2024-10-10
- 1.1.1 — 2024-08-30
- 1.1.0 — 2024-06-07
- 1.0.0 — 2023-10-18
- 0.4.1 — 2023-01-13
- 0.4.0 — 2022-10-31
- 0.3.0 — 2022-10-05
- 0.2.0 — 2022-09-22

## README

# sauce-cucumber-reporter

This Cucumber plugin reports each project to your Sauce Labs account.

## Installation

Install from npm:

```sh
npm install @saucelabs/cucumber-reporter
```

### Sauce Labs Credentials

Set the `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables to enable the plugin to report your results to Sauce Labs. Your Sauce Labs Username and Access Key can be found in your [dashboard](https://app.saucelabs.com/user-settings).

## Usage

Add to your Cucumber formatter:

```sh
npx cucumber-js --format=@saucelabs/cucumber-reporter
```

Alternatively, configure it using `cucumber.json` by adding `'@saucelabs/cucumber-reporter'` to the reporter section of your configuration:

```json
{
  "default": {
    "requireModule": ["ts-node/register"],
    "format": "@saucelabs/cucumber-reporter"
  }
}
```

### Plugin Configuration

Configure the `@saucelabs/cucumber-reporter` through your Cucumber config file.

Example `cucumber.json`:

```json
{
  "default": {
    "requireModule": ["ts-node/register"],
    "format": "@saucelabs/cucumber-reporter",
    "formatOptions": {
      "name": "my cucumber test",
      "build": "mybuild",
      "tags": ["demo", "e2e", "cucumber"],
      "region": "eu-central-1"
    }
  }
}
```

Configuration Parameters:

| Name          | Description                                                                       | Type       |
| ------------- | --------------------------------------------------------------------------------- | ---------- |
| `browserName` | Sets the browser name.                                                            | `String`   |
| `build`       | Sets a build ID. Default: `''`.                                                   | `String`   |
| `tags`        | Tags to add to the uploaded Sauce job. Default: `[]`.                             | `String[]` |
| `region`      | Sets the region. Default: `us-west-1`.                                            | `String`   |
| `upload`      | Whether to upload report and assets to Sauce. Default: `true`.                    | `boolean`  |
| `outputFile`  | The local path to write the sauce test report. Default: `sauce-test-report.json`. | `String`   |
| `name`        | Sets the job name. Default: `Unnamed job ${job_id}`.                              | `String`   |

---
_Source: https://npm.io/package/@saucelabs/cucumber-reporter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._