Download the PHP package olivertappin/phpcs-diff without Composer
On this page you can find all versions of the php package olivertappin/phpcs-diff. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download olivertappin/phpcs-diff
More information about olivertappin/phpcs-diff
Files in olivertappin/phpcs-diff
Package phpcs-diff
Short Description Detects violations of a defined coding standard based on a git diff.
License
Informations about the package phpcs-diff
Installation
The recommended method of installing this library is via Composer.
Composer
Global Installation
Run the following command from your project root:
composer global require olivertappin/phpcs-diff
Manual Installation
Alternatively, you can manually include a dependency for olivertappin/phpcs-diff
in your composer.json
file. For example:
And run composer update olivertappin/phpcs-diff
.
Git Clone
You can also download the phpcs-diff
source and create a symlink to your /usr/bin
directory:
git clone https://github.com/olivertappin/phpcs-diff.git
ln -s phpcs-diff/bin/phpcs-diff /usr/bin/phpcs-diff
cd /var/www/project
phpcs-diff master -v
Usage
Basic Usage
Where the current branch you are on is the branch you are comparing with, and develop
is the base branch. In this example, phpcs-diff
would run the following diff statement behind the scenes:
Please note:
- The
-v
flag is optional. This returns a verbose output during processing. - The
current-branch
parameter is optional. If this is not defined,phpcs-diff
will use the current commit hash viagit rev-parse --verify HEAD
. - You must have a
ruleset.xml
defined in your project base directory.
After running phpcs-diff
, the executable will return an output similar to the following:
Currently this is the only supported format however, I will look into adding additional formats (much like phpcs
) in the near future.
Travis CI Usage
To use this as part of your CI/CD pipeline, create a script with the following:
Which will allow you to run phpcs-diff
against the diff of your pull-request.
Here's a sample of how this might look within Travis CI:
About
phpcs-diff
detects violations of a defined set of coding standards based on a git diff
. It uses phpcs
from the PHP_CodeSniffer project.
This project helps by achieving the following:
- Speeds up your CI/CD pipeline validating changed files only, rather than the whole code base.
- Allows you to migrate legacy code bases that cannot risk changing everything at once to become fully compliant to a coding standard.
This executable works by only checking the changed lines, compared to the base branch, against all failed violations for those files, so you can be confident that any new or changed code will be compliant.
This will hopefully put you in a position where your codebase will become more compliant to that coding standard over time, and maybe you will find the resource to eventually change everything, and just run phpcs
on its own.
Requirements
The latest version of phpcs-diff
requires PHP version 5.6.0 or later.
This project also depends on squizlabs/php_codesniffer
which is used internally to fetch the failed violations via phpcs
.
Finally, the league/climate
package is also installed. This is to deal with console output, but this dependency may be removed in a future release.
Contributing
See CONTRIBUTING.md for information.
All versions of phpcs-diff with dependencies
ext-json Version *
ext-gettext Version *
squizlabs/php_codesniffer Version ^3.5.7
league/climate Version ^3.4