open-index/open-npm huggingface dataset:
npm package: @saucelabs/theme-github-codeblock
Description: A Docusaurus v2 plugin that supports referencing code examples from public GitHub repositories.
Author: Open Source Program Office Sauce Labs
Latest version: 0.3.0

Docusaurus Theme GitHub Codeblock ![Test Changes](https://github.com/saucelabs/docusaurus-theme-github-codeblock/workflows/Test%20Changes/badge.svg?branch=main)
=================================

A Docusaurus v2 plugin that supports referencing code examples from public GitHub repositories.

> Note: this theme plugin requires [Docusaurus v2](https://v2.docusaurus.io/)

## Install

First, add the theme plugin to your dependencies:

```sh
# NPM
npm install --save @saucelabs/theme-github-codeblock

# Yarn
yarn add @saucelabs/theme-github-codeblock
```

## Usage

Add the theme plugin to your list of themes in the `docusaurus.config.js`:

```js
    // ...
    themes: [
        '@saucelabs/theme-github-codeblock'
    ],
    // ...
```

In order to reference GitHub snippets in your markdown, create code blocks with a `reference` attached to the language meta string and put the link to your GitHub reference in the code block, e.g.:

    ```js reference
    https://github.com/saucelabs/docusaurus-theme-github-codeblock/blob/main/src/theme/ReferenceCodeBlock/index.tsx#L105-L108
    ```

You can also set a custom title:

    ```js reference title="Example"
    https://github.com/saucelabs/docusaurus-theme-github-codeblock/blob/main/src/theme/ReferenceCodeBlock/index.tsx#L105-L108
    ```

The plugin will download the code and display the desired lines:

![Plugin Example](https://github.com/saucelabs/docusaurus-theme-github-codeblock/raw/main/.github/assets/example.png 'Plugin Example')

---

If you are interested contributing to this project, see [CONTRIBUTING.md](CONTRIBUTING.md).
npm package: @saucelabs/visual
Description: JS client bindings for Sauce Labs Visual
Latest version: 0.16.0


# Sauce Labs Visual client library

This package provides a client and a CLI tool to interact with Sauce Labs Visual API.


**Note:** There are integrations available for [Cypress](https://www.npmjs.com/package/@saucelabs/cypress-visual-plugin) and [WebdriverIO](https://www.npmjs.com/package/@saucelabs/wdio-sauce-visual-service).


## Installation

```sh
npm install --save @saucelabs/visual
```
npm package: @saucelabs/visual-playwright
Description: Playwright Plugin / Bootstrapper for Sauce Labs Visual
Latest version: 0.7.0

# Sauce Labs Visual Playwright Integration

An extension for [Playwright](https://playwright.dev/) to integrate effortless visual testing with Sauce Labs Visual.

## Installation & Usage

View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/playwright/).

## Building

Install the dependencies

```sh
npm install
```

Build [Sauce Labs Visual client library](../visual/) since Sauce Labs Visual Playwright Integration depends on it

```sh
npm --prefix ../visual run build
```

Finally build Sauce Labs Visual Playwright Integration

```sh
npm run build
```

## Linting

```sh
npm run lint
```

## Running the tests

```sh
npm run test
```
npm package: @saucelabs/visual-snapshots
Description: CLI which generates Visual snapshots from a data source such as pdf
Latest version: 0.3.0

# Sauce Labs Visual Snapshot CLI

This package provides a CLI tool to create Visual snapshots of a provided PDF document.

## Requirements

```
node >= 20
```

## Installation

```sh
npm install --save @saucelabs/visual-snapshots
```

## Development

Build:

```sh
npm run build
```

Execute:

```sh
node lib/index.js pdf [params]
```

Run tests:

```sh
npm run test
```

## Reusing pdf conversion code

While it is possible to use `VisualSnapshotsApi` outside this package, please bear in mind it can only be used with ESM modules.
CommonJS modules are not supported.
npm package: @saucelabs/visual-storybook
Description: Storybook Plugin / Bootstrapper for Sauce Labs Visual
Latest version: 1.0.0

# Sauce Labs Visual Storybook Integration

An extension for [Storybook's test-runner](https://github.com/storybookjs/test-runner) to integrate effortless visual testing with Sauce Labs Visual.

## Installation & Usage

View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/storybook/).

## Building

Install the dependencies

```sh
npm install
```

Build [Sauce Labs Visual client library](../visual/) since Sauce Labs Visual Storybook Integration depends on it

```sh
npm --prefix ../visual run build
```

Finally build Sauce Labs Visual Storybook Integration

```sh
npm run build
```

## Linting

```sh
npm run lint
```

## Running the tests

```sh
npm run test
```
npm package: @saucelabs/wdio-sauce-visual-service
Description: WebdriverIO service that add visual checks capabilities using Sauce Labs Visual
Latest version: 0.13.0

# Sauce Labs Visual for WebdriverIO

This package is Sauce Labs Visual integration for WebdriverIO.

It comes as a service that you can add to your existing WebdriverIO project.

## Installation & Usage

View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/webdriverio/).

## Building

Install the dependencies

```sh
npm install
```

Build [Sauce Labs Visual client library](../visual/) since Sauce Labs Visual for WebdriverIO depends on it

```sh
npm --prefix ../visual run build
```

Finally build Sauce Labs Visual for WebdriverIO

```sh
npm run build
```

## Linting

```sh
npm run lint
```

## Running the tests

```sh
npm run test
```
npm package: @saucelabs/wdio-static-server-service
Description: Creates a static server for WebdriverIO.
Latest version: 1.0.3

# WDIO Static Server Service

[![npm](https://img.shields.io/npm/v/wdio-static-server-service.svg?style=flat-square)](https://www.npmjs.com/package/wdio-static-server-service) [![npm](https://img.shields.io/npm/dm/wdio-static-server-service.svg?style=flat-square)](https://www.npmjs.com/package/wdio-static-server-service) [![npm](https://img.shields.io/npm/l/wdio-static-server-service.svg?style=flat-square)](https://www.npmjs.com/package/wdio-static-server-service)

Some projects are front-end assets only and don't run on more than a static server. This service helps you to run a static file server during testing.

## Installation

The easiest way is to keep `wdio-static-server-service` as a devDependency in your `package.json`.

```json
{
  "devDependencies": {
    "wdio-static-server-service": "^1.0.0"
  }
}
```

You can simple do it by:

```bash
npm install wdio-static-server-service --save-dev
```

Instructions on how to install `WebdriverIO` can be found [here.](http://webdriver.io/guide/getstarted/install.html)

## Configuration

In order to use the static server service you need to add `static-server` to your service array:

```js
// wdio.conf.js
export.config = {
  // ...
  services: ['static-server'],
  // ...
};
```

## Options

### staticServerFolders (required)
Array of folder paths and mount points.

Type: `Array<Object>`
Props:
 - mount `{String}` - URL endpoint where folder will be mounted.
 - path `{String}` - Path to the folder to mount.

``` javascript
 // wdio.conf.js
 export.config = {
   // ...
   staticServerFolders: [
     { mount: '/fixtures', path: './tests/fixtures' },
     { mount: '/dist', path: './dist' },
   ],
   // ...
 };
```

### staticServerPort

Port to bind the server.

Type: `Number`

Default: `4567`

### staticServerLog

Debugging logs, will print mount points and requests. When `staticServerLogs` is set to `true` it will print into the console. Otherwise a string will be treated as the log folder.

Type: `Boolean` or `String`

### staticServerMiddleware

Array of middleware objects. Load and instatiate these in the config and pass them in for the static server to use.

Type: `Array<Object>`
Props:
 - mount `{String}` - URL endpoint where middleware will be mounted.
 - middleware `<Object>` - Middleware function callback

Default: `[]`

``` javascript
 // wdio.conf.js
 export.config = {
   const middleware = require('middleware-package');
   // ...
   staticServerMiddleware: [{
     mount: '/',
     middleware: middleware(/* middleware options */),
   }],
   // ...
 };
```

----

For more information on WebdriverIO see the [homepage](http://webdriver.io).