Changeset 10058

Timestamp:

07/10/2020 09:28:14 PM (5 years ago)

Author:

ryelle

Message:

Plugin Directory: Update block.json file checks in block checker

Remove the json file check, since the same items are checked for in check_block_json_is_valid. Improve messages in check_for_block_script_files.

See #5303

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• cli/class-block-plugin-checker.php (modified) (3 diffs)
• shortcodes/class-block-validator.php (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php

@@ -275 +275 @@
 
     public function find_block_scripts() {
-        $block_scripts = array();
-        foreach ( $this->blocks as $block ) {
-            $scripts = Import::extract_file_paths_from_block_json( $block );
-            if ( isset( $block_scripts[ $block->name ] ) ) {
-                $block_scripts[ $block->name ] = array_merge( $block_scripts[ $block->name ], $scripts );
-            } else {
-                $block_scripts[ $block->name ] = $scripts;
-            }
-        }
+        $block_scripts = \array_map(
+            function( $block ) {
+                $assets = array();
+                $props = array( 'editorScript', 'script', 'editorStyle', 'style' );
+
+                foreach ( $props as $prop ) {
+                    if ( isset( $block->$prop ) ) {
+                        $assets[ $prop ] = $block->$prop;
+                    }
+                }
+                return $assets;
+            },
+            $this->blocks
+        );
 
         return $block_scripts;
@@ -479 +484 @@
 
     /**
-     * Do the blocks all have available script assets, either discoverable or in the block.json file?
-     */
-    function check_for_block_scripts() {
-        $block_scripts = $this->find_block_scripts();
-
-        foreach ( $this->blocks as $block_name => $block_info ) {
-            if ( ! empty( $block_scripts[ $block_name ] ) ) {
-                $this->record_result(
-                    __FUNCTION__,
-                    'info',
-                    // translators: %s is the block name.
-                    sprintf( __( 'Scripts found for block %s.', 'wporg-plugins' ), '<code>' . $block_name . '</code>' ),
-                    $block_scripts[ $block_name ]
-                );
-            } else {
-                $this->record_result(
-                    __FUNCTION__,
-                    'warning',
-                    // translators: %s is the block name.
-                    sprintf( __( 'No scripts found for block %s.', 'wporg-plugins' ), '<code>' . $block_name . '</code>' ),
-                    $block_name
-                );
-            }
-        }
-    }
-
-    /**
      * Check for a single parent block
      */
@@ -544 +522 @@
      */
     function check_for_block_script_files() {
+        $seen_scripts = array();
         foreach ( $this->find_block_scripts() as $block_name => $scripts ) {
-            foreach ( $scripts as $script ) {
-                if ( file_exists( $this->path_to_plugin . $script ) ) {
+            foreach ( $scripts as $kind => $script ) {
+                // No need to warn multiple times for the same value.
+                if ( in_array( $script, $seen_scripts ) ) {
+                    continue;
+                }
+                $seen_scripts[] = $script;
+                $file_path = trailingslashit( $this->path_to_plugin ) . str_replace( 'file:', '', $script );
+                if ( file_exists( $file_path ) ) {
                     $this->record_result(
                         __FUNCTION__,
                         'info',
                         // translators: %s is the block name.
-                        sprintf( __( 'Script file exists for block %s.', 'wporg-plugins' ), '<code>' . $block_name . '</code>' ),
-                        $script
+                        sprintf( __( 'Found file %s.', 'wporg-plugins' ), '<code>' . $script . '</code>' ),
+                        compact( $kind, $script )
                     );
                 } else {
+                    // translators: %s is the file name.
+                    $message = __( 'Expected %s to be a valid file path.', 'wporg-plugins' );
+                    if ( in_array( $kind, array( 'editorScript', 'script' ) ) ) {
+                        // translators: %s is the file name.
+                        $message = __( 'Expected %s to be a valid JavaScript file path.', 'wporg-plugins' );
+                    } else if ( in_array( $kind, array( 'editorStyle', 'style' ) ) ) {
+                        // translators: %s is the file name.
+                        $message = __( 'Expected %s to be a valid CSS file path.', 'wporg-plugins' );
+                    }
                     $this->record_result(
                         __FUNCTION__,
-                        'warning',
-                        // translators: %s is the block name.
-                        sprintf( __( 'Missing script file for block %s.', 'wporg-plugins' ), '<code>' . $block_name . '</code>' ),
-                        $script
+                        'error',
+                        sprintf( $message, '<code>' . $script . '</code>' ),
+                        compact( $kind, $script )
                     );
                 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php

@@ -240 +240 @@
                 return false;
             case 'check_block_tag':
-                return __( 'The readme.txt file must contain the tag "block" for this to be added to the block directory.', 'wporg-plugins' );
+                return __( 'The readme.txt file must contain the tag "block" (singular) for this to be added to the block directory.', 'wporg-plugins' );
             case 'check_for_duplicate_block_name':
                 return [
@@ -254 +254 @@
             case 'check_for_block_json':
                 return __( 'Your plugin should contain at least one <code>block.json</code> file. This file contains metadata describing the block and its JavaScript and CSS assets. Make sure you include at least one <code>script</code> or <code>editorScript</code> item.', 'wporg-plugins' );
-            case 'check_for_block_scripts':
-                return 'TODO';
             case 'check_for_block_script_files':
-                return 'TODO';
+                return [
+                    __( 'The value of <code>script</code>, <code>style</code>, <code>editorScript</code>, <code>editorStyle</code> must be a valid file path. This value was detected, but there is no file at this location in your plugin.', 'wporg-plugins' ),
+                    __( 'Unlike regular blocks, plugins in the block directory cannot use a script handle for these values.', 'wporg-plugins' ),
+                ];
             case 'check_for_register_block_type':
                 return __( 'At least one of your JavaScript files must explicitly call registerBlockType(). Without that call, your block will not work in the editor.', 'wporg-plugins' );
@@ -263 +264 @@
                 return __( 'This block.json file is invalid. The Block Directory needs to be able to read this file.', 'wporg-plugins' );
             case 'check_asset_php_file':
-                return 'TODO'; // Is this really an issue?
+                return __( '', 'wporg-plugins' ); // @todo
             case 'check_php_size':
                 return __( 'Block plugins should keep the PHP code to a mimmum. If you need a lot of PHP code, your plugin probably belongs in the main Plugin Directory rather than the Block Directory.', 'wporg-plugins' );