<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[10058] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory: Plugin Directory: Update block.json file checks in block checker</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/10058">10058</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/10058","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ryelle</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-10 21:28:14 +0000 (Fri, 10 Jul 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="http://meta.trac.wordpress.org/ticket/5303">#5303</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassblockplugincheckerphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassblockvalidatorphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassblockplugincheckerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php 2020-07-10 20:28:56 UTC (rev 10057)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php 2020-07-10 21:28:14 UTC (rev 10058)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -274,16 +274,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function find_block_scripts() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $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;
- }
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_scripts = \array_map(
+ function( $block ) {
+ $assets = array();
+ $props = array( 'editorScript', 'script', 'editorStyle', 'style' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $props as $prop ) {
+ if ( isset( $block->$prop ) ) {
+ $assets[ $prop ] = $block->$prop;
+ }
+ }
+ return $assets;
+ },
+ $this->blocks
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $block_scripts;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -478,33 +483,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 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
- );
- }
- }
- }
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Check for a single parent block
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function check_for_single_parent() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -543,23 +521,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Do the script files all exist?
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function check_for_block_script_files() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $seen_scripts = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $this->find_block_scripts() as $block_name => $scripts ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $scripts as $script ) {
- if ( file_exists( $this->path_to_plugin . $script ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->record_result(
</span><span class="cx" style="display: block; padding: 0 10px"> __FUNCTION__,
</span><span class="cx" style="display: block; padding: 0 10px"> 'info',
</span><span class="cx" style="display: block; padding: 0 10px"> // translators: %s is the block name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- sprintf( __( 'Script file exists for block %s.', 'wporg-plugins' ), '<code>' . $block_name . '</code>' ),
- $script
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sprintf( __( 'Found file %s.', 'wporg-plugins' ), '<code>' . $script . '</code>' ),
+ compact( $kind, $script )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->record_result(
</span><span class="cx" style="display: block; padding: 0 10px"> __FUNCTION__,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'warning',
- // translators: %s is the block name.
- sprintf( __( 'Missing script file for block %s.', 'wporg-plugins' ), '<code>' . $block_name . '</code>' ),
- $script
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'error',
+ sprintf( $message, '<code>' . $script . '</code>' ),
+ compact( $kind, $script )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassblockvalidatorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php 2020-07-10 20:28:56 UTC (rev 10057)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php 2020-07-10 21:28:14 UTC (rev 10058)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,7 +239,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> case 'check_block_json_is_valid':
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> case 'check_block_tag':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return __( 'The readme.txt file must contain the tag "block" for this to be added to the block directory.', 'wporg-plugins' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return __( 'The readme.txt file must contain the tag "block" (singular) for this to be added to the block directory.', 'wporg-plugins' );
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'check_for_duplicate_block_name':
</span><span class="cx" style="display: block; padding: 0 10px"> return [
</span><span class="cx" style="display: block; padding: 0 10px"> __( "Block names must be unique, otherwise it can cause problems when using the block. It is recommended to use your plugin's name as the namespace.", 'wporg-plugins' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -253,16 +253,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ];
</span><span class="cx" style="display: block; padding: 0 10px"> case 'check_for_block_json':
</span><span class="cx" style="display: block; padding: 0 10px"> 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' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- case 'check_for_block_scripts':
- return 'TODO';
</del><span class="cx" style="display: block; padding: 0 10px"> case 'check_for_block_script_files':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return 'TODO';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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' ),
+ ];
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'check_for_register_block_type':
</span><span class="cx" style="display: block; padding: 0 10px"> 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' );
</span><span class="cx" style="display: block; padding: 0 10px"> case 'check_block_json_is_valid_json':
</span><span class="cx" style="display: block; padding: 0 10px"> return __( 'This block.json file is invalid. The Block Directory needs to be able to read this file.', 'wporg-plugins' );
</span><span class="cx" style="display: block; padding: 0 10px"> case 'check_asset_php_file':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return 'TODO'; // Is this really an issue?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return __( '', 'wporg-plugins' ); // @todo
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'check_php_size':
</span><span class="cx" style="display: block; padding: 0 10px"> 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' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>