Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PHPCheckstyle/phpcheckstyle
PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions.
https://github.com/PHPCheckstyle/phpcheckstyle
checkstyle coding-conventions php phpcheckstyle
Last synced: 2 months ago
JSON representation
PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions.
- Host: GitHub
- URL: https://github.com/PHPCheckstyle/phpcheckstyle
- Owner: PHPCheckstyle
- License: lgpl-3.0
- Created: 2014-08-19T12:39:34.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T07:46:46.000Z (about 2 years ago)
- Last Synced: 2024-04-14T17:04:27.508Z (9 months ago)
- Topics: checkstyle, coding-conventions, php, phpcheckstyle
- Language: PHP
- Homepage: https://github.com/PHPCheckstyle/phpcheckstyle
- Size: 1.02 MB
- Stars: 164
- Watchers: 15
- Forks: 31
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php - PHPCheckstyle - A tool to help adhere to certain coding conventions. (Table of Contents / Code Quality)
- awesome-php-cn - PHPCheckstyle - 一个工具来帮助遵守特定的编码惯例. (目录 / 代码质量 Code Quality)
- awesome-projects - PHPCheckstyle - A tool to help adhere to certain coding conventions. (PHP / Code Quality)
- php-awesome - PHPCheckstyle - 编码风格检测软件 (类库 / 代码检查/静态分析)
- awesome-php - PHPCheckstyle - A tool to help adhere to certain coding conventions. (Table of Contents / Code Quality)
README
# PHPCheckstyle
[](https://travis-ci.org/PHPCheckstyle/phpcheckstyle)
## 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.
The tool uses the PEAR Coding Standards as the default coding convention.
But it allows you to configure it to suit your coding standards.
Please visit [https://github.com/PHPCheckstyle/phpcheckstyle/wiki](https://github.com/PHPCheckstyle/phpcheckstyle/wiki) for
more information and documentation
## Requirements
- PHP 5.0 or newer.
- Web browser to view the checkstyle report (only for html view)
- That's all.
## Installation
### Installation with Composer
```sh
composer require phpcheckstyle/phpcheckstyle
```
or Add `phpcheckstyle/phpcheckstyle` as a requirement to `composer.json`:
```json
{
"require": {
"phpcheckstyle/phpcheckstyle": "dev-master"
}
}
```
Update your packages with `composer update` or if installing from fresh, with `composer install`.
### Manual Installation
Just download [https://github.com/PHPCheckstyle/phpcheckstyle/archive/master.zip](https://github.com/PHPCheckstyle/phpcheckstyle/archive/master.zip) and unzip the distribution.
```bash
$> unzip PhpCheckstyle.zip
```
This will create a directory called `phpcheckstyle` and expand all
files in it.
### Testing with Vagrant
* install [VirtualBox](https://www.virtualbox.org/)
* install [Vagrant](https://www.vagrantup.com/)
* launch `vagrant up` in the project root directory to start the VM
* In case of problem with the "guest additions", launch :
>vagrant plugin install vagrant-vbguest
* 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.
```bash
$> cd phpcheckstyle
```
- Execute the `run.php` script providing the `--src` option.
```bash
$> php run.php --src
```
- Use the `--help` option to see more options
```bash
$> php run.php --help
```
# License
See [LICENSE](/LICENSE.txt)