Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nlamirault/phpunit.el
Emacs mode to phpunit and test command line tool
https://github.com/nlamirault/phpunit.el
emacs phpunit
Last synced: about 1 month ago
JSON representation
Emacs mode to phpunit and test command line tool
- Host: GitHub
- URL: https://github.com/nlamirault/phpunit.el
- Owner: nlamirault
- License: gpl-2.0
- Created: 2014-04-01T12:13:47.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-02-17T22:37:29.000Z (7 months ago)
- Last Synced: 2024-05-01T21:21:38.176Z (5 months ago)
- Topics: emacs, phpunit
- Language: Emacs Lisp
- Homepage:
- Size: 202 KB
- Stars: 34
- Watchers: 6
- Forks: 19
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# phpunit.el
[![License GPL 3][badge-license]][LICENSE]
* Master  [](https://coveralls.io/r/nlamirault/phpunit.el)
Manage the [PHPUnit][] tests from Emacs (>= 24.3)
## Installation
The recommended way to install ``phpunit.el`` is via [MELPA][]:
M-x package-install phpunit.el
or [Cask][]:
(depends-on "phpunit.el")
## Usage
### Available commands
These functions are available :
* `phpunit-current-test`: launch unit tests for the current test in a class
* `phpunit-current-class`: launch unit tests for the current class
* `phpunit-current-project`: launch all unit tests
* `phpunit-group`: launch PHPUnit for group
You can create some key bindings with these commands:
```lisp
(define-key web-mode-map (kbd "C-t t") 'phpunit-current-test)
(define-key web-mode-map (kbd "C-t c") 'phpunit-current-class)
(define-key web-mode-map (kbd "C-t p") 'phpunit-current-project)
```
or use the minor mode :
```lisp
(add-to-list 'auto-mode-alist '("\\.php$'" . phpunit-mode))
```
### Configuration
The following configuration variables are available:
```lisp
(setq phpunit-configuration-file "phpunit.xml")
(setq phpunit-root-directory "./")
```
## Development
### Cask
``phpunit.el`` use [Cask](https://github.com/cask/cask) for dependencies
management. Install it and retrieve dependencies :
$ curl -fsSL https://raw.githubusercontent.com/cask/cask/master/go | python
$ export PATH="$HOME/.cask/bin:$PATH"
$ cask
### Testing
* Launch unit tests from shell
$ make clean test
* Using [overseer][] :
Keybinding | Description
---------------------|------------------------------------------------------------
C-c , t | launch unit tests from buffer
C-c , b | launch unit tests
C-c , g | launch unit tests with tag (find, regexp, ...)
* Tips:
If you want to launch a single unit test, add a specify tag :
```lisp
(ert-deftest test-foobar ()
:tags '(current)
```
And launch it using : C-c , g and specify tag : *current*
## Support / Contribute
See [here](CONTRIBUTING.md)
## Changelog
A changelog is available [here](ChangeLog.md).
## License
See [LICENSE](LICENSE).
## Contact
Nicolas Lamirault
[badge-license]: https://img.shields.io/badge/license-GPL_2-green.svg?style=flat
[LICENSE]: https://github.com/nlamirault/phpunit.el/blob/master/LICENSE
[Issue tracker]: https://github.com/nlamirault/phpunit.el/issues
[PHPUnit]: http://phpunit.de
[GNU Emacs]: https://www.gnu.org/software/emacs/
[MELPA]: https://melpa.org/
[Cask]: http://cask.github.io/
[Overseer]: https://github.com/tonini/overseer.el