# testcollab-cypress-plugin

> This package publishes your JSON test result file to TestCollab 2

Latest version **1.0.4** (published 2025-12-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install testcollab-cypress-plugin
pnpm add testcollab-cypress-plugin
yarn add testcollab-cypress-plugin
bun add testcollab-cypress-plugin
```

Provides the command `uploadTCRunResult`.

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2025-12-02 |
| First published | 2022-08-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 61.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | gigapro |

## Links

- npm: https://www.npmjs.com/package/testcollab-cypress-plugin
- npm.io page: https://npm.io/package/testcollab-cypress-plugin

## Dependencies (3)

- [yargs](https://npm.io/package/yargs.md) ^17.5.1
- [request](https://npm.io/package/request.md) ^2.88.2
- [testcollab-sdk](https://npm.io/package/testcollab-sdk.md) ^2.0.19-SNAPSHOT.202208172053

## Recent versions

- 1.0.4 (latest) — 2025-12-02
- 1.0.3 — 2022-08-17
- 1.0.2 — 2022-08-17
- 1.0.1 — 2022-08-09
- 1.0.0 — 2022-08-09

## README

# Test Collab Cypress reporter

This package publishes your JSON test result file to TestCollab 2

## Getting started

NODE_ENV environment variable must have any one value - "development" , "staging", "production"

Install using:
    npm install -g testcollab-cypress-plugin

this will make "uploadTCRunResult" command available for execution

Run following command:

    uploadTCRunResult --apiToken=<YOUR API TOKEN>  --projectId=<PROJECT ID>  --companyId=<COMPANY ID>  --testPlanId=<TEST PLAN ID>  --mochaJsonResult=<PATH TO mochawesome json FILE>

Notes: 
Your JSON file must follow mochawesome format. 

In order for this package to map executed test cases with their corresponding Test Collab test cases ID, IDs should be appended to 'title' property of your 'tests' array in JSON as follows:

    {
    "stats": {
        "suites": 1,
        "tests": 6,
        "passes": 2,
        ...
    },
    "results": [
        {
        "uuid": "..",
        ...
        "suites": [
            {
            "uuid": "..",
            "title": "Test suite",
            ...
            "tests": [
                {
                "title": "id-1",              <--  We parse ID from this
                "fullTitle": "Sample test",


[Download above sample file here](https://link)

If you are using [multiple configurations](https://www.youtube.com/watch?v=elA8sJzuavk) in your test run, then test plan configuration ID should be specified in similar way in 'suites' array under title property like this:

    {
    "stats": {
        "suites": 1,
        "tests": 6,
        "passes": 2,
        ...
    },
    "results": [
        {
        "uuid": "..",
        ...
        "suites": [
            {
            "uuid": "..",
            "title": "TestSuite-1",           <--  Test plan configuration ID
            ...
            "tests": [
                {
                "title": "id-1",              <--  Test Case ID
                "fullTitle": "Sample test",

[Download above sample file here](https://link)

## Support

Test Collab website: testcollab.com

---
_Source: https://npm.io/package/testcollab-cypress-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._