From 7b4940abb7ee355d302ae3923689d2fbfbc10432 Mon Sep 17 00:00:00 2001
From: Mark Erikson <mark@isquaredsoftware.com>
Date: Mon, 24 Jun 2024 23:09:32 -0400
Subject: [PATCH] Update Webpack plugin readme

---
 .../sourcemap-upload-webpack-plugin/README.md | 71 ++++++++++++++++++-
 1 file changed, 69 insertions(+), 2 deletions(-)

diff --git a/packages/sourcemap-upload-webpack-plugin/README.md b/packages/sourcemap-upload-webpack-plugin/README.md
index 259956f44..6ba7568d5 100644
--- a/packages/sourcemap-upload-webpack-plugin/README.md
+++ b/packages/sourcemap-upload-webpack-plugin/README.md
@@ -6,9 +6,76 @@ 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:
+the same options as [sourcemap-upload][1], along with some additional options:
 
 ```typescript
+// Exported from `@replayio/sourcemap-upload`
+export interface UploadOptions {
+  /**
+   * 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.REPLAY_API_KEY`.
+   */
+  key?: string;
+  /**
+   * Run all of the local processing and searching for maps, but skip uploading them.
+   */
+  dryRun?: boolean;
+  /**
+   * Delete all found sourcemap files after they have been uploaded.
+   */
+  deleteAfterUpload?: boolean;
+  /**
+   * If sourcemaps can't be matched to generated files by their sourceMappingURL, try matching by filenames on disk
+   */
+  matchSourcemapsByFilename?: 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;
+  /**
+   * A callback function that will be called with log messages.
+   */
+  log?: LogCallback;
+  /**
+   * URL of the Replay server to upload to. Defaults to `https://api.replay.io`.
+   */
+  server?: string;
+  /**
+   * The number of concurrent uploads to perform. Defaults to 25.
+   */
+  concurrency?: number;
+  /**
+   * A string to append to the User-Agent header when making requests to the Replay API.
+   */
+  userAgentAddition?: string;
+}
+
+// Exported from `@replayio/sourcemap-upload-webpack-plugin`
 export interface PluginOptions extends UploadOptions {
   // Choose how verbose the plugin should be when logging.
   logLevel?: "quiet" | "normal" | "verbose";
@@ -20,4 +87,4 @@ export interface PluginOptions extends UploadOptions {
 }
 ```
 
-[1]: ../sourcemap-upload
+[1]: https://www.npmjs.com/package/@replayio/sourcemap-upload