https://github.com/padosoft/static-review
Custom Static Review classes
https://github.com/padosoft/static-review
git git-hooks hooks
Last synced: about 2 months ago
JSON representation
Custom Static Review classes
- Host: GitHub
- URL: https://github.com/padosoft/static-review
- Owner: padosoft
- License: mit
- Created: 2016-02-21T11:35:07.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-08-09T08:10:06.000Z (almost 9 years ago)
- Last Synced: 2025-01-02T03:44:21.254Z (over 1 year ago)
- Topics: git, git-hooks, hooks
- Language: PHP
- Size: 26.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# static-review
Custom Static Review classes
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
[![SensioLabsInsight][ico-sensiolab]][link-sensiolab]
Table of Contents
=================
* [Custom Static Review classes](#progetto-static-review)
* [Table of Contents](#table-of-contents)
* [Prerequisites](#prerequisites)
* [Change Log](#change-log)
* [Installation](#installation)
* [Example](#example)
* [Contributing](#contributing)
* [Security](#security)
* [Credits](#credits)
* [About Padosoft](#about-padosoft)
* [License](#license)
# PREREQUISITES
Prerequisites of package are
"sjparkinson/static-review":
"squizlabs/php_codesniffer":
"phpunit/phpunit"
"scrutinizer/ocular"
"phpmd/phpmd"
installed as required in composer
create a new Hooks directory and copy pre-commit.php into from src/config folder.
``` bash
$ mkdir hooks
$ copy vendor/padosoft/static-review/src/config/pre-commit.php hooks/pre-commit.php
```
# CHANGE LOG
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
# INSTALLATION
You can install the package via composer:
``` bash
$ composer require padosoft/static-review
```
Open hooks/pre-commit.php in your root folder (created in PREREQUISITES above section) and add custom review.
For example if you want to add VarDumpReview and DdReview:
``` php
$review->addReview(new LineEndingsReview())
//.....
//.....
//.....
//.....
->addReview(new VarDumpReview());
->addReview(new DdReview());
```
In the end, create a pre-commit hook, by running the following command:
``` bash
create in .git/hooks a file named pre-commit like this
****************************************************************
#!/bin/sh
php.exe "hooks/pre-commit.php"
****************************************************************
This for windows environment, for linux and mac you must use this
****************************************************************
#!/bin/sh
php "hooks/pre-commit.php"
****************************************************************
```
# EXAMPLE
## Screenshot esempio
# Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
# Security
If you discover any security related issues, please email instead of using the issue tracker.
# Credits
- [Padosoft](https://github.com/padosoft)
- [All Contributors](../../contributors)
# About Padosoft
Padosoft is a software house based in Florence, Italy. Specialized in E-commerce and web sites.
# License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/padosoft/static-review.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/padosoft/static-review.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/padosoft/static-review.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/padosoft/static-review.svg?style=flat-square
[ico-sensiolab]: https://insight.sensiolabs.com/projects/aedff4d3-49ad-4b90-a4ab-52e9a1fa8df6/small.png
[link-packagist]: https://packagist.org/packages/padosoft/static-review
[link-scrutinizer]: https://scrutinizer-ci.com/g/padosoft/static-review/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/padosoft/static-review
[link-downloads]: https://packagist.org/packages/padosoft/static-review
[link-sensiolab]: https://insight.sensiolabs.com/projects/aedff4d3-49ad-4b90-a4ab-52e9a1fa8df6