2017 © Pedro Peláez
 

library php-hound

Runs a set of quality assurance tools for PHP.

image

alanwillms/php-hound

Runs a set of quality assurance tools for PHP.

  • Tuesday, October 25, 2016
  • by alanwillms
  • Repository
  • 5 Watchers
  • 9 Stars
  • 269 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 4 Forks
  • 5 Open issues
  • 10 Versions
  • 0 % Grown

The README.md

PHP Hound

Build Status Code Climate Scrutinizer Code Quality Test Coverage Packagist Version Total Downloads, (*1)

This is a work in progress!, (*2)

PHP Hound runs a set of quality assurance tools for PHP and reduce results to a single beautiful report., (*3)

It currently supports:, (*4)

HTML index page example, (*5)

Installation

PHP Hound can be installed through Composer., (*6)

Local installation

To install it locally, run the following command:, (*7)

composer require alanwillms/php-hound

Then you can execute PHP Hound by running ./vendor/bin/php-hound., (*8)

Global installation

You can install PHP Hound globally with:, (*9)

composer global require alanwillms/php-hound

Then you can add ~/.composer/bin directory to your PATH, so you can simply type php-hound to run it from anywhere. If you want to do this, add the following to your ~/.profile (or ~/.bashrc) file:, (*10)

export PATH="$HOME/.composer/vendor/bin:$PATH"

If you want to apply the changes to your current terminal session, run source ~/.profile (or source ~/bashrc)., (*11)

Command line usage

Basic usage:, (*12)

# Analyze current directory files
php-hound

# Analyze "informed/directory/" files
php-hound informed/directory/

# Analyze "script.php" file
php-hound script.php

You can run php-hound --help to display a list of all available options., (*13)

php-hound [optional arguments] [path to be analysed]

Optional Arguments:
    -f format, --format format (default: text)
        Output format
    -h, --help
        Prints a usage statement
    -i ignore, --ignore ignore (default: vendor,tests,features,spec)
        Ignore a comma-separated list of directories
    -v, --version
        Prints installed version

Gradually fix legacy code

If you have a huge base of legacy code, it's really hard to fix all code issues at the same time, in a single commit., (*14)

PHP Hound helps you to gradually fix your code by only warning about issues found in the files and lines touched by a branch or commit. All other files or lines will be ignored., (*15)

That's pretty easy to achieve:, (*16)

# Usage:
# php-hound --git-diff <commits or branches to compare> <target directory>

# Only return issues found on lines and files changed on the "windows10" branch:
php-hound --git-diff master..windows10 /path/to/git/repo

# Only return issues found on lines and files changed between two commits
php-hound --git-diff b28a1df..4fff883 /path/to/git/repo

The Versions

25/10 2016

dev-master

9999999-dev

Runs a set of quality assurance tools for PHP.

  Sources   Download

The Requires

 

The Development Requires

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd

31/10 2015

0.7.1

0.7.1.0

Runs a set of quality assurance tools for PHP.

  Sources   Download

The Requires

 

The Development Requires

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd

31/10 2015

0.7.0

0.7.0.0

Runs a set of quality assurance tools for PHP.

  Sources   Download

The Requires

 

The Development Requires

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd

01/09 2015

0.6.0

0.6.0.0

Runs a set of quality assurance tools for PHP.

  Sources   Download

The Requires

 

The Development Requires

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd

19/08 2015

0.5.1

0.5.1.0

Runs a set of quality assurance tools for PHP.

  Sources   Download

The Requires

 

The Development Requires

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd

17/08 2015

0.5.0

0.5.0.0

Runs a set of quality assurance tools for PHP.

  Sources   Download

The Requires

 

The Development Requires

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd

08/08 2015

0.4.0

0.4.0.0

Runs a set of quality assurance tools for PHP.

  Sources   Download

The Requires

 

The Development Requires

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd

07/08 2015

0.3.0

0.3.0.0

Runs a set of quality verification tools for PHP.

  Sources   Download

The Requires

 

The Development Requires

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd

07/08 2015

0.2.0

0.2.0.0

Runs a set of quality verification tools for PHP.

  Sources   Download

The Requires

 

The Development Requires

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd

07/08 2015

0.1.0

0.1.0.0

Runs a set of quality verification tools for PHP.

  Sources   Download

The Requires

 

by Alan Michel Willms Quinot

phpcs phpmd quality qa phpcpd