peridot-php / peridot-jumpstart
Starter kit to start BDD testing in PHP with Peridot
Installs: 6 869
Dependents: 6
Suggesters: 0
Security: 0
Stars: 3
Watchers: 5
Forks: 0
Open Issues: 0
Type:metapackage
Requires
Requires (Dev)
Suggests
- eloquent/peridot-phony: Phony mocking integration
- peridot-php/peridot-prophecy-plugin: Prophecy mocking integration
This package is not auto-updated.
Last update: 2024-11-01 22:17:58 UTC
README
Peridot core and some commonly used packages to let you start doing BDD in PHP ASAP.
Included plugins and libraries
- List reporter - list test results
- Dot reporter - show results as dot matrix
- Code coverage reporters - code coverage
- Watcher plugin - watch source and tests for changes and re-run
- Concurrency plugin - run specs concurrently!
- Leo - expressive assertion and matcher library
Installing
We recommend installing the jumpstart via composer:
$ composer require --dev peridot-php/peridot-jumpstart
Getting started
After installing the jumpstart, a good starting point would be to copy this
package's peridot.php file into the root of your project. This file will
set the default path for specs, and ensure that all the included plugins are
registered.
If you installed the jumpstart via composer, you can follow up by doing this:
$ cp vendor/peridot-php/peridot-jumpstart/peridot.php .
To set a different default path, disable a plugin, or set up further
configuration, simply edit your copy of peridot.php.
After registering everything, vendor/bin/peridot -h should yield the
following:
