adrieankhisbe / overseer.el

Ert-runner Integration Into Emacs

overseer.el

Ert-runner Integration Into Emacs

The ert-runner is a great way to run your ert tests. Overseer integrates this tool into emacs and let's you using it inside your lovely editor.

---

• Installation
  • ELPA
  • Via el-get
  • Manual
• Usage
  • Interactive commands
• Contributing
• License

Installation

Installation via package.el

package.el is the built-in package manager in Emacs.

Overseer is available on the three major community maintained repositories - MELPA STABLE, MELPA and Marmalade.

You can install Overseer with the following commnad:

M-x package-install [RET] overseer [RET]

or by adding this bit of Emacs Lisp code to your Emacs initialization file (.emacs or init.el):

(unless (package-installed-p 'overseer)
  (package-install 'overseer))

If the installation doesn't work try refreshing the package list:

M-x package-refresh-contents [RET]

Keep in mind that MELPA packages are built automatically from the master branch, meaning bugs might creep in there from time to time. Never-the-less, installing from MELPA is the recommended way of obtaining Overseer, as the master branch is normally quite stable and "stable" (tagged) builds are released somewhat infrequently.

With the most recent builds of Emacs, you can pin Overseer to always use MELPA Stable by adding this to your Emacs initialization:

(add-to-list 'package-pinned-packages '(overseer . "melpa-stable") t)

Via el-get

el-get is another popular package manager for Emacs. If you're an el-get user just do M-x el-get-install [RET] overseer [RET].

Manual

You can install Overseer manually by placing it on your load-path and require ing it. Many people favour the folder ~/.emacs.d/vendor.

(add-to-list 'load-path "~/.emacs.d/vendor/")
(require 'overseer)

Usage

The ert-runner will always run in the context of the current emacs lisp project.

The overseer-mode is enabled via emacs-lisp-mode-hook by default for emacs lisp test files. (*-test.el)

Interactive Commands

The overseer-mode minor mode will be automaticly enable the following keybindings:

Keybinding	Description
C-c , t	Runs cask exec ert-runner. overseer-test
C-c , b	Runs cask exec ert-runner with the current buffer file as argument. overseer-test-this-buffer
C-c , f	Open a prompt to run cask exec ert-runner with a custom file as arguments. overseer-test-file
C-c , g	Runs cask exec ert-runner -t with given tags (example: indentation,syntax). overseer-test-this-buffer
C-c , p	Open a prompt to run cask exec ert-runner with custom arguments. overseer-test-prompt
C-c , h	Runs cask exec ert-runner --help. overseer-help
C-c , d	Runs cask exec ert-runner --debug. overseer-help
C-c , v	Runs cask exec ert-runner --verbose. overseer-help
C-c , q	Runs cask exec ert-runner --quiet. overseer-help

Contributing

Contributions are very welcome!

1. Fork overseer.el
2. Create a topic branch - git checkout -b my_branch
3. Push to your branch - git push origin my_branch
4. Send me a pull-request for your topic branch
5. That's it!

License

Copyright © 2014-2015 Samuel Tonini and contributors.

Distributed under the GNU General Public License, version 3