@honeybadger-io/webpack

Honeybadger's Webpack Source Map Plugin

This is a webpack plugin to upload javascript sourcemaps to Honeybadger's API endpoint for source maps.

Word Up! to the thredUP development team for a similar webpack plugin they have authored.

Installation

Installing via Node.js

npm install @honeybadger-io/webpack --save-dev

Configuration

Plugin parameters

These plugin parameters correspond to the Honeybadger Sourcemap API.

apiKey (required)

The API key of your Honeybadger project

assetsUrl (required)

The base URL to production assets (scheme://host/path)*wildcards are supported. The plugin combines assetsUrl with the generated minified js file name to build the API parameter minified_url

revision (optional — default: "master")

The deploy revision (i.e. commit sha) that your source map applies to. This could also be a code version. For best results, set it to something unique every time your code changes.

silent (optional — default: "null/false")

If true, silence log information emitted by the plugin.

ignoreErrors (optional — default: "null/false")

If true, webpack compilation errors are treated as warnings.

Vanilla webpack.config.js

const HoneybadgerSourceMapPlugin = require('@honeybadger-io/webpack')
const ASSETS_URL = 'https://cdn.example.com/assets';
const webpackConfig = {
  plugins: [new HoneybadgerSourceMapPlugin({
    apiKey: 'abc123',
    assetsUrl: ASSETS_URL,
    revision: 'master'
  })]
}

Rails Webpacker config/webpack/environment.js

const { environment } = require('@rails/webpacker')
const HoneybadgerSourceMapPlugin = require('@honeybadger-io/webpack')

// Assumes Heroku / 12-factor application style ENV variables
// named GIT_COMMIT, HONEYBADGER_API_KEY, ASSETS_URL
const revision = process.env.GIT_COMMIT || 'master'

environment.plugins.append(
  'HoneybadgerSourceMap',
  new HoneybadgerSourceMapPlugin({
    apiKey: process.env.HONEYBADGER_API_KEY,
    assetsUrl: process.env.ASSETS_URL,
    silent: false,
    ignoreErrors: false,
    revision: revision
  }))

module.exports = environment

Development

1. Run npm install
2. Run the tests with npm test
3. Build/test on save with npm run build:watch and npm run test:watch.

License

This package is MIT licensed. See the MIT-LICENSE file in this folder for details.

Changelog

4.2.0 (2022-09-13)

Features

• migrate honeybadger-webpack to monorepo (#869) (0c31c1a)
• workflow for automatic (scheduled) releases (#867) (1f01d94), closes #861