Merge pull request #6 from openmindculture/wp-code-sniffer

add WordPress code sniffer

.gitignore

@@ -1,9 +1,12 @@
 themes/
 node_modules
-
+vendor
 data
 wordpress
 .wp-cli
 !.wp-cli/cache
 wp_data
 .idea
+.svn
+incompatibility-status/tags
+

README.md

@@ -14,6 +14,12 @@ In JetBrains IDEA (PhpStorm, WebStorm, etc.) enable WordPress support and set `w
 
 Some SonarLint warnings (and PHP PSR conventions) should be ignored, like avoiding underscores in function names. As we operate in a global namespace shared with other plugins, it is considered best practice to use a unique prefix for identifiers used for `function`, `class`, and `define`.
 
+A local code sniffer validation can be set up using the provided `composer.json` configuration. Note that this currently does not work with PHP 8, so you need to use a PHP 7.4 runtime (`/usr/bin/php74`). You may need to adjust the IDE settings to WordPress coding standards and code sniffer configurations according to the provided tutorial.
+
+- https://packagist.org/packages/wp-coding-standards/wpcs
+- https://www.jetbrains.com/help/idea/using-php-code-sniffer.html#installing-configuring-code-sniffer
+- https://www.linuxbabe.com/ubuntu/php-multiple-versions-ubuntu
+
 ### SVN Release Tags
 
 We use `git` branches and tags for feature development, and `svn` to release to the WordPress plugin directory. So all development is done in `incompatibility-status/trunk`!

composer.json

@@ -0,0 +1,32 @@
+{
+	"name": "pantheon-systems/example-wordpress-composer",
+	"description": "",
+	"type": "project",
+	"keywords": [],
+	"repositories": [
+		{
+			"type": "composer",
+			"url": "https://wpackagist.org"
+		}
+	],
+	"require": {
+		"php": "^7.4"
+	},
+	"require-dev": {
+		"squizlabs/php_codesniffer": "^3.7.1",
+		"wp-coding-standards/wpcs": "^2.3.0"
+	},
+	"config": {
+		"vendor-dir": "vendor",
+		"preferred-install": "dist",
+		"optimize-autoloader": true,
+		"sort-packages": true,
+		"platform": {
+			"php": "7.4"
+		}
+	},
+	"extra": {
+		"wordpress-install-dir": "wp_data",
+		"lint": "find src -name '*.php' -exec php -l {} \\;"
+	}
+}