@honeybadger-io/rollup-plugin
v5.10.0
Published
A rollup plugin to upload sourcemaps to Honeybadger
Downloads
15,326
Readme
Honeybadger's Rollup Source Map Plugin
Rollup plugin to upload JavaScript source maps and optionally send deployment notifications to Honeybadger.
Supports rollup version 3. If you use rollup version 2, you can either upgrade or send your source maps to Honeybadger's API directly.
Installation
# npm
npm install @honeybadger-io/rollup-plugin --save-dev
# yarn
yarn add @honeybadger-io/rollup-plugin --dev
Configuration
Plugin parameters
These plugin parameters correspond to the Honeybadger Source Map Upload API and Deployments API.
rollup.config.js
Set output.sourcemap
to true
or 'hidden'
. Add the honeybadger plugin to the plugins array.
import honeybadgerRollupPlugin from '@honeybadger-io/rollup-plugin'
// See plugin params above
const hbPluginOptions = {
apiKey: 'your_key_here',
assetsUrl: 'https://yoursite.foo'
}
export default {
input: 'src/index.js',
output: {
dir: 'dist',
sourcemap: true // Must be true or 'hidden'
},
plugins: [ honeybadgerRollupPlugin(hbPluginOptions) ],
}
Using Vite: vite.config.js
If you're using Vite, you'll set up vite.config.js
instead of rollup.config.js
.
Set build.sourcemap
to true
or 'hidden'
. Add the honeybadger
plugin to rollupOptions.plugins
.
Note: Be careful not to add it to the top-level vite plugins without additional config, or it will upload source maps on serve
rather than just on build
.
import honeybadgerRollupPlugin from '@honeybadger-io/rollup-plugin'
import { defineConfig } from 'vite'
// See plugin params above
const hbPluginOptions = {
apiKey: 'your_key_here',
assetsUrl: 'https://yoursite.foo'
}
export default defineConfig({
plugins: [], // Not here
build: {
sourcemap: true, // Must be true or 'hidden'
rollupOptions: {
plugins: [ honeybadgerRollupPlugin(hbPluginOptions) ]
}
}
})
Development
- Run
npm install
- Run the tests with
npm test
- Build with
npm run build
See the /examples
folder for projects to test against.
License
This package is MIT licensed. See the MIT-LICENSE file in this folder for details.