Changeset 10066

Timestamp:

07/13/2020 08:19:33 PM (5 years ago)

Author:

ryelle

Message:

Plugin Directory: Add a check for block name standards

This will flag as errors any block names that would not register in the editor (using the same regex). It also checks for some common block starter content namespaces, to ensure names are unique across the repo (as warnings).

See #5303

Location:

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

Files:

• cli/class-block-plugin-checker.php (modified) (1 diff)
• shortcodes/class-block-validator.php (modified) (1 diff)

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

@@ -439 +439 @@
                         [ 'block_name' => $block->name, 'slug' => $post->post_name ]
                     );
+                }
+            }
+        }
+    }
+
+    /**
+     * Does the block name follow expected naming conventions
+     */
+    function check_for_standard_block_name() {
+        foreach ( $this->blocks as $block ) {
+            if ( ! trim( strval( $block->name ) ) ) {
+                continue;
+            }
+            if ( ! preg_match( '/^[a-z][a-z0-9-]*\/[a-z][a-z0-9-]+$/', $block->name ) ) {
+                $this->record_result(
+                    __FUNCTION__,
+                    'error',
+                    // translators: %s is the block name.
+                    sprintf( __( 'Block name %s is invalid. Please use lowercase alphanumeric characters.', 'wporg-plugins' ), '<code>' . $block->name . '</code>' )
+                );
+            } else {
+                $disallowed_ns = array( 'cgb/', 'create-block/', 'example/', 'block/', 'core/' );
+                foreach ( $disallowed_ns as $ns ) {
+                    if ( 0 === strpos( $block->name, $ns ) ) {
+                        $this->record_result(
+                            __FUNCTION__,
+                            'warning',
+                            sprintf(
+                                // translators: %1$s is the block name, %2$s is the namespace.
+                                __( 'Block %1$s uses namespace %2$s. Please use a unique namespace.', 'wporg-plugins' ),
+                                '<code>' . $block->name . '</code>',
+                                '<code>' . $ns . '</code>'
+                            )
+                        );
+                        break;
+                    }
                 }
             }

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

@@ -271 +271 @@
             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' );
+            case 'check_for_standard_block_name':
+                return [
+                    __( 'Block names must contain a namespace prefix, include only lowercase alphanumeric characters or dashes, and start with a letter. The namespace should be unique to your block plugin, make sure to change any defaults from block templates like "create-block/" or "cgb/".', 'wporg-plugins' ),
+                    __( 'Example: <code>my-plugin/my-custom-block</code>', 'wporg-plugins' ),
+                ];
         }
     }