{"id":15536568,"url":"https://github.com/turbo87/webpack-notifier","last_synced_at":"2025-05-15T09:08:00.683Z","repository":{"id":27227200,"uuid":"30698468","full_name":"Turbo87/webpack-notifier","owner":"Turbo87","description":"webpack + node-notifier = build status system notifications","archived":false,"fork":false,"pushed_at":"2022-03-21T21:05:33.000Z","size":638,"stargazers_count":307,"open_issues_count":4,"forks_count":41,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-05-15T09:07:56.166Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Turbo87.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-12T10:57:30.000Z","updated_at":"2025-03-05T20:05:10.000Z","dependencies_parsed_at":"2022-09-03T18:41:32.941Z","dependency_job_id":null,"html_url":"https://github.com/Turbo87/webpack-notifier","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Turbo87%2Fwebpack-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Turbo87%2Fwebpack-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Turbo87%2Fwebpack-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Turbo87%2Fwebpack-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Turbo87","download_url":"https://codeload.github.com/Turbo87/webpack-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254310520,"owners_count":22049470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T11:52:29.648Z","updated_at":"2025-05-15T09:08:00.628Z","avatar_url":"https://github.com/Turbo87.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# webpack-notifier\n\n[![npm Version](https://img.shields.io/npm/v/webpack-notifier.svg)](https://www.npmjs.com/package/webpack-notifier)\n[![GitHub Workflow Status](https://github.com/Turbo87/webpack-notifier/workflows/CI/badge.svg)](https://github.com/Turbo87/webpack-notifier/actions?query=workflow:CI)\n[![Coverage Status](https://coveralls.io/repos/github/Turbo87/webpack-notifier/badge.svg)](https://coveralls.io/github/Turbo87/webpack-notifier?branch=master)\n[![Code Style](https://badgen.net/badge/code%20style/Airbnb/007ec6?icon=airbnb)](https://github.com/airbnb/javascript)  \n[![npm](https://img.shields.io/npm/dm/webpack-notifier)](https://www.npmjs.com/package/webpack-notifier)\n![npm bundle size](https://img.shields.io/bundlephobia/minzip/webpack-notifier)\n\nThis is a [webpack](http://webpack.github.io/) plugin that uses the\n[node-notifier](https://github.com/mikaelbr/node-notifier) package to\ndisplay build status system notifications to the user.\n\n![webpack-notifier screenshot](screenshot.png)\n\n\u003e This is a fork of the\n[webpack-error-notification](https://github.com/vsolovyov/webpack-error-notification)\nplugin. It adds support for Windows and there is no need to manually install\nthe `terminal-notifier` package on OS X anymore.\n\nThe plugin will notify you about the first run (success/fail),\nall failed runs and the first successful run after recovering from\na build failure. In other words: it will stay silent if everything\nis fine with your build.\n\n\n## Installation\n\nUse `npm` to install this package:\n\n    npm install --save-dev webpack-notifier\n\nCheck the `node-notifier`\n[Requirements](https://github.com/mikaelbr/node-notifier#requirements)\nwhether you need to install any additional tools for your OS.\n\n\n## Usage\n\nIn the `webpack.config.js` file:\n\n```js\nvar WebpackNotifierPlugin = require('webpack-notifier');\n\nvar config = module.exports = {\n  // ...\n\n  plugins: [\n    new WebpackNotifierPlugin(),\n  ]\n}\n```\n\n\n## Configuration\n\n### All `node-notifier` options\n\nYou can use any [node-notifier](https://www.npmjs.com/package/node-notifier) options (depending on your OS)\nExcept for options generated by the plugin itself:\n* `title` - it can be not only a string, but also a function\n* `message` - generated based on the value of other options\n* `contentImage` - it can be an object with images for different statuses\n* `icon` - matches with `contentImage`\n\n### Title\n\nTitle shown in the notification.\n\n```js\nnew WebpackNotifierPlugin({title: 'Webpack'});\n```\n\n```js\nnew WebpackNotifierPlugin({title: function (params) {\n  return `Build status is ${params.status} with message ${params.message}`;\n}});\n```\n\n### Emojis in message text\n\nShow status emoji icon before the message.\n\n```js\nnew WebpackNotifierPlugin({emoji: true});\n```\n\n### Content Image\n\nImage shown in the notification. Can be a path string or object with paths.\n\n#### String path:\n```js\nvar path = require('path');\n\nnew WebpackNotifierPlugin({contentImage: path.join(__dirname, 'logo.png')});\n```\n\n#### Object string path:\n```js\nvar path = require('path');\n\nconst statusesPaths = {\n  success: path.join(__dirname, 'success.png'),\n  warning: path.join(__dirname, 'warning.png'),\n  error: path.join(__dirname, 'error.png')\n}\n\nnew WebpackNotifierPlugin({contentImage: statusesPaths});\n```\n\n### Exclude Warnings\n\nIf set to `true`, warnings will not cause a notification.\n\n```js\nnew WebpackNotifierPlugin({excludeWarnings: true});\n```\n\n### Always Notify\n\nTrigger a notification every time. Call it \"noisy-mode\".\n\n```js\nnew WebpackNotifierPlugin({alwaysNotify: true});\n```\n\n### Notify on error\n\nTrigger a notification only on error.\n\n```js\nnew WebpackNotifierPlugin({onlyOnError: true});\n```\n\n### Skip Notification on the First Build\n\nDo not notify on the first build.  This allows you to receive notifications on subsequent incremental builds without being notified on the initial build.\n\n```js\nnew WebpackNotifierPlugin({skipFirstNotification: true});\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fturbo87%2Fwebpack-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fturbo87%2Fwebpack-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fturbo87%2Fwebpack-notifier/lists"}