open-index/open-npm huggingface dataset:
npm package: @recordreplay/puppeteer-config
Description: Configuration utilities for using the Replay browsers with puppeteer
Latest version: 0.1.2
Deprecated: Please use @replayio/puppeteer instead

# `@recordreplay/puppeteer-config`

Provides utilities to support using [Replay](https://replay.io) with [Puppeteer](https://pptr.dev)

Exports
* `getExecutablePath(browserName: string)` - Returns the path to the replay browser for the given `browserName`: only `"chromium"` is currently supported. If `browserName` isn't supported on the current platform, `undefined` is returned.
* `devices` - Object of configurations suitable for using with `@puppeteer/test`. Currently only supports a `"Replay Chromium"` configuration. If the configuration isn't supported on the current platform, a warning is emitted and the `executablePath` will be undefined.

## Using standalone

If you are using `puppeteer` (rather than `@recordreplay/puppeteer`), you can configure it to use the Replay browser by passing in the `executablePath` to `launch()`.

```js
const puppeteer = require("puppeteer");
const { getExecutablePath } = require("@recordreplay/puppeteer-config");

(async () => {
	const browser = await puppeteer.launch({
		headless: false,
		executablePath: getExecutablePath("chromium"),
	});
	const page = await browser.newPage();
	await page.goto("https://replay.io");
	await page.screenshot({ path: "replay.png" });

	await page.close();
	await browser.close();
})();
```
npm package: @recordreplay/replay-node-cli
Description: CLI tool for creating recordings using the replay version of node
Latest version: 0.1.7
Deprecated: Please use @replayio/node instead

# replay-node-cli

CLI tool for creating recordings using the [Replay](https://replay.io) version of node.

## Overview

The replay version of node is a replacement for the `node` executable which saves a recording of its behavior to disk that can be uploaded to the record/replay web service for viewing.  `replay-node` is a CLI tool that allows the replay version of node to be selectively used when running node scripts.

## Installation

`npm i @recordreplay/replay-node-cli --global`

## Usage

`replay-node` can be used in the following ways to create recordings.  Afterwards, use the [replay-recordings](https://www.npmjs.com/package/@recordreplay/recordings-cli) CLI tool to manage and upload the recordings.

`replay-node script.js ...args`

Use the replay version of node to record a specific script and arguments.

`replay-node --exec executable ...args`

Run an executable command with `$PATH` updated so that all node scripts will use the Replay version of node to record their behavior.

`replay-node --update`

Ensure the replay version of node is downloaded/updated.

### Supported environment variables:

- RECORD_REPLAY_DIRECTORY (defaults to $HOME/.replay)
- RECORD_REPLAY_NODE_DIRECTORY (defaults to $RECORD_REPLAY_DIRECTORY/node)
  Allows to specify a folder in which the replay-patched `node` binary is to be found.
- RECORD_REPLAY_DRIVER
  Allows you to specify the path to the `recordreplay.so` driver library.
npm package: @recordreplay/sourcemap-upload
Description: A utility library for uploading sourcemaps to Replay for use while replaying recordings.
Author: Logan Smyth
Latest version: 0.1.4
Deprecated: Please use @replayio/sourcemap-upload instead

# @recordreplay/sourcemap-upload

Provides an NPM library allows uploading sourcemaps to Replay's servers so
that they can be used when viewing recordings.

## Usage

This module will search the given filepaths for JS files and sourcemap files,
and then it will use the `file` field of the sourcemap or the `//# sourceMappingURL=`
comments in the JS to find pairs of sourcemap and JS file.

## Debugging

If no sourcemaps are being found, consider running the function with verbose
mode enabled, or with `DEBUG=recordreplay:sourcemap-upload` set in the environment.

Most likely, if sourcemaps are not being found, they either:

- have no `file` property referencing their associated JS file
- the generated file has `//# sourceMappingURL=`

Either of these links is sufficient, so if changing the generated code to include a
`//# sourceMappingURL=` comment is not what you want, including `file` is enough,
and vice-versa.

## API

This module exports a named `uploadSourceMaps` function with the following options:

```typescript
interface Options {
  /**
   * The files/directories to search for sourcemaps. All files that match the
   * 'extensions' list and fail to match 'ignore' will be searched for
   * sourcemap JSON or `//#sourceMappingURL=` coments in order to find pairs
   * of generated-file + sourcemap, and the sourcemap will be uploaded.
   */
  filepaths: Array<string> | string;

  /**
   * To allow for tracking and browsing of maps that have been uploaded, we
   * require uploaded sourcemaps to have an overall group name associated with
   * them. This could for instance be a version number, or commit hash.
   */
  group: string;

  /**
   * The API key to use when connecting to Replay's servers.
   * Defaults to `process.env.RECORD_REPLAY_API_KEY`.
   */
  key?: string;

  /**
   * Run all of the local processing and searching for maps, but skip uploading them.
   */
  dryRun?: boolean;

  /**
   * The set of file extensions to search for sourcemap-related data.
   * Defaults to [".js", ".map"].
   */
  extensions?: Array<string>;

  /**
   * The set of pattern for files to ignore when searching for sourcemap-related data.
   */
  ignore?: Array<string>;

  /**
   * Set the directory that relative paths should be computed with respect to.
   * The relative path of sourcemaps is included in the uploaded entry, and will be
   * visible in the UI, so this can be used to strip off unimportant directories in
   * the build path. Defaults to `process.cwd()`.
   */
  root?: string;
}
```
npm package: @recordreplay/sourcemap-upload-cli
Description: A CLI application for uploading sourcemaps to Replay for use while replaying recordings.
Author: Logan Smyth
Latest version: 0.1.1
Deprecated: Please use @replayio/replay instead

# @recordreplay/sourcemap-upload-cli

Provides a CLI application that allows uploading production sourcemaps to
Replay's servers so that they can be used when viewing recordings.

## `replay-sourcemap-upload` CLI command

The CLI command `replay-sourcemap-upload [opts] <paths...>` has the following options:

- `<paths>`: (Required) A set of files or directories to search for generated files and sourcemap files.
- `--group`: (Required) To allow for tracking and browsing of maps that have been uploaded, we
  require uploaded names to have an overall group name associated with them.
  This could for instance be a version number, or commit hash.
- `--key`: The API key to use when connecting to Replay's servers.
  Defaults to `process.env.RECORD_REPLAY_API_KEY`.
- `--root`: Set the directory that relative paths should be computed with respect to. The relative path
  of sourcemaps is included in the uploaded entry, and will be visible in the uploaded-asset UI, so this
  can be used to strip off unimportant directories in the build path. Defaults to `process.cwd()`.
- `--ignore`: Provide an ignore pattern for files to ignore when searching for sourcemap-related data.
  This may be passed multiple times to ignore multiple things.
- `--quiet`: Tell the CLI to output nothing to stdout. Errors will still log to stderr.
- `--verbose`: Output additional information about the sourcemap map search.
- `--dry-run`: Run all of the local processing and searching for maps, but skip uploading them.
- `--extensions`: The comma-separated set of file extensions to search for sourcemap-related data.
  Defaults to `".js,.map"`.
npm package: @recordreplay/sourcemap-upload-webpack-plugin
Description: A webpack plugin to run Replay's sourcemap-upload logic when Webpack compilation finishes.
Author: Logan Smyth
Latest version: 0.1.2
Deprecated: Please use @replayio/sourcemap-upload-webpack-plugin instead

# @recordreplay/sourcemap-upload-webpack-plugin

Wraps Replay's [sourcemap-upload][1] module in a Webpack plugin so that it
will execute automatically when the Webpack build has completed.

## PluginOptions

The Webpack plugin, which is the default export of this module, exposes all of
the same options as [sourcemap-upload][1], along with some additional:

```typescript
export interface PluginOptions extends UploadOptions {
  // Choose how verbose the plugin should be when logging.
  logLevel?: "quiet" | "normal" | "verbose";

  // Normally failure to upload the sourcemaps will result
  // in a build error. If you'd like to simply warn instead
  // of failing in this case, you can set this to true.
  warnOnFailure?: boolean,
}
```

[1]: https://github.com/recordreplay/sourcemap-upload