# @currents/node-test-reporter

### Requirements <a href="#requirements" id="requirements"></a>

* **Node.js** `v18.20.4+`

### Setup

```bash
npm install @currents/node-test-reporter @currents/cmd --save-dev
```

### Usage

#### Run the Tests

Run Node.js and set `@currents/node-test-reporter` reporter. The result is a refined JUnit XML that as the necessary information about the test results. More information is available [here](https://github.com/currents-dev/currents-reporter/blob/main/packages/node-test-reporter/README.md).

```bash
> node --test \
--test-reporter=@currents/node-test-reporter \
--test-reporter-destination=./report.xml \
**.test.mjs
```

#### Converting the Report

Run [currents convert](/resources/reporters/currents-cmd/currents-convert.md) command to covert the generated report into a format compatible with Currents.

```bash
> npx currents convert \
--framework=node \
--input-format=junit \
--input-file=./report.xml
```

#### Uploading the Results

Upload the results to Currents, specify the projectId and the [Record Key](/guides/record-key.md). Read more about [currents upload](/resources/reporters/currents-cmd/currents-upload.md) command.

```bash
npx currents upload --key=XXX --project-id=C3lBM6
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.currents.dev/resources/reporters/currents-node-test-reporter.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
