thomasweinert/phpunit-extension-skeleton

Skeleton for PHPUnit extensions

1.0.0 2018-09-09 10:46 UTC

This package is auto-updated.

Last update: 2024-10-10 00:38:19 UTC


README

A skeleton for an extension for PHPUnit. It provides the necessary files and build scripts. Here is a "Hello World" example based on this skeleton that implements a simple constraint and assertion for PHPUnit. .

Requirements

Usage

Use Composer to create a new extension project from this skeleton.

$ composer create-project thomasweinert/phpunit-extension-skeleton your-awesome-extension

Go into the new project directory.

$ cd your-awesome-extension

Install tools used to build and package your extension using Phive.

$ phive install

Start adding new

Build Targets

The repository includes a Phing build file. Phive installs Phing and the other tools into the tools/ subdirectory.

build

$ tools/phing build

Create a Phar package for the extension. The phar will be put into the build/ directory. The name and information for a Phive manifest.xml will be read from the composer.json. The latest tag from current Git branch will be used as version number.

clean

$ tools/phing clean

Delete build artifacts.

package

$ tools/phing package

Create a Phar package for the extension and sign it using GPG. the first time you will be asked GPG user. The user will be stored in the build.properties file.

reformat

$ tools/phing reformat

Uses the PHP Coding Standards Fixer to reformat the source code according the PHPUnit coding standard.

test

$ tools/phing test

Run unit tests.