Changeset 13133

Timestamp:

01/22/2024 01:13:35 AM (15 months ago)

Author:

dd32

Message:

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 #7412.

Location:

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

Files:

• class-parser.php (modified) (5 diffs)
• class-validator.php (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php

@@ -145 +145 @@
      * @var array
      */
-    private $ignore_tags = array(
+    public $ignore_tags = array(
         'plugin',
         'wordpress',
@@ -226 +226 @@
         // Handle readme's which do `=== Plugin Name ===\nMy SuperAwesomePlugin Name\n...`
         if ( 'plugin name' == strtolower( $this->name ) ) {
+            $this->warnings['invalid_plugin_name_header'] = true;
+
             $this->name = $line = $this->get_first_nonwhitespace( $contents );
 
@@ -274 +276 @@
             $this->tags = array_map( 'trim', $this->tags );
             $this->tags = array_filter( $this->tags );
-            $this->tags = array_diff( $this->tags, $this->ignore_tags );
-            $this->tags = array_slice( $this->tags, 0, 5 );
+            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;
+            }
         }
         if ( ! empty( $headers['requires'] ) ) {
@@ -409 +417 @@
         if ( ! $this->short_description && ! empty( $this->sections['description'] ) ) {
             $this->short_description = array_filter( explode( "\n", $this->sections['description'] ) )[0];
+            $this->warnings['no_short_description_present'] = true;
         }
 
@@ -415 +424 @@
         $this->short_description = $this->parse_markdown( $this->short_description );
         $this->short_description = wp_strip_all_tags( $this->short_description );
-        $this->short_description = $this->trim_length( $this->short_description, 150 );
+        $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;
+        }
 
         if ( isset( $this->sections['screenshots'] ) ) {

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

@@ -72 +72 @@
 
         // Fatal errors.
-        if ( empty( $readme->name ) ) {
+        if ( empty( $readme->name ) || isset( $readme->warnings['invalid_plugin_name_header'] ) ) {
             $errors[] = sprintf(
                 /* translators: 1: 'Plugin Name' section title, 2: 'Plugin Name' */
@@ -145 +145 @@
         }
 
+        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>'
+            );
+        }
+
         // Notes.
         if ( empty( $readme->requires ) ) {
@@ -162 +174 @@
         }
 
+        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>'
+            );
+        }
+
         if ( empty( $readme->sections['faq'] ) ) {
             $notes[] = sprintf(