2017 © Pedro Peláez
 

library phpcheckstyle

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

image

phpcheckstyle/phpcheckstyle

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  • Monday, January 29, 2018
  • by Tchule
  • Repository
  • 16 Watchers
  • 123 Stars
  • 30,659 Installations
  • PHP
  • 7 Dependents
  • 0 Suggesters
  • 30 Forks
  • 16 Open issues
  • 10 Versions
  • 6 % Grown

The README.md

PHPCheckstyle

Build Status, (*1)

Overview

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions. The tools checks the input PHP source code and reports any deviations from the coding convention., (*2)

The tool uses the PEAR Coding Standards as the default coding convention. But it allows you to configure it to suit your coding standards., (*3)

Please visit https://github.com/PHPCheckstyle/phpcheckstyle/wiki for more information and documentation, (*4)

Requirements

  • PHP 5.0 or newer.
  • Web browser to view the checkstyle report (only for html view)
  • That's all.

Installation

Installation with Composer

composer require phpcheckstyle/phpcheckstyle

or Add phpcheckstyle/phpcheckstyle as a requirement to composer.json:, (*5)

{
    "require": {
        "phpcheckstyle/phpcheckstyle": "dev-master"
    }
}

Update your packages with composer update or if installing from fresh, with composer install., (*6)

Manual Installation

Just download https://github.com/PHPCheckstyle/phpcheckstyle/archive/master.zip and unzip the distribution., (*7)

$> unzip PhpCheckstyle.zip

This will create a directory called phpcheckstyle and expand all files in it., (*8)

Testing with Vagrant

  • install VirtualBox
  • install Vagrant

  • launch vagrant up in the project root directory to start the VM, (*9)

  • In case of problem with the "guest additions", launch :, (*10)

vagrant plugin install vagrant-vbguest, (*11)

  • to run PHPCheckstyle on itself, type vagrant provision --provision-with run_phpcheckstyle
  • to run PHPUnit, type vagrant provision --provision-with run_phpunit
  • to log inside the VM, type vagrant ssh

Usage

  • Change directory to the PHPCheckstyle installation directory., (*12)

    $> cd phpcheckstyle

  • Execute the run.php script providing the --src option., (*13)

    $> php run.php --src <php source directory/file>

  • Use the --help option to see more options, (*14)

    $> php run.php --help

License

See LICENSE, (*15)

The Versions

29/01 2018

dev-master

9999999-dev https://github.com/phpcheckstyle/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

The Development Requires

standard checkstyle convention

10/11 2017

V0.14.7

0.14.7.0 https://github.com/phpcheckstyle/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

The Development Requires

standard checkstyle convention

23/02 2017

V0.14.6

0.14.6.0 https://github.com/phpcheckstyle/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

The Development Requires

standard checkstyle convention

14/02 2017

V0.14.5

0.14.5.0 https://github.com/phpcheckstyle/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

The Development Requires

standard checkstyle convention

06/01 2017

V0.14.4

0.14.4.0 https://github.com/phpcheckstyle/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

standard checkstyle convention

06/01 2017

V0.14.3

0.14.3.0 https://github.com/phpcheckstyle/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

standard checkstyle convention

02/09 2014

dev-prefer-quotes-check

dev-prefer-quotes-check https://github.com/jbrooksuk/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

standard checkstyle convention

29/08 2014

dev-npath-complexity

dev-npath-complexity https://github.com/jbrooksuk/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

standard checkstyle convention

29/08 2014

dev-code-cleanup

dev-code-cleanup https://github.com/jbrooksuk/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

standard checkstyle convention

31/03 2014

V0.13.1

0.13.1.0 http://code.google.com/p/phpcheckstyle/

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions

  Sources   Download

OSL-2.1

The Requires

  • php >=5.0.0

 

standard checkstyle convention