ember-cli-build-notifications

2.0.0 verified Sat Apr 25 auth: no javascript

An Ember CLI addon that displays native OS desktop notifications when an Ember CLI build errors or succeeds. Version 2.0.0 supports Ember.js 3.28+ and Node.js 14+. It wraps node-notifier to provide cross-platform notifications (macOS, Linux, Windows) with configurable notification options such as sound. The addon is configurable via a build-notifications.js file in the app's config directory. It has a low release cadence, last updated in 2023. Unlike other notification addons, this one specifically targets native desktop notifications for build events in Ember CLI projects.

Common errors

error notifications do not appear on Linux ↓

cause Missing notification daemon or notify-send not installed

fix

Install libnotify-bin (Ubuntu: sudo apt-get install libnotify-bin)

error Error: Cannot find module 'node-notifier' ↓

cause Missing dependency node-notifier

fix

Run npm install node-notifier in your project root.

error No notifications on macOS after upgrade to macOS 10.15+ ↓

cause macOS permission changes; notch notifications may require permissions

fix

Enable notifications in System Preferences > Notifications for Terminal/Ember CLI.

error BuildError notifications not showing ↓

cause Config file not created or notify set to false

fix

Create config/build-notifications.js with buildError.notify: true

Warnings

deprecated Addon may be deprecated in favor of built-in Ember CLI notification support or other tools. ↓

fix Consider using Ember CLI's built-in --watcher flag or alternative notification addons.

gotcha Config file must be CommonJS, not ES module. ↓

fix Use module.exports = { ... } instead of export default.

gotcha node-notifier may require additional system dependencies on Linux (notify-osd). ↓

fix Install notify-send or ensure the system has notification daemon.

gotcha Sound option may not work on all platforms. ↓

fix Test with notificationOptions.sound; fallback to no sound if not supported.

Install

npm install ember-cli-build-notifications

yarn add ember-cli-build-notifications

pnpm add ember-cli-build-notifications

Imports

default

wrong

npm install ember-cli-build-notifications (must use ember install to trigger blueprint)

correct

Add addon via: ember install ember-cli-build-notifications

This is an Ember addon; no direct JavaScript import needed. Configuration is done via config/build-notifications.js.

config

wrong

export default { ... } (CommonJS required for config file)

correct

module.exports = { buildError: { notify: true }, buildSuccess: { notify: false } };

Config file uses CommonJS module.exports, not ES modules.

buildError

wrong

buildError: { sound: true } (missing notify boolean)

correct

buildError: { notify: true, notificationOptions: { sound: true } }

The 'notify' key is required to enable notifications; default is true for buildError.

buildSuccess
```
buildSuccess: { notify: true }
```
Default is false; must set notify: true to enable success notifications.

Quickstart

Installs the addon and creates a config file to enable desktop notifications for build errors and success with sound.

ember install ember-cli-build-notifications

// config/build-notifications.js
module.exports = {
  buildError: {
    notify: true,
    notificationOptions: {
      sound: true
    }
  },
  buildSuccess: {
    notify: true
  }
};