sclable/coding-standards

This package is abandoned and no longer maintained. No replacement package was suggested.

Our code of conduct requires strict adherence to the FIG PSR standards. The automated checks are collected in this Tool.

0.2.1 2016-09-06 10:33 UTC

Requires

• phpmd/phpmd: ^2.2
• squizlabs/php_codesniffer: ^2.3
• symfony/process: ^2.7|^3.0

Requires (Dev)

• phing/phing: ^2.0

MIT

• Michael Rutz

README

Our code of conduct requires strict adherence to the PHP-FIG standards. The automated checks are collected in this Tool.

Usage

Installation

Installation with composer as a dependency in your project:

composer require --dev sclable/coding-standards:*

A global installation is also recommended. If you put the global vendor/bin into you $PATH environment variable, the command sclcheck and sclfix can be used from anywhere (see description here). To do so, execute:

composer global require sclable/coding-standards:*

Included tools

Currently two tools are integrated:

• PHP CodeSniffer
• PHP MessDetector

Run checks

After the installation with composer you're able to run the checks with a single command:

# Linux/Mac OS X
cd path/to/project/root
vendor/bin/sclcheck path/to/source

# Windows
cd path/to/project/root
php vendor/bin/sclcheck path/to/source

Run fixes

Some of the problems can be fixed automatically (e.g. curly braces on wrong lines, spaces at the end of a line):

# Linux/Mac OS X
cd path/to/project/root
vendor/bin/sclfix path/to/source

# Windows
cd path/to/project/root
php vendor/bin/sclfix path/to/source

Changelog

See the CHANGELOG file.

License

For the license and copyright see the LICENSE file.