Update linting, add GitHub action and fix linting errors (#3)

Author: ndiego

.github/workflows/code-linting.yml

@@ -0,0 +1,34 @@
+name: Code Linting - PHP
+
+on:
+  pull_request:
+    branches: [trunk]
+  push:
+    branches: [trunk]
+
+jobs:
+  phpcs_check:
+    name: PHPCS check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
+      - name: Setup PHP
+        uses: shivammathur/setup-php@a7f90656b3be3996d1ec5501e8e25d5d35aa9bb2 # v2.15.0
+        with:
+          php-version: 7.4
+      - name: Get composer cache directory
+        id: composer-cache
+        run: |
+          echo "::set-output name=dir::$(composer config cache-files-dir)"
+      - name: Cache composer dependencies
+        uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+      - name: Install composer packages
+        run: composer install --no-progress
+      - name: Check PHP coding standards using PHPCS
+        run: composer lint -- --runtime-set ignore_warnings_on_exit true --runtime-set testVersion 5.8-

block-pattern-explorer.php

@@ -14,12 +14,13 @@
  *
  * @package Block Pattern Explorer
  */
+
 namespace BlockPatternExplorer;
 
 defined( 'ABSPATH' ) || exit;
 
 define( 'BPE_ABSPATH', dirname( __FILE__ ) . '/' );
-define( 'BPE_VERSION', get_file_data( __FILE__, [ 'Version' ] )[0] );
+define( 'BPE_VERSION', get_file_data( __FILE__, [ 'Version' ] )[0] ); // phpcs:ignore
 define( 'BPE_PLUGIN_DIR_URL', plugin_dir_url( __FILE__ ) );
 
 /**
@@ -65,7 +66,7 @@ function get_asset_file( $filepath ) {
 	$asset_path = BPE_ABSPATH . $filepath . '.asset.php';
 
 	return file_exists( $asset_path )
-		? include $asset_path
+		? require_once $asset_path
 		: array(
 			'dependencies' => array(),
 			'version'      => BPE_VERSION,
@@ -99,7 +100,7 @@ function enqueue_script_translations() {
 add_action( 'enqueue_block_editor_assets', __NAMESPACE__ . '\enqueue_script_translations' );
 
 // Custom pattern category type implementation.
-include_once BPE_ABSPATH . '/includes/custom/add-pattern-category-type-support.php';
+require_once BPE_ABSPATH . '/includes/add-pattern-category-type-support.php';
 
 // (Experimental) Will be used once Block Editor settings are filterable in core.
-//include_once BPE_ABSPATH . '/includes/core/add-pattern-category-type-support.php';
+// include_once BPE_ABSPATH . '/includes/core/add-pattern-category-type-support.php';

build/block-pattern-explorer-editor.asset.php

@@ -1 +1 @@
-<?php return array('dependencies' => array('lodash', 'wp-a11y', 'wp-block-editor', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-data', 'wp-element', 'wp-hooks', 'wp-i18n', 'wp-notices', 'wp-primitives'), 'version' => '92e92240fc3ee8aebe874be25d25f2b1');
+<?php return array('dependencies' => array('lodash', 'wp-a11y', 'wp-block-editor', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-data', 'wp-element', 'wp-i18n', 'wp-notices', 'wp-primitives'), 'version' => '6e96279ccef5c66a8125afa3f907e9d0');

build/block-pattern-explorer-editor.js

@@ -1,18 +1,26 @@
 {
-  "name": "block-pattern-explorer",
-  "description": "An experimental plugin to preview and insert block patterns in the Block Editor.",
-  "type": "wordpress-plugin",
-  "license": "GPL-2.0-or-later",
-  "require": {},
-  "require-dev": {
-    "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0",
-    "squizlabs/php_codesniffer": "^3.4.2",
-    "phpcompatibility/php-compatibility": "^9.2.0",
-    "phpcompatibility/phpcompatibility-wp": "^2.1",
-    "wp-coding-standards/wpcs": "^2.1.1"
-  },
-  "scripts": {
-      "lint": "@php ./vendor/bin/phpcs",
-      "lint-fix": "@php ./vendor/bin/phpcbf"
-  }
+    "name": "wpengine/block-pattern-explorer",
+    "type": "wordpress-plugin",
+    "description": "An experimental plugin to preview and insert block patterns in the Block Editor.",
+    "homepage": "https://github.com/wpengine/block-pattern-explorer",
+    "license": "GPL-2.0-or-later",
+    "require": {
+		"php": ">=5.6"
+	},
+    "require-dev": {
+        "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0",
+        "squizlabs/php_codesniffer": "^3.4.2",
+        "phpcompatibility/php-compatibility": "^9.2.0",
+        "phpcompatibility/phpcompatibility-wp": "^2.1",
+        "wp-coding-standards/wpcs": "^2.1.1"
+    },
+    "scripts": {
+        "lint": "@php ./vendor/bin/phpcs",
+        "lint-fix": "@php ./vendor/bin/phpcbf"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    }
 }