<!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>[13133] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme: Plugin Directory: Readme: Expand the number of warnings generated by the Readme parser.</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/13133">13133</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/13133","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-01-22 01:13:35 +0000 (Mon, 22 Jan 2024)</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: Readme: Expand the number of warnings generated by the Readme parser.
This will allow for tools which reuse it to detect and warn about more invalid cases.
Props dd32, rabmalin, mukesh27.
Closes https://github.com/WordPress/wordpress.org/pull/190.
Fixes <a href="http://meta.trac.wordpress.org/ticket/7412">#7412</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassparserphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassvalidatorphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassparserphp"></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/readme/class-parser.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/readme/class-parser.php 2024-01-22 00:51:02 UTC (rev 13132)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php 2024-01-22 01:13:35 UTC (rev 13133)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,7 +144,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- private $ignore_tags = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $ignore_tags = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'plugin',
</span><span class="cx" style="display: block; padding: 0 10px"> 'wordpress',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -225,6 +225,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Handle readme's which do `=== Plugin Name ===\nMy SuperAwesomePlugin Name\n...`
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'plugin name' == strtolower( $this->name ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->warnings['invalid_plugin_name_header'] = true;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->name = $line = $this->get_first_nonwhitespace( $contents );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Ensure that the line read wasn't an actual header or description.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -273,8 +275,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->tags = explode( ',', $headers['tags'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->tags = array_map( 'trim', $this->tags );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->tags = array_filter( $this->tags );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->tags = array_diff( $this->tags, $this->ignore_tags );
- $this->tags = array_slice( $this->tags, 0, 5 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( array_intersect( $this->tags, $this->ignore_tags ) ) {
+ $this->tags = array_diff( $this->tags, $this->ignore_tags );
+ $this->warnings['ignored_tags'] = true;
+ }
+ if ( count( $this->tags ) > 5 ) {
+ $this->tags = array_slice( $this->tags, 0, 5 );
+ $this->warnings['too_many_tags'] = true;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $headers['requires'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->requires = $this->sanitize_requires_version( $headers['requires'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -408,6 +416,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Use the first line of the description for the short description if not provided.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $this->short_description && ! empty( $this->sections['description'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->short_description = array_filter( explode( "\n", $this->sections['description'] ) )[0];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->warnings['no_short_description_present'] = true;
</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"> // Sanitize and trim the short_description to match requirements.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -414,7 +423,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->short_description = $this->sanitize_text( $this->short_description );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->short_description = $this->parse_markdown( $this->short_description );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->short_description = wp_strip_all_tags( $this->short_description );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->short_description = $this->trim_length( $this->short_description, 150 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $short_description = $this->trim_length( $this->short_description, 150 );
+ if ( $short_description !== $this->short_description ) {
+ if ( empty( $this->warnings['no_short_description_present'] ) ) {
+ $this->warnings['trimmed_short_description'] = true;
+ }
+ $this->short_description = $short_description;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $this->sections['screenshots'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> preg_match_all( '#<li>(.*?)</li>#is', $this->sections['screenshots'], $screenshots, PREG_SET_ORDER );
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassvalidatorphp"></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/readme/class-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/readme/class-validator.php 2024-01-22 00:51:02 UTC (rev 13132)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php 2024-01-22 01:13:35 UTC (rev 13133)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -71,7 +71,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $errors = $warnings = $notes = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Fatal errors.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $readme->name ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $readme->name ) || isset( $readme->warnings['invalid_plugin_name_header'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $errors[] = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: 1: 'Plugin Name' section title, 2: 'Plugin Name' */
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'We cannot find a plugin name in your readme. Plugin names look like: %1$s. Please change %2$s to reflect the actual name of your plugin.', 'wporg-plugins' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,6 +144,18 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $readme->warnings['too_many_tags'] ) ) {
+ $warnings[] = __( 'One or more tags were ignored. Please limit your plugin to 5 tags.', 'wporg-plugins' );
+ }
+
+ if ( isset( $readme->warnings['ignored_tags'] ) ) {
+ $warnings[] = sprintf(
+ /* translators: %s: list of tags not supported */
+ __( 'One or more tags were ignored. The following tags are not permitted: %s', 'wporg-plugins' ),
+ '<code>' . implode( '</code>, <code>', $readme->ignore_tags ) . '</code>'
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Notes.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $readme->requires ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $notes[] = sprintf(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -161,6 +173,20 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $readme->warnings['no_short_description_present'] ) ) {
+ $notes[] = sprintf(
+ /* translators: %s: section title */
+ __( 'The %s section is missing. An excerpt was generated from your main plugin description.', 'wporg-plugins' ),
+ '<code>Short Description</code>'
+ );
+ } elseif( isset( $readme->warnings['trimmed_short_description'] ) ) {
+ $notes[] = sprintf(
+ /* translators: %s: section title */
+ __( 'The %s section is too long and was truncated. A maximum of 150 characters is supported.', 'wporg-plugins' ),
+ '<code>Short Description</code>'
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $readme->sections['faq'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $notes[] = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: section title */
</span></span></pre>
</div>
</div>
</body>
</html>