https://github.com/codex-team/hawk.webpack.plugin
Webpack plugin for sending source maps to the Hawk
https://github.com/codex-team/hawk.webpack.plugin
Last synced: about 2 months ago
JSON representation
Webpack plugin for sending source maps to the Hawk
- Host: GitHub
- URL: https://github.com/codex-team/hawk.webpack.plugin
- Owner: codex-team
- License: mit
- Created: 2019-12-21T12:43:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-22T15:02:10.000Z (3 months ago)
- Last Synced: 2025-03-31T03:03:00.960Z (2 months ago)
- Language: JavaScript
- Size: 487 KB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
> [!IMPORTANT]
> Note, that devtool should be set to "source-map" for full source map content
> That can cause your source code to be leaked if you set HawkWebpackPlugin.removeSourceMaps to false
> But by default all of the source map files would be deleted after sending by the plugin
```js
const HawkWebpackPlugin = require('@hawk.so/webpack-plugin');
module.exports = {
// ... other webpack options
plugins: [
new HawkWebpackPlugin({
integrationToken: '' // Your project's Integration Token
})
],
devtool: '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](https://github.com/codex-team/hawk.javascript) 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](/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](https://github.com/timarney/react-app-rewired) or do `yarn eject`. Then you can override Webpack config of your project and use this plugin.