open-index/open-npm huggingface dataset:
npm package: @orangebeard-io/jasmine-orangebeard-reporter
Description: A reporter to send Jasmine output to Orangebeard.io
Author: Orangebeard.io
Latest version: 1.0.0

<h1 align="center">
  <a href="https://github.com/orangebeard-io/jasmine-listener">
    <img src="https://raw.githubusercontent.com/orangebeard-io/jasmine-listener/main/.github/logo.svg" alt="Orangebeard.io Jasmine Listener" height="200">
  </a>
  <br>Orangebeard.io Jasmine Listener<br>
</h1>

<h4 align="center">Orangebeard listener for <a href="https://jasmine.github.io/" target="_blank" rel="noopener">Jasmine</a></h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@orangebeard-io/jasmine-orangebeard-reporter">
    <img src="https://img.shields.io/npm/v/@orangebeard-io/jasmine-orangebeard-reporter.svg?style=flat-square"
      alt="NPM Version" />
  </a>
  <a href="https://github.com/orangebeard-io/jasmine-listener/actions">
    <img src="https://img.shields.io/github/actions/workflow/status/orangebeard-io/jasmine-listener/release.yml?branch=main&style=flat-square"
      alt="Build Status" />
  </a>
  <a href="https://github.com/orangebeard-io/jasmine-listener/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/orangebeard-io/jasmine-listener?style=flat-square"
      alt="License" />
  </a>
</p>

<div align="center">
  <h4>
    <a href="https://orangebeard.io">Orangebeard</a> |
    <a href="#installation">Installation</a> |
    <a href="#configuration">Configuration</a>
  </h4>
</div>

## Installation

### Install the npm package

```shell
npm install @orangebeard-io/jasmine-orangebeard-reporter
```

## Configuration

Create orangebeard.json (in your test projects's folder (or above))

```JSON
{
  "endpoint": "https://XXX.orangebeard.app",
  "accessToken": "00000000-0000-0000-0000-00000000",
  "project": "my_project_name",
  "testset": "My Test Set Name",
  "description": "A run from jasmine",
  "attributes": [
    {
      "key": "SomeKey",
      "value": "SomeValue"
    },
    {
      "value": "Tag value"
    }
  ]
}
```

Configure the reporter in jasmine-config.ts:
```ts
export default defineConfig({
    testDir: './my-tests',
    reporter: [['@orangebeard-io/jasmine-orangebeard-reporter']],
    projects: [
        {
            name: 'chromium',
            use: { ...devices['Desktop Chrome'] },
        }]
});
```

### Running

Run your tests as usual!

Alternatively, configure Orangebeard variables as ENV (without or on top of orangebeard.json):

```shell
 ORANGEBEARD_ENDPOINT=https://company.orangebeard.app
 ORANGEBEARD_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 ORANGEBEARD_PROJECT="my project"
 ORANGEBEARD_TESTSET="my test set"
 ORANGEBEARD_DESCRIPTION="My awesome testrun"
 ORANGEBEARD_ATTRIBUTES="key:value; value;"
 ```
npm package: @orangebeard-io/javascript-client
Description: Orangebeard client for JavaScript
Author: Orangebeard.io
Latest version: 2.0.8

<h1 align="center">
  <a href="https://github.com/orangebeard-io/javascript-client">
    <img src="https://raw.githubusercontent.com/orangebeard-io/javascript-client/main/.github/logo.svg" alt="Orangebeard.io JavaScript Client" height="200">
  </a>
  <br>Orangebeard.io JavaScript Client<br>
</h1>

<h4 align="center">Orangebeard client for Javascript.</h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@orangebeard-io/javascript-client">
    <img src="https://img.shields.io/npm/v/@orangebeard-io/javascript-client.svg?style=flat-square"
      alt="NPM Version" />
  </a>
  <a href="https://github.com/orangebeard-io/javascript-client/actions">
    <img src="https://img.shields.io/github/actions/workflow/status/orangebeard-io/javascript-client/release.yml?branch=main&style=flat-square"
      alt="Build Status" />
  </a>
  <a href="https://github.com/orangebeard-io/javascript-client/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/orangebeard-io/javascript-client?style=flat-square"
      alt="License" />
  </a>
</p>

<div align="center">
  <h4>
    <a href="https://orangebeard.io">Orangebeard</a> |
    <a href="#installation">Installation</a> |
    <a href="#configuration">Configuration</a>
  </h4>
</div>

## Installation

### Install the npm package

```shell
npm install --save-dev @orangebeard-io/javascript-client
```

## Build from source
```shell
npm run build
```
Make sure to have typescript installed.

## Configuration
  
Usually, the client is used from a listener that connects the client to a test tool. Listeners can provide their own OrangebeardParameters object.  
If no configuration object is provided, the client will try to auto-configure in the following ways: 

### orangebeard.json

Look for a config file named `orangebeard.json` in the current working directory or higher in the hierarchy (it will scan all the way up to `/`). The json file is expected to contain an OrangebeardParameters object: 
 ```json
 {
	"endpoint": "https://my.orangebeard.app",
	"token": "xxxxxxxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx",
	"project": "my-project",
	"testset": "Test set name",
	"description": "Test run description",
	"attributes": [
		{
			"key": "Key 1",
			"value": "Some value"
		},
		{
			"value": "Tag value"
		}
	],
    "referenceUrl": "https://my-ref-url.tld/ref" 
}
```

### Environment variables
The auto config will scan for environment variables:

 ```shell
 ORANGEBEARD_ENDPOINT=https://company.orangebeard.app
 ORANGEBEARD_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 ORANGEBEARD_PROJECT=piet_personal
 ORANGEBEARD_TESTSET=piet_TEST_EXAMPLE
 ORANGEBEARD_DESCRIPTION=My awesome testrun
 ORANGEBEARD_ATTRIBUTES=key:value; value;
 ORANGEBEARD_REFERENCE_URL=https://my-ref-url.tld/ref
 ```
 Note that if auto configuration is used and a value is present in both orangebeard.json and in the environment settings, the environment setting will take precedence.
npm package: @orangebeard-io/jest-listener
Description: Orangebeard listener for the Javascript Jest unit test framework
Author: Orangebeard.io
Latest version: 2.0.3

<h1 align="center">
  <a href="https://github.com/orangebeard-io/jest-listener">
    <img src="https://raw.githubusercontent.com/orangebeard-io/jest-listener/master/.github/logo.svg" alt="Orangebeard.io Jest Listener" height="200">
  </a>
  <br>Orangebeard.io Jest Listener<br>
</h1>

<h4 align="center">Orangebeard listener for the Javascript <a href="https://jestjs.io/" target="_blank" rel="noopener">Jest</a> unit test framework.</h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@orangebeard-io/jest-listener">
    <img src="https://img.shields.io/npm/v/@orangebeard-io/jest-listener.svg?style=flat-square"
      alt="NPM Version" />
  </a>
  <a href="https://github.com/orangebeard-io/jest-listener/actions">
    <img src="https://img.shields.io/github/actions/workflow/status/orangebeard-io/jest-listener/release.yml?branch=main&style=flat-square"
      alt="Build Status" />
  </a>
</p>

<div align="center">
  <h4>
    <a href="https://orangebeard.io">Orangebeard</a> |
    <a href="#installation">Installation</a> |
    <a href="#configuration">Configuration</a>
  </h4>
</div>

## Installation

### Install the npm package

```shell
npm install --save-dev @orangebeard-io/jest-listener
```

## Configuration

In your jest config section of `package.json`, add the following entry:

```JSON
{
    "jest": {
        ...
        "reporters": ["default","@orangebeard-io/jest-listener"],
        ...
    }
}
```

For projects with Create-React-App the above Jest config doesn't work. You should edit the test command in the `package.json` like this:

```json
...
  "scripts": {
    ...
    "test": "react-scripts test --reporters=default --reporters=@orangebeard-io/jest-listener",
    ...
  },
...
```

Create a new file named `orangebeard.json` in the project root folder, next to `package.json`. Add the following entry:

```JSON
{
  "endpoint": "https://app.orangebeard.io/[ORGANIZATION]",
  "token": "[LISTENER TOKEN]",
  "project": "example-project",
  "testset": "Jest Test set",
  "description": "Jest run",
  "attributes": [
    {
      "key": "Tool",
      "value": "Jest"
    }
  ],
  "referenceUrl": "https://docs.orangebeard.io/"
}

```

__It's good practice__ to omit the token from the json file and get it from your env:

Windows cmd:
```
set orangebeard_token=[LISTENER TOKEN]
```
Linux/Mac:
```
export orangebeard_token=[LISTENER TOKEN]
```

### Environment properties

Properties can also be set in the build, by passing them as environment variables.  
It's important to mention that environment variables have precedence over the `orangebeard.json` definition.

```shell
$ export ORANGEBEARD_ENDPOINT=https://app.orangebeard.io/[ORGANIZATION]
$ export ORANGEBEARD_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
$ export ORANGEBEARD_PROJECT=example_project
$ export ORANGEBEARD_TESTSET=Jest testset
$ export ORANGEBEARD_DESCRIPTION=My awesome testrun
$ export ORANGEBEARD_ATTRIBUTES=key:value; value;
```
npm package: @orangebeard-io/playwright-orangebeard-reporter
Description: A Playwright reporter to report to Orangebeard.io
Author: Orangebeard.io
Latest version: 1.0.8

<h1 align="center">
  <a href="https://github.com/orangebeard-io/playwright-listener">
    <img src="https://raw.githubusercontent.com/orangebeard-io/playwright-listener/main/.github/logo.svg" alt="Orangebeard.io Playwright Listener" height="200">
  </a>
  <br>Orangebeard.io Playwright Listener<br>
</h1>

<h4 align="center">Orangebeard listener for <a href="https://playwright.dev" target="_blank" rel="noopener">Playwright</a></h4>

<p align="center">
  <a href="https://www.npmjs.com/package/@orangebeard-io/playwright-orangebeard-reporter">
    <img src="https://img.shields.io/npm/v/@orangebeard-io/playwright-orangebeard-reporter.svg?style=flat-square"
      alt="NPM Version" />
  </a>
  <a href="https://github.com/orangebeard-io/playwright-listener/actions">
    <img src="https://img.shields.io/github/actions/workflow/status/orangebeard-io/playwright-listener/release.yml?branch=main&style=flat-square"
      alt="Build Status" />
  </a>
  <a href="https://github.com/orangebeard-io/playwright-listener/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/orangebeard-io/playwright-listener?style=flat-square"
      alt="License" />
  </a>
</p>

<div align="center">
  <h4>
    <a href="https://orangebeard.io">Orangebeard</a> |
    <a href="#installation">Installation</a> |
    <a href="#configuration">Configuration</a>
  </h4>
</div>

## Installation

### Install the npm package

```shell
npm install @orangebeard-io/playwright-orangebeard-reporter
```

## Configuration

Create orangebeard.json (in your test projects's folder (or above))

```JSON
{
  "endpoint": "https://XXX.orangebeard.app",
  "token": "00000000-0000-0000-0000-00000000",
  "project": "my_project_name",
  "testset": "My Test Set Name",
  "description": "A run from playwright",
  "attributes": [
    {
      "key": "SomeKey",
      "value": "SomeValue"
    },
    {
      "value": "Tag value"
    }
  ]
}
```

Configure the reporter in playwright-config.ts:
```ts
export default defineConfig({
    testDir: './my-tests',
    reporter: [['@orangebeard-io/playwright-orangebeard-reporter']],
    projects: [
        {
            name: 'chromium',
            use: { ...devices['Desktop Chrome'] },
        }]
});
```

### Running

Run your tests as usual!

Alternatively, configure Orangebeard variables as ENV (without or on top of orangebeard.json):

```shell
 ORANGEBEARD_ENDPOINT=https://company.orangebeard.app
 ORANGEBEARD_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 ORANGEBEARD_PROJECT="my project"
 ORANGEBEARD_TESTSET="my test set"
 ORANGEBEARD_DESCRIPTION="My awesome testrun"
 ORANGEBEARD_ATTRIBUTES="key:value; value;"
 ```