navinpeiris/ex_unit_notifier
{ "createdAt": "2016-03-24T09:58:30Z", "defaultBranch": "master", "description": "Desktop notifications for ExUnit", "fullName": "navinpeiris/ex_unit_notifier", "homepage": "", "language": "Elixir", "name": "ex_unit_notifier", "pushedAt": "2024-08-13T16:24:27Z", "stargazersCount": 134, "topics": [ "desktop-notifications", "elixir", "exunit", "notifications" ], "updatedAt": "2025-11-23T09:36:32Z", "url": "https://github.com/navinpeiris/ex_unit_notifier"}ExUnit Notifier
Section titled “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
Section titled “Installation”First, add ExUnitNotifier to your mix.exs dependencies:
def deps do [ {:ex_unit_notifier, "~> 1.3", only: :test} ]endThen, update your dependencies:
$ mix deps.getFor macOS
Section titled “For macOS”Follow installation instruction of terminal-notifier if you need to install a particular version.
Otherwise, install current version via Homebrew:
$ brew install terminal-notifierFor GNU/Linux
Section titled “For GNU/Linux”Install notify-send:
$ sudo apt install libnotify-binAdd ExUnitNotifier to your ExUnit configuration in test/test_helper.exs file.
ExUnit.configure formatters: [ExUnit.CLIFormatter, ExUnitNotifier]ExUnit.startNow run mix test and you’ll see notifications popping up :)
Notification Types
Section titled “Notification Types”Notifications will be sent from the first available notifier that is deemed available in the order specified below:
- terminal-notifier (ExUnitNotifier.Notifiers.TerminalNotifier)
- notify-send (ExUnitNotifier.Notifiers.NotifySend)
- tmux (ExUnitNotifier.Notifiers.TmuxNotifier)
- Terminal Title if non of the above match (ExUnitNotifier.Notifiers.TerminalTitle)
To force a specific type of notifier to be used, specify the notifier using the following configuration:
config :ex_unit_notifier, notifier: ExUnitNotifier.Notifiers.TerminalNotifierYou 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
Section titled “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: trueCopyright and License
Section titled “Copyright and License”Copyright (c) 2016 Navin Peiris
Source code is released under [the MIT license]!(./LICENSE.md).