Created
August 20, 2017 16:50
-
-
Save paulund/8aacc8e8216c21136c182576fc078ec4 to your computer and use it in GitHub Desktop.
PHP PSR-2 CodeSniffer Config for Laravel
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?xml version="1.0"?> | |
<ruleset name="Laravel Standards"> | |
<!-- | |
The name attribute of the ruleset tag is displayed | |
when running PHP_CodeSniffer with the -v command line | |
argument. The description tag below is not displayed anywhere | |
except in this file, so it can contain information for | |
developers who may change this file in the future. | |
--> | |
<description>The Laravel Coding Standards</description> | |
<!-- | |
If no files or directories are specified on the command line | |
your custom standard can specify what files should be checked | |
instead. | |
Note that specifying any file or directory path | |
on the command line will ignore all file tags. | |
--> | |
<file>app</file> | |
<file>config</file> | |
<file>public</file> | |
<file>resources</file> | |
<file>routes</file> | |
<file>tests</file> | |
<!-- | |
You can hard-code ignore patterns directly into your | |
custom standard so you don't have to specify the | |
patterns on the command line. | |
--> | |
<exclude-pattern>*/database/*</exclude-pattern> | |
<exclude-pattern>*/cache/*</exclude-pattern> | |
<exclude-pattern>*/*.js</exclude-pattern> | |
<exclude-pattern>*/*.css</exclude-pattern> | |
<exclude-pattern>*/*.xml</exclude-pattern> | |
<exclude-pattern>*/*.blade.php</exclude-pattern> | |
<exclude-pattern>*/autoload.php</exclude-pattern> | |
<exclude-pattern>*/storage/*</exclude-pattern> | |
<exclude-pattern>*/docs/*</exclude-pattern> | |
<exclude-pattern>*/vendor/*</exclude-pattern> | |
<exclude-pattern>*/migrations/*</exclude-pattern> | |
<!-- | |
You can hard-code command line values into your custom standard. | |
Note that this does not work for the command line values: | |
-v[v][v], -l, -d, -sniffs and -standard | |
The following tags are equivalent to the command line arguments: | |
-p | |
--> | |
<arg name="report" value="summary"/> | |
<arg name="colors"/> | |
<arg value="p"/> | |
<!-- | |
You can hard-code custom php.ini settings into your custom standard. | |
The following tag sets the memory limit to 64M. | |
--> | |
<ini name="memory_limit" value="128M"/> | |
<!-- | |
Include all sniffs in the PEAR standard. Note that the | |
path to the standard does not have to be specified as the | |
PEAR standard exists inside the PHP_CodeSniffer install | |
directory. | |
--> | |
<rule ref="PSR2"/> | |
</ruleset> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hi Paul,
I'm using this GIST as a starting point. But I've found that defining the files in the
<file>
list isn't acting recursively?Is there a way to do that, or do I HAVE to list each folder separately. For example, using your config, my
phpcs
isn't crawling throughapp/Http/Controllers
.