-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
106 additions
and
6 deletions.
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
<?xml version="1.0"?> | ||
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="GravityView" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd"> | ||
|
||
<description>A custom set of PHP Code Sniffer rules for GravityView plugin.</description> | ||
|
||
<!-- Exclude the Composer Vendor directory. --> | ||
<exclude-pattern>/vendor/*</exclude-pattern> | ||
|
||
<!-- Exclude the Node Modules directory. --> | ||
<exclude-pattern>/node_modules/*</exclude-pattern> | ||
|
||
<!-- Exclude minified Javascript files. --> | ||
<exclude-pattern>*.min.js</exclude-pattern> | ||
|
||
<rule ref="WordPress"> | ||
<exclude name="Generic" /> | ||
<exclude name="Squiz" /> | ||
<exclude name="PEAR" /> | ||
<exclude name="MySource" /> | ||
<exclude name="PSR1" /> | ||
<exclude name="PSR12" /> | ||
<exclude name="PSR2" /> | ||
<exclude name="Zend" /> | ||
</rule> | ||
|
||
<!-- Include the WordPress-Extra standard. --> | ||
<rule ref="WordPress-Extra"> | ||
<!-- | ||
We may want a middle ground though. The best way to do this is add the | ||
entire ruleset, then rule by rule, remove ones that don't suit a project. | ||
We can do this by running `phpcs` with the '-s' flag, which allows us to | ||
see the names of the sniffs reporting errors. | ||
Once we know the sniff names, we can opt to exclude sniffs which don't | ||
suit our project like so. | ||
The below two examples just show how you can exclude rules. | ||
They are not intended as advice about which sniffs to exclude. | ||
--> | ||
|
||
<exclude name="WordPress.WhiteSpace.ControlStructureSpacing"/> | ||
<exclude name="WordPress.Security.NonceVerification.Missing"/> | ||
<exclude name="WordPress.Security.EscapeOutput.OutputNotEscaped"/> | ||
</rule> | ||
|
||
<!-- Let's also check that everything is properly documented. --> | ||
<rule ref="WordPress-Docs"/> | ||
|
||
<!-- Add in some extra rules from other standards. --> | ||
<rule ref="Generic.CodeAnalysis.UnusedFunctionParameter"/> | ||
<rule ref="Generic.Commenting.Todo"/> | ||
|
||
<!-- Check for PHP cross-version compatibility. --> | ||
<!-- | ||
To enable this, the PHPCompatibilityWP standard needs | ||
to be installed. | ||
See the readme for installation instructions: | ||
https://github.com/PHPCompatibility/PHPCompatibilityWP | ||
For more information, also see: | ||
https://github.com/PHPCompatibility/PHPCompatibility | ||
--> | ||
<config name="testVersion" value="5.3-"/> | ||
<rule ref="PHPCompatibilityWP"/> | ||
|
||
|
||
<!-- | ||
To get the optimal benefits of using WPCS, we should add a couple of | ||
custom properties. | ||
Adjust the values of these properties to fit our needs. | ||
For information on additional custom properties available, check out | ||
the wiki: | ||
https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties | ||
--> | ||
<config name="minimum_supported_wp_version" value="4.4"/> | ||
|
||
<rule ref="WordPress.WP.I18n"> | ||
<properties> | ||
<property name="text_domain" type="array"> | ||
<element value="gravityview"/> | ||
</property> | ||
</properties> | ||
</rule> | ||
|
||
<rule ref="WordPress.NamingConventions.PrefixAllGlobals"> | ||
<properties> | ||
<property name="prefixes" type="array"> | ||
<element value="gv"/> | ||
<element value="gravityview"/> | ||
</property> | ||
</properties> | ||
</rule> | ||
|
||
</ruleset> |
65380da
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to add codesniffing to Travis, but for now, I wanted to take an hour and finally get PHPCS set up on my PhpStorm installation.