A PHPCS Ruleset for Tango Financial.
These are a set of modern linting guidelines for PHP developer at Tango Financial. This project is a phpcs "standard" (a collection of rules or "sniffs") that can be included in any project.
composer require --dev tangoca/phpcs-ruleset
When installing sniff standards in a project, you edit a
phpcs.xml file with the
rule tag inside the
ruleset tag. The
ref attribute of that tag should specify a standard, category, sniff, or error code to enable. It’s also possible to use these tags to disable or modify certain rules. The official annotated file explains how to do this.
The following configuration will enable all the sniffs in this ruleset.
<?xml version="1.0"?> <ruleset name="Project Name"> <description>Project Name.</description> <rule ref="TangoRuleset"/> </ruleset>
Most editors have a phpcs plugin available, but you can also run phpcs manually. To run phpcs on a file in your project, just use the command-line as follows (the
-s causes the sniff code to be shown, which is very important for learning about an error).
vendor/bin/phpcs -s src/MyProject/MyClass.php