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

Timestamp:

01/22/2024 01:13:35 AM (3 years 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.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php (modified) (5 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'] ) ) {