Download the PHP package lovullo/phpqaconfig without Composer

phpqaconfig

Configuration for QA and development tools specific to the coding standards at LoVullo Associates. This package, combined with lovullo/phpqatools is meant to be a base for new PHP projects.

Installation

Simply require it in your project's composer.json

Or

Usage

Project Setup

Create a build.xml file in your project root with the following contents:

Create a phpunit.xml file in your project root with the following contents:

See the "Customizing" section below if you have an existing PHPUnit configuration elsewhere.

Development

When developing, use the following ant targets:

• composer
• phpunit
• phpcs
• phpmd
• phpcpd
• phploc

For example:

Continuous Integration

When configuring Continuous Integration (ie. Jenkins), composer must download and install this repo before you can run ant tasks. Add an "Execute Shell" build step to Jenkins with the following command:

Next, add an "Invoke Ant" build step with the following target:

This will run check_mergeconflicts, phplint, phpunit, phpcs-ci, pdepend, phpmd-ci, phpcpd-ci, phploc-ci, and phpdox.

For jobs that need to run quickly and only need a minimal number of QA checks, run the following targets instead:

This will run check_mergeconflicts, phplint, and phpunit.

Add additional build targets to your build.xml file as appropriate for your particular project.

Customizing

QA Tools Location

The included build.xml assumes that all the QA tools are installed into ./vendor/bin. If they are installed elsewhere, provide a toolsdir property to their location:

PHP Lint Configuration

By default, the included build.xml runs php -l on all PHP files in the project except for the vendor/ directory in the root of your project. You can override this setting using the phplintignore property:

PHPUnit Configuration

By default, the included build.xml assumes that there is a phpunit.xml file in the same directory as itself. If you already have a phpunit.xml file located somewhere else, you can override the configuration as follows:

PHP_CodeSniffer Configuration

You can customize the files that are ignored in phpcs checks by specifying a phpcsignore property:

By default, only the vendor directory is excluded from checks.

You can change what PHP_CodeSniffer standard uses by overriding the phpcsstandard property:

PHPMD Configuration

You can customize the files that are ignored in phpmd checks by specifying a phpmdignore property:

By default, only the vendor directory is excluded from checks.

PHPCPD Configuration

You can customize the files that are ignored in phpcpd checks by specifying a phpcpdignore property:

By default, only the vendor directory is excluded from checks.

phpDox Configuration

Disabling QA Checks

If you do not want certain QA tools to run for a project, add one or more of the following disable properties prior to including the base build.xml file: