Download the PHP package jobilla/coding-rules without Composer
On this page you can find all versions of the php package jobilla/coding-rules. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jobilla/coding-rules
More information about jobilla/coding-rules
Files in jobilla/coding-rules
Package coding-rules
Short Description Jobilla's general code styling rules for different tools
License Apache-2.0
Homepage https://github.com/jobilla/coding-rules
Informations about the package coding-rules
Jobilla's code quality inspections tools' configurations
Full QA set for PHP code includes the following tools
- PHPUNIT (https://github.com/sebastianbergmann/phpunit)
- PHPCS (https://github.com/squizlabs/PHP_CodeSniffer)
- PHPMD (https://github.com/phpmd/phpmd)
- PHPCPD (https://github.com/sebastianbergmann/phpcpd)
- PHPLOC (https://github.com/sebastianbergmann/phploc)
Recommended usage
Internally we're running automatic checks using a continuous integration server (Bamboo), but basically any continuous integration server should be capable of getting the job done. (highly recommended)
You should also be able to hook the tools into the text-editor / IDE of your choice. Below are some examples that our in-house developer team prefers.
PHPMD Plugins
https://github.com/AtomLinter/linter-phpmd
https://github.com/SublimeLinter/SublimeLinter-phpmd
https://www.jetbrains.com/help/phpstorm/10.0/using-php-mess-detector.html
PHPCS Plugins
https://atom.io/packages/linter-phpcs
https://github.com/SublimeLinter/SublimeLinter-phpcs
https://www.jetbrains.com/help/phpstorm/10.0/using-php-code-sniffer-tool.html
Installing & running the checks
- Clone the repository / include into your project's composer.json
- If including via composer, run
composer update
to install the configuration files into yourvendor
folder - Remember to include desired QA tools into your main projects
require-dev
part in composer.json, in order to use the actual tools + FG custom configuration files -
Example from our internal projects' composer.json
- Run the tools via CLI or integrate into your development tools
- Running via CLI example:
Fixing code styling errors automatically
PHPCS ships with an executable called phpcbf
, which allows automatically fixing some of the violations detected by the CodeSniffer. More info can be found through this link: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically
Example of running phpcbf
via CLI:
The following repositories & authors' work have been used as a base for individual parts of the configuration, or have heavily influenced the end result:
https://github.com/bigbank-as/phpcs
https://gist.github.com/slayerfat/2b3cc4faf94d2863b505