alma-gateway-for-woocommerce
Last commit date
assets
2 years ago
build
2 years ago
includes
2 years ago
languages
2 years ago
public
2 years ago
tests
2 years ago
trunk
2 years ago
vendor
2 years ago
LICENSE
4 years ago
alma-gateway-for-woocommerce.php
2 years ago
composer.json
2 years ago
composer.lock
2 years ago
phpcs.xml
2 years ago
readme.txt
2 years ago
uninstall.php
3 years ago
phpcs.xml
105 lines
| 1 | <?xml version="1.0"?> |
| 2 | <ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Alma Woocommerce Gateway" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd"> |
| 3 | |
| 4 | <description>A custom set of rules to check for Alma Woocommerce Gateway</description> |
| 5 | |
| 6 | <!-- Exclude WP Core folders and files from being checked. --> |
| 7 | <exclude-pattern>/docroot/wp-admin/*</exclude-pattern> |
| 8 | <exclude-pattern>/docroot/wp-includes/*</exclude-pattern> |
| 9 | <exclude-pattern>/docroot/wp-*.php</exclude-pattern> |
| 10 | <exclude-pattern>/docroot/index.php</exclude-pattern> |
| 11 | <exclude-pattern>/docroot/xmlrpc.php</exclude-pattern> |
| 12 | <exclude-pattern>/docroot/wp-content/plugins/*</exclude-pattern> |
| 13 | |
| 14 | <!-- Exclude tests. --> |
| 15 | <exclude-pattern>/tests/*</exclude-pattern> |
| 16 | |
| 17 | <!-- Exclude widget --> |
| 18 | <exclude-pattern>/assets/widget/*</exclude-pattern> |
| 19 | |
| 20 | <!-- Exclude the Composer Vendor directory. --> |
| 21 | <exclude-pattern>/vendor/*</exclude-pattern> |
| 22 | |
| 23 | <!-- Exclude the Node Modules directory. --> |
| 24 | <exclude-pattern>/node_modules/*</exclude-pattern> |
| 25 | |
| 26 | <!-- Exclude minified Javascript files. --> |
| 27 | <exclude-pattern>*.min.js</exclude-pattern> |
| 28 | |
| 29 | <!-- Exclude build --> |
| 30 | <exclude-pattern>/build/*</exclude-pattern> |
| 31 | |
| 32 | <!-- Include the WordPress-Extra standard. --> |
| 33 | <rule ref="WordPress-Extra"> |
| 34 | <!-- |
| 35 | We may want a middle ground though. The best way to do this is add the |
| 36 | entire ruleset, then rule by rule, remove ones that don't suit a project. |
| 37 | We can do this by running `phpcs` with the '-s' flag, which allows us to |
| 38 | see the names of the sniffs reporting errors. |
| 39 | Once we know the sniff names, we can opt to exclude sniffs which don't |
| 40 | suit our project like so. |
| 41 | The below two examples just show how you can exclude rules. |
| 42 | They are not intended as advice about which sniffs to exclude. |
| 43 | --> |
| 44 | |
| 45 | <!-- |
| 46 | <exclude name="WordPress.WhiteSpace.ControlStructureSpacing"/> |
| 47 | <exclude name="WordPress.Security.EscapeOutput"/> |
| 48 | --> |
| 49 | <exclude name="WordPress.Files.FileName" /> |
| 50 | </rule> |
| 51 | |
| 52 | <!-- Let's also check that everything is properly documented. --> |
| 53 | <rule ref="WordPress-Docs"/> |
| 54 | |
| 55 | <!-- Add in some extra rules from other standards. --> |
| 56 | <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter"/> |
| 57 | <rule ref="Generic.Commenting.Todo"/> |
| 58 | |
| 59 | <!-- Check for PHP cross-version compatibility. --> |
| 60 | <!-- |
| 61 | To enable this, the PHPCompatibilityWP standard needs |
| 62 | to be installed. |
| 63 | See the readme for installation instructions: |
| 64 | https://github.com/PHPCompatibility/PHPCompatibilityWP |
| 65 | For more information, also see: |
| 66 | https://github.com/PHPCompatibility/PHPCompatibility |
| 67 | --> |
| 68 | <config name="testVersion" value="5.6-"/> |
| 69 | <rule ref="PHPCompatibilityWP"/> |
| 70 | |
| 71 | <!-- |
| 72 | To get the optimal benefits of using WPCS, we should add a couple of |
| 73 | custom properties. |
| 74 | Adjust the values of these properties to fit our needs. |
| 75 | For information on additional custom properties available, check out |
| 76 | the wiki: |
| 77 | https://github.com/WordPress/WordPress-Coding-Standards/wiki/Customizable-sniff-properties |
| 78 | --> |
| 79 | <config name="minimum_supported_wp_version" value="4.4"/> |
| 80 | |
| 81 | <rule ref="WordPress.WP.I18n"> |
| 82 | <properties> |
| 83 | <property name="text_domain" type="array"> |
| 84 | <element value="alma-gateway-for-woocommerce"/> |
| 85 | </property> |
| 86 | </properties> |
| 87 | </rule> |
| 88 | |
| 89 | <rule ref="WordPress.NamingConventions.PrefixAllGlobals"> |
| 90 | <properties> |
| 91 | <property name="prefixes" type="array"> |
| 92 | <element value="Alma\Woocommerce"/> |
| 93 | <element value="alma"/> |
| 94 | </property> |
| 95 | |
| 96 | </properties> |
| 97 | </rule> |
| 98 | |
| 99 | <rule ref="Squiz.Commenting.FunctionCommentThrowTag"> |
| 100 | <exclude name="Squiz.Commenting.FunctionCommentThrowTag.WrongNumber"/> |
| 101 | </rule> |
| 102 | |
| 103 | <config name="ignore_warnings_on_exit" value="1"/> |
| 104 | </ruleset> |
| 105 |