Merge pull request #765 from alleyinteractive/feature/create-packages-phpstan

Improve phpstan typings for generated blocks and entries

Author: srtfisher

.changeset/young-gorillas-hope.md

@@ -0,0 +1,6 @@
+---
+"@alleyinteractive/create-block": patch
+"@alleyinteractive/create-entry": patch
+---
+
+Improve the phpstan typings.

package.json

@@ -11,6 +11,7 @@
   "scripts": {
     "prebuild": "check-node-version --package",
     "build": "turbo run build --cache-dir=.turbo",
+    "changeset": "npx @changesets/cli",
     "preinstall": "check-node-version --package",
     "prelint": "check-node-version --package",
     "lint": "turbo run lint --cache-dir=.turbo",

packages/create-block/templates/javascript/render.php.mustache

@@ -7,9 +7,9 @@
  *
  * @phpcs:disable WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound -- File doesn't load in global scope, just appears to to PHPCS.
  *
- * @var array    $attributes The array of attributes for this block.
- * @var string   $content    Rendered block output. ie. <InnerBlocks.Content />.
- * @var WP_Block $block      The instance of the WP_Block class that represents the block being rendered.
+ * @var array<string, mixed> $attributes The array of attributes for this block.
+ * @var string               $content    Rendered block output. ie. <InnerBlocks.Content />.
+ * @var WP_Block             $block      The instance of the WP_Block class that represents the block being rendered.
  *
  * @package {{namespace}}
  */

packages/create-block/templates/typescript/render.php.mustache

@@ -7,9 +7,9 @@
  *
  * @phpcs:disable WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound -- File doesn't load in global scope, just appears to to PHPCS.
  *
- * @var array    $attributes The array of attributes for this block.
- * @var string   $content    Rendered block output. ie. <InnerBlocks.Content />.
- * @var WP_Block $block      The instance of the WP_Block class that represents the block being rendered.
+ * @var array<string, mixed> $attributes The array of attributes for this block.
+ * @var string               $content    Rendered block output. ie. <InnerBlocks.Content />.
+ * @var WP_Block             $block      The instance of the WP_Block class that represents the block being rendered.
  *
  * @package {{namespace}}
  */

packages/create-entry/templates/entry/index.php.mustache

@@ -16,10 +16,18 @@
 /**
  * Register the {{slug}} entry point assets so that they can be enqueued.
  */
-function {{nameSpaceSnakeCase}}_register_{{slugUnderscore}}_scripts() {
-	// Automatically load dependencies and version.
+function {{nameSpaceSnakeCase}}_register_{{slugUnderscore}}_scripts(): void {
+	/**
+	 * Asset file generated by wp-scripts.
+	 *
+	 * @var array{dependencies: string[], version: string}|false $asset_file
+	 */
 	$asset_file = include __DIR__ . '/index.asset.php';
 
+	if ( ! $asset_file ) {
+		return;
+	}
+
 	// Register the {{slug}} script.
 	wp_register_script(
 		'{{prefixNameSpace}}-{{slug}}-js',
@@ -45,7 +53,7 @@ add_action( 'init', '{{nameSpaceSnakeCase}}_register_{{slugUnderscore}}_scripts'
 /**
  * Enqueue scripts for the {{slug}} entry point.
  */
-function {{nameSpaceSnakeCase}}_enqueue_{{slugUnderscore}}_scripts() {
+function {{nameSpaceSnakeCase}}_enqueue_{{slugUnderscore}}_scripts(): void {
 	wp_enqueue_script( '{{prefixNameSpace}}-{{slug}}-js' );
 }
 add_action( '{{enqueueHook}}', '{{nameSpaceSnakeCase}}_enqueue_{{slugUnderscore}}_scripts' );
@@ -54,9 +62,9 @@ add_action( '{{enqueueHook}}', '{{nameSpaceSnakeCase}}_enqueue_{{slugUnderscore}
 /**
  * Enqueue styles for the {{slug}} entry point.
  */
-function {{nameSpaceSnakeCase}}_enqueue_{{slugUnderscore}}_styles() {
+function {{nameSpaceSnakeCase}}_enqueue_{{slugUnderscore}}_styles(): void {
 	wp_enqueue_style( '{{prefixNameSpace}}-{{slug}}-css' );
 }
 add_action( '{{enqueueStyleHook}}', '{{nameSpaceSnakeCase}}_enqueue_{{slugUnderscore}}_styles' );
 {{/hasStyles}}
-{{/hasEnqueue}}
+{{/hasEnqueue}}