A webpack plugin acting as an interface to Sentry CLI.

Using npm:

$ npm install @sentry/webpack-plugin

Using yarn:

$ yarn add @sentry/webpack-plugin

You can use either .sentryclirc file or ENV variables described here https://docs.sentry.io/learn/cli/configuration/

const SentryCliPlugin = require('@sentry/webpack-plugin');

const config = {
  plugins: [
    new SentryCliPlugin({
      include: '.',
      ignoreFile: '.sentrycliignore',
      ignore: ['node_modules', 'webpack.config.js'],
      configFile: 'sentry.properties'
    })
  ]
};

• release [optional] - unique name of a release, must be a string, should uniquely identify your release, defaults to sentry-cli releases propose-version command which should always return the correct version
• include [required] - string or array, one or more paths that Sentry CLI should scan recursively for sources. It will upload all .map files and match associated .js files
• ignoreFile [optional] - string, path to a file containing list of files/directories to ignore. Can point to .gitignore or anything with same format
• ignore [optional] - string or array, one or more paths to ignore during upload. Overrides entries in ignoreFile file. If neither ignoreFile or ignore are present, defaults to ['node_modules']
• configFile [optional] - string, path to Sentry CLI config properties, as described in https://docs.sentry.io/learn/cli/configuration/#properties-files. By default, the config file is looked for upwards from the current path and defaults from ~/.sentryclirc are always loaded
• ext [optional] - string, adds an additional file extension to be considered. By default the following file extensions are processed: js, map, jsbundle and bundle.
• urlPrefix [optional] - string, this sets an URL prefix in front of all files. This defaults to / but you might want to set this to the full URL. This is also useful if your files are stored in a sub folder. eg: --url-prefix '/static/js'
• validate [optional] - boolean, this attempts sourcemap validation before upload when rewriting is not enabled. It will spot a variety of issues with source maps and cancel the upload if any are found. This is not the default as this can cause false positives.
• stripPrefix | stripCommonPrefix [optional] - string, when paired with --rewrite this will chop-off a prefix from uploaded files. For instance you can use this to remove a path that is build machine specific.
• sourceMapReference [optional] - boolean, this prevents the automatic detection of sourcemap references.
• rewrite [optional] - boolean, enables rewriting of matching sourcemaps so that indexed maps are flattened and missing sources are inlined if possible., defaults to true

You can find more information about these options in our official docs: https://docs.sentry.io/learn/cli/releases/#upload-source-maps