https://github.com/pdud/ember-cli-build-notifications

Notifications when ember-cli has a buildError
https://github.com/pdud/ember-cli-build-notifications

Last synced: about 2 months ago
JSON representation

Notifications when ember-cli has a buildError

• Host: GitHub
• URL: https://github.com/pdud/ember-cli-build-notifications
• Owner: pdud
• License: mit
• Created: 2015-02-10T15:37:19.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2023-05-26T17:07:06.000Z (over 1 year ago)
• Last Synced: 2024-11-11T18:57:49.906Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.91 MB
• Stars: 24
• Watchers: 1
• Forks: 8
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ember - ember-cli-build-notifications - Notifications when ember-cli has a build error. (Packages / End-user customization)

README

        
# ember-cli-build-notifications

[![npm version](https://badge.fury.io/js/ember-cli-build-notifications.svg)](https://badge.fury.io/js/ember-cli-build-notifications)

[![Build Status](https://travis-ci.org/pdud/ember-cli-build-notifications.svg?branch=master)](https://travis-ci.org/pdud/ember-cli-build-notifications)

[![Ember Observer Score](https://emberobserver.com/badges/ember-cli-build-notifications.svg)](https://emberobserver.com/addons/ember-cli-build-notifications)

This addon adds support for Linux, Mac OS X and Windows alerts when ember-cli has a buildError and postBuild (when the build is successful).

![image](example.png)

![image](build_success_example.png)

## Compatibility

* Ember.js v3.28 or above

* Ember CLI v3.28 or above

* Node.js v14 or above

## Installation

```

ember install ember-cli-build-notifications

```

## Usage

| Config Options | Ember CLI Build Event | Default |

| -------------- |:----------------------|:-------:|

| buildError     | buildError            | true    |

| buildSuccess   | postBuild             | false   |

To override defaults, add the following to the config file `{app-name}/config/build-notifications.js`:

```javascript

module.exports = {

  buildError: {

    notify: true,

    notificationOptions: {

      sound: true

    }

  },

  buildSuccess: {

    notify: true,

    notificationOptions: {

      sound: true

    }

  }

};

```

The `notificationOptions` settings are passed directly into node-notifier, see their [docs](https://github.com/mikaelbr/node-notifier#all-notification-options-with-their-defaults) for a full list of available settings

### Requirements

- **Mac OS X**: >= 10.8 or Growl if earlier.

- **Linux**: notify-osd installed (Ubuntu should have this by default)

- **Windows**: >= 8, task bar balloon if earlier or Growl if that is installed.

- **General Fallback**: Growl

Powered by [mikaelbr/node-notifier](https://github.com/mikaelbr/node-notifier) and it's [dependencies](https://github.com/mikaelbr/node-notifier#thanks-to-oss).

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.

## Acknowledgment

* Made possible by: [https://github.com/ember-cli/ember-cli/pull/2832](https://github.com/ember-cli/ember-cli/pull/2832)

* Inspired by: [https://github.com/dylang/grunt-notify](https://github.com/dylang/grunt-notify)

* Mocha setup from: [https://github.com/rwjblue/ember-cli-divshot](https://github.com/rwjblue/ember-cli-divshot)

## License

This project is licensed under the [MIT License](LICENSE.md).