{"id":26651,"library":"webpack-sane-compiler-notifier","title":"webpack-sane-compiler-notifier","description":"Library that sends OS-level notifications (e.g., native desktop notifications) about webpack compilation status when used with webpack-sane-compiler. Current stable version: 2.1.1. Released sporadically; last release 2020. Key differentiators: simple, zero-config API; integrates directly with webpack-sane-compiler's events; supports custom title, icon, and sound.","status":"maintenance","version":"2.1.1","language":"javascript","source_language":"en","source_url":"ssh://git@github.com/moxystudio/webpack-sane-compiler-notifier","tags":["javascript","webpack","sane","compiler","notifier","notification","build"],"install":[{"cmd":"npm install webpack-sane-compiler-notifier","lang":"bash","label":"npm"},{"cmd":"yarn add webpack-sane-compiler-notifier","lang":"bash","label":"yarn"},{"cmd":"pnpm add webpack-sane-compiler-notifier","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency; the notifier listens to events from webpack-sane-compiler","package":"webpack-sane-compiler","optional":false}],"imports":[{"note":"CommonJS only; packages does not provide ESM exports.","wrong":"import startNotifying from 'webpack-sane-compiler-notifier';","symbol":"startNotifying","correct":"const startNotifying = require('webpack-sane-compiler-notifier');\nconst { stop, options } = startNotifying(compiler, {});"},{"note":"stop is returned from startNotifying, not a direct export.","wrong":"const { stop } = require('webpack-sane-compiler-notifier');","symbol":"stop","correct":"const startNotifying = require('webpack-sane-compiler-notifier');\nconst { stop } = startNotifying(compiler);"},{"note":"options is the merged configuration returned from startNotifying.","wrong":"const options = require('webpack-sane-compiler-notifier').options;","symbol":"options","correct":"const startNotifying = require('webpack-sane-compiler-notifier');\nconst { options } = startNotifying(compiler, { title: 'Build' });"}],"quickstart":{"code":"const webpack = require('webpack');\nconst WebpackSaneCompiler = require('webpack-sane-compiler');\nconst startNotifying = require('webpack-sane-compiler-notifier');\n\nconst compiler = webpack({ /* webpack config */ });\nconst saneCompiler = new WebpackSaneCompiler(compiler);\n\nconst { stop } = startNotifying(saneCompiler, {\n  title: 'My App',\n  sound: true\n});\n\nsaneCompiler.watch({}, (err, stats) => {\n  if (err) console.error(err);\n  else console.log('Build done');\n});\n\n// Later: stop();","lang":"javascript","description":"Shows how to set up OS notifications for webpack builds using webpack-sane-compiler."},"warnings":[{"fix":"Consider migrating to @webpack-cli/serve or webpack-dev-server for notifications.","message":"Package is in maintenance mode; no active development since 2020.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Wrap your webpack compiler with new WebpackSaneCompiler(compiler) before passing it.","message":"startNotifying expects a webpack-sane-compiler instance, not a raw webpack compiler.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Update calls to capture destructured { stop, options } from startNotifying.","message":"v2.0.0 changed the return value from undefined to { stop, options }.","severity":"breaking","affected_versions":">=2.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Wrap compiler: const saneCompiler = new WebpackSaneCompiler(compiler); then pass saneCompiler to startNotifying.","cause":"Passed a raw webpack compiler instead of a webpack-sane-compiler instance.","error":"TypeError: compiler.hooks is not a function"},{"fix":"Run: npm install webpack-sane-compiler","cause":"Missing peer dependency webpack-sane-compiler.","error":"Cannot find module 'webpack-sane-compiler'"},{"fix":"Upgrade to v2 and use: const { stop } = startNotifying(compiler);","cause":"Using return value from v1 of the package which returned undefined.","error":"TypeError: Cannot destructure property 'stop' of undefined"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}