codex-team / hawk.webpack.plugin

Webpack plugin for sending source maps to the Hawk

Hawk Webpack Plugin

Webpack plugin for sending source maps to the Hawk.

Install

yarn add @hawk.so/webpack-plugin --save-dev

Connect

Next you need to connect plugin to the Webpack config.

Pass your Integration Token as plugin option. It is useful to store it in .env file.

const HawkWebpackPlugin = require('@hawk.so/webpack-plugin');

module.exports = {
  // ... other webpack options
  plugins: [
    new HawkWebpackPlugin({
      integrationToken: '' // Your project's Integration Token
    })
  ],
  devtool: 'hidden-source-map',
}

Plugin options:

option	required	description
integrationToken	yes	Your project's Integration Token
release	no	Unique identifier of the release. By default, it will be Webpack compilation hash. You should pass this identifier to the Javascript Catcher on initialization through the release option
releaseInfoFile	no	The path where release.json file will be created. By default, it will be got from Webpack output.path option. You can pass false to prevent creation of this file (can be useful, if you store and pass release id manually)
removeSourceMaps	no	Should the plugin to remove emitted source map files. Default is true.
commits	no	Object with git options for suspected commits. Enabled by default. Can be set to false to not include commits in the release.

Commits options	type	description
repo	string	Path to repository with .git directory. Default is __dirname.

After plugin finish its work, it will save release information to the release.json file. You can use this file to get release identifier and pass it to the JavaScript Catcher on initialization.

See example of connection.

Usage in React project

If you want to send source maps of your React project, you need to use react-app-rewired or do yarn eject. Then you can override Webpack config of your project and use this plugin.

hawk.webpack.plugin's Issues

Can't use plugin with Webpack 5

With Webpack 5 plugin can't get information about file path while Webpack builds an application.

https://webpack.js.org/blog/2020-10-10-webpack-5-release/#file-emitting
https://webpack.js.org/configuration/output/#outputfutureemitassets

If all options of the `commits` param is default, allow passing `commits=true`

Before

commits: {}

After

commits: true

Send commits info to collector

In the release information, you must also send a field with information about commits made since the last release for the suspected commits feature to work

[Error] Arrays are not supported

� Hawk | (⌐■_■) Sending static/js/runtime-main.b42d73a9.js.map failed: 

Arrays are not supported.

Error object:

Error: Arrays are not supported.
    at FormData.append (D:\WebStormProjects\test-react-integration\node_modules\form-data\lib\form_data.js:66:17)
    at D:\WebStormProjects\test-react-integration\node_modules\@hawk.so\webpack-plugin\src\index.js:162:14
    at async Promise.all (index 3)

Make commits enabled by default

Update docs and examples with new settings

• Add list of supported settings to README, example, .env.sample, etc
• Change hardcoded https://k1.hawk.so/sourcemap to new version
• Check if plugin works on stage

Wrong token breaks the plugin