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

Timestamp:

01/22/2024 01:13:35 AM (2 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-validator.php (modified) (3 diffs)

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(