gulp-php-dev-toolbox

There are a lot of tools available all with different settings and command line arguments. It makes live a lot easier if all these tasks can be done automatically when code changes in a file or before a commit is done. This toolbox contains automated tasks that install dependencies, checks code styling, structure and running unit tests with or without code coverage.

The toolbox uses gulp as the task runner. Gulp is using nodejs as a engine. This way gulp has the ability to run tasks async which will increase the speed off your tasks. If you really need to run the task in sync it's still possible. See the gulp api documentation for more information. Tasks in gulp are created by code and not by configuration. This makes it a lot easier to read and all the tools that are available for nodejs are at your disposal for creating tasks.

Requirements

To make use of this toolbox nodejs and gulp are required. Gulp will be installed by the toolbox itself. Nodejs can be downloaded or installed using a package manager.

Setup

There are multiple ways to setup and use the toolbox. The php tools can be added as a dev dependency in your composer.json of your project or your can use the toolbox in a separate repository.

Install as composer dev dependency

The most easy one is using composer. Add this repository as a dependency to the composer.json file. Composer will not automatically call scripts from dependencies. To setup the toolbox in your project you have to call the setup-php-toolbox script in the toolbox from the project root.

composer require --dev rregeer/gulp-php-dev-toolbox
composer install
vendor/bin/setup-php-toolbox

Install it manually by using git

Just clone the git repository and start the setup script. The setup script will copy the toolbox to the given destination directory. If you want it to be a part of your project use your project root. The second argument of the setup script is the source directory of the toolbox.

git clone git://github.com/richardregeer/gulp-php-dev-toolbox.git
cd gulp-php-dev-toolbox
bin/setup-php-toolbox <path/to/destination> ./
cd <path/to/destination>

Available tasks

To see all the available tasks

gulp help

The task are using gulp plugins to call various php tools like phpunit, php code sniffer, php mess detector, php copy / paste detector, composer, phplint, php code beautifier The available tasks will be listed with a description and available arguments or aliases.

If no task name is given the default task will be executed. This will run all the tasks that are defined in the default task. Currently this is composer, tests and check code styling.

Configuration

For the most php tools there's a configuration file available to setup the tool (like phpunit.dist.xml). If the tool has a configuration file available it will be mandatory to use and should be available in your project root. The task will fail if the configuration file is not found.

Tasks that don't have a configuration file available have a default configuration and can be overridden by using command line arguments or the dev-toolbox.config.json. The tasks always use the tools that are installed locally by your composers dependencies. If composer has not installed the required tool, it will always be installed before the task will run. The tools can be found in vendor/bin in your project root.

dev-toolbox.config.json

The toolbox has a configuration file that can be used to configure the toolbox and the tasks.

tasks

Instead of setting the source of the task as a command line argument using --source=<path/**/.php>* for example. You can set it directly in the configuration. This why you can start multiple task with different sources and also don't have to pass the source argument every time you want to execute the task.

Example:

{
  "tasks": {
    "style:syntax": {
      "source": ["Library/**/*.php", "UnitTests/**/*.php"]
    },
    "structure:duplication": {
      "source": ["Library/**/*.php"]
    },
    "structure:complexity": {
      "source": ["Library/"]
    }
  }
}

To add multiple items use an array in the json.