ex_unit_notifier

Desktop notifications for ExUnit

Monthly Downloads: 17,750

Programming language: Elixir

License: MIT License

Tags: Testing    

Latest version: v0.1.1

README

ExUnit Notifier

Show desktop notifications for ExUnit runs. Works very well with automatic test runners such as mix-test.watch. (Yes, TDD is awesome!)

Currently notifications on OS X and Linux are supported.

Installation

First, add ExUnitNotifier to your mix.exs dependencies:

def deps do
  [{:ex_unit_notifier, "~> 1.0", only: :test}]
end

Then, update your dependencies:

$ mix deps.get

For OS X

Ensure terminal-notifier is installed and available through the users PATH.

For Linux

Install notify-send:

sudo apt install libnotify-bin

Usage

Add ExUnitNotifier to your ExUnit configuration in test/test_helper.exs file.

ExUnit.configure formatters: [ExUnit.CLIFormatter, ExUnitNotifier]
ExUnit.start

Now run mix test and you'll see notifications popping up :)

Notification Types

Notifications will be sent from the first available notifier that is deemed available in the order specified below:

• terminal-notifier
• notify-send
• Terminal Title if non of the above match

To force a specific type of notifier to be used, specify the notifier using the following configuration:

config :ex_unit_notifier, notifier: ExUnitNotifier.Notifiers.TerminalNotifier

You can use one of the available notifiers found in [lib/ex_unit_notifier/notifiers](lib/ex_unit_notifier/notifiers), or you can write your own.

Notification Options

For notify-send users, it is possible to clear the notifications from notifications center history using the following configuration, defaults to false:

config :ex_unit_notifier, clear_history: true

License

The MIT License

Copyright (c) 2016-present Navin Peiris

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.