gem-hunter

• 🪜 Supports multiple bundlers and frameworks - including webpack, vite, rollup, nuxt and so on.
• ✨ Auto-detect configs depending on current environment - config as less as you need
• 🧹 Auto clean local soucemap files after upload (For security) - both *.js.map and *.css.map.
• 🍬 Optional runtime provided - easy to init Sentry at runtime.

npm i unplugin-sentry -D

// vite.config.ts
import unpluginSentry from 'unplugin-sentry/vite'

export default defineConfig({
  plugins: [
    unpluginSentry({ /* options */ }),
  ],
})

Example: playground/vite

// rollup.config.js
import unpluginSentry from 'unplugin-sentry/rollup'

export default {
  plugins: [
    unpluginSentry({ /* options */ }),
  ],
}

Example: playground/rollup

// webpack.config.js
module.exports = {
  /* ... */
  plugins: [
    require('unplugin-sentry/webpack')({ /* options */ })
  ]
}

Example: playground/webpack

This module works for Webpack >= 3

// nuxt.config.js
export default {
  buildModules: [
    ['unplugin-sentry/nuxt', { /* options */ }],
  ],
}

Example: playground/nuxt

This module works for both Nuxt 2 and Nuxt Vite

// vue.config.js
module.exports = {
  configureWebpack: {
    plugins: [
      require('unplugin-sentry/webpack')({ /* options */ }),
    ],
  },
}

I don't use esbuild for now, so it haven't been tested in esbuild yet. (You can have a try and tell me if it works 👂. )

Besides uploading sourcemap to Sentry and other publishing works, this plugin also injects a virtual module named virtual-unplugin-sentry-runtime into your project.

It provides some useful meta info when initing Sentry at runtime. For example, when you call Sentry.init({/** options **/}), the environment and release options must match the one you use when uploading sourcemap. So that when debugging the issue in Sentry, the sourcemap can be correctly mapped.

import * as sentryMeta from 'virtual-unplugin-sentry-runtime'

console.log(sentryMeta)
// {
//   ORG: string
//   PROJECT: string
//   ENV: string
//   RELEASE: string
//   DIST: string
//   PUBLISH: boolean
// }

Need TS support for this runtime module? Just add the following config to your tsconfig.json.

{
  "compilerOptions": {
    "types": ["unplugin-sentry/runtime"]
  }
}

Extends from @sentry/cli - SentryCliOptions.

Extends from @sentry/cli - SentryCliUploadSourceMapsOptions.

Extends from @sentry/cli - SentryCliNewDeployOptions.

Extends from @sentry/cli - SentryCliCommitsOptions.

MIT License © 2021-Present kricsleo