Install the plugin with npm:
$ npm install atatus-sourcemap-webpack-plugin --save-dev
An example webpack.config.js:
const AtatusSourceMapPlugin =const JS_PUBLIC_URL = ''const webpackConfig =entry: 'index'url: JS_PUBLIC_URLoutput:path: 'dist'filename: 'index-[hash].js'plugins:adminAPIKey: 'aaaabbbbccccddddeeeeffff00001111'version: 'version_string_here'url: JS_PUBLIC_URL
You can pass a hash of configuration options to
Allowed values are as follows:
adminAPIKey: string (required)
Your atatus project admin API Key
version: string (required)
A string identifying the version of your code this source map package is for. Typically this will be the full git sha.
url: string (required)
The base url for the cdn where your production bundles are hosted.
includeChunks: string | [string] (optional)
An array of chunks for which sourcemaps should be uploaded. This should correspond to the names in the webpack config
entry field. If there's only one chunk, it can be a string rather than an array. If not supplied, all sourcemaps emitted by webpack will be uploaded, including those for unnamed chunks.
silent: boolean (default:
false, success and warning messages will be logged to the console for each upload. Note: if you also do not want to see errors, set the
ignoreErrors option to
ignoreErrors: boolean (default:
true to bypass adding upload errors to the webpack compilation. Do this if you do not want to fail the build when sourcemap uploads fail. If you do not want to fail the build but you do want to see the failures as warnings, make sure
silent option is set to
atatusEndpoint: string (default:
A string defining the Atatus API endpoint to upload the sourcemaps to. It can be used for self-hosted Atatus instances.
- The web app should have atatus-browser installed.
- See the Atatus source map documentation
for how to configure the client side for sourcemap support.
code_versionparameter must match the
versionparameter used for the plugin.
- More general info on the using Atatus for browser JS.
A minimal single page app with webpack build. The app includes a local Express server that serves an index.html. The build is meant to mimic a production build in that js bundles.
To run the example:
- Set your atatus options in
$ cd examples/react
$ npm run build
$ npm start
- open http://localhost:8000
When the example app is loaded in a browser, the app will throw an error, which will be sent to Atatus. You should be able to log in to Atatus and see the error with stacktrace with line numbers that map to the original source.
See the Contributors Guide