Patchly Build Plugin

Upload source maps to Patchly after your production build so captured stack traces can point back to the original source.

Install

npm install -D @patchly/build-plugin

Set the credentials from your Patchly project:

PATCHLY_DSN=https://[email protected]/project_id
PATCHLY_AUTH_TOKEN=psk_...

Vite

import { patchlyVite } from "@patchly/build-plugin/vite";
import { defineConfig } from "vite";

export default defineConfig({
	build: {
		sourcemap: true,
	},
	plugins: [
		patchlyVite({
			authToken: process.env.PATCHLY_AUTH_TOKEN!,
			release: process.env.VERCEL_GIT_COMMIT_SHA,
		}),
	],
});

Webpack

const { PatchlyWebpackPlugin } = require("@patchly/build-plugin/webpack");

module.exports = {
	devtool: "source-map",
	plugins: [
		new PatchlyWebpackPlugin({
			authToken: process.env.PATCHLY_AUTH_TOKEN,
			release: process.env.VERCEL_GIT_COMMIT_SHA,
		}),
	],
};

Next.js

import { withPatchlySourceMaps } from "@patchly/build-plugin/turbopack";

const nextConfig = {};

export default withPatchlySourceMaps(nextConfig, {
	authToken: process.env.PATCHLY_AUTH_TOKEN!,
	release: process.env.VERCEL_GIT_COMMIT_SHA,
});

Configuration

• authToken: project API token used to upload source maps.
• release: release identifier. Use the same value in the SDK, such as VERCEL_GIT_COMMIT_SHA.
• deleteSourceMaps: delete .map files after upload. Defaults to true.
• endpoint: Patchly API endpoint. Defaults to https://api.patchly.cc.
• silent: suppress console output.

Links

• Docs: https://patchly.cc/docs
• Dashboard: https://patchly.cc
• Issues: https://github.com/tooyipjee/patchly/issues