improvement: Updated generate-readme.sh to check for missing fields

jordantrizz · jordantrizz · commit 5b7277f34560 · 2025-07-16T09:56:27.000-04:00
Require version to be a field
Added plugin powerkit-svg-lazyload-fix.php
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,10 @@
 * Updated disable-checkout-and-limit-login.php to be disabled via define('WP_MAINTENANCE_MODE', true);
 
 
+## Release 1.4.1
+* Updated disable-checkout-and-limit-login.php to be disabled via define('WP_MAINTENANCE_MODE', true);
+
+
 ## Release 1.4.0
 * Added disable-checkout-and-limit-login.php
 
diff --git a/README-snippets.md b/README-snippets.md
diff --git a/README.md b/README.md
diff --git a/acf/acf-pull-contact-form-name-ids.php b/acf/acf-pull-contact-form-name-ids.php
@@ -1,7 +1,8 @@
 <?
 /**
- * acf-pull-contact-form-name-ids.php
+ * Plugin Name: ACF Pull Contact Form Name IDs into Select Field
  * Description: Pull Contact Form 6 form name and ID's into a select field called form_id dynamically.
+ * Version: 1.0.0
  * Type: snippet
  * Status: Complete
  **/
diff --git a/admin/change-admin-email.php b/admin/change-admin-email.php
@@ -2,6 +2,7 @@
 /**
  * Plugin Name: Change Admin Email
  * Description: Changes the admin email address if it hasn't been changed already without triggering email validation.
+ * Version: 1.0.0
  * Type: mu-plugin
  * Status: Complete
 */
diff --git a/admin/disable-checkout-and-limit-login.php b/admin/disable-checkout-and-limit-login.php
@@ -2,6 +2,7 @@
 /**
  * Plugin Name: Disable WooCommerce Checkout & Restrict Logins to Admins
  * Description: Disables WooCommerce checkout and blocks login for all users except administrators.
+ * Version: 1.0.0
  * Type: mu-plugin
  * Status: Complete
 */
diff --git a/admin/log-admin-notices.php b/admin/log-admin-notices.php
@@ -1,7 +1,8 @@
 <?php
 /**
- * log-admin-notices.php
+ * Plugin Name: Log Admin Notices
  * Description: Log's admin notices on admin_init, great for finding admin_notices to hide.
+ * Version: 1.0.0
  * Type: snippet
  * Status: Complete
 */
diff --git a/admin/mu-dashboard-shortcode.php b/admin/mu-dashboard-shortcode.php
@@ -1,7 +1,8 @@
 <?php
 /**
- * mu-dashboard-shortcode.php
- * Description: Unsure what the usage of this snippet is.
+ * Plugin Name: Menu Shortcode
+ * Description: Adds a shortcode to output the dashboard link.
+ * Version: 1.0.0
  * Type: snippet
  * Status: WIP
  */
diff --git a/ajaxlog/ajaxlog.php b/ajaxlog/ajaxlog.php
@@ -4,6 +4,7 @@
  * Description: Record all admin_init requests to troubleshoot high admin-ajax.php requests.
  * Plugin Name: Ajax Logger
  * Plugin URI: https://managingwp.io
+ * Version: 1.0.0
  * Status: Complete
 **/
 
diff --git a/caching/disable-lscache-notice.php b/caching/disable-lscache-notice.php
@@ -2,6 +2,7 @@
 /**
  * disable-lscache-notice.php
  * Description: Disables the admin notice Litespeeds LSCache generates about conflicting plugins installed
+ * Version: 1.0.0
  * Type: snippet
  * Status: WIP
 
diff --git a/caching/disable-plugin-updates.php b/caching/disable-plugin-updates.php
@@ -2,6 +2,7 @@
 /**
  * disable-plugin-updates.php
  * Description: Remove plugin update notices
+ * Version: 1.0.0
  * Type: snippet
  * Status: Complete
  **/
diff --git a/caching/nginx-gravity-forms-stripe-cache-exclude.php b/caching/nginx-gravity-forms-stripe-cache-exclude.php
@@ -2,6 +2,7 @@
 /**
  * nginx-gravity-forms-stripe-cache-exclude.php
  * Description: Exclude Gravity Forms or Stripe from caching
+ * Version: 1.0.0
  * Type: snippet
  * Status: Complete
  * 
diff --git a/caching/nginx-helper-purge-schedule.php b/caching/nginx-helper-purge-schedule.php
@@ -2,6 +2,7 @@
 /**
  * nginx-helper-purge-schedule.php
  * Description: Purge NGINX cache when a scheduled post is published
+ * Version: 1.0.0
  * Type: snippet
  * Status: Complete
  */
diff --git a/core/enable-core-updates-version-control.php b/core/enable-core-updates-version-control.php
@@ -2,6 +2,7 @@
 /**
  * enable-core-updates-version-control.php
  * Description: Filters whether the automatic updater should consider a filesystem location to be potentially managed by a version control system.
+ * Version: 1.0.0
  * Status: Complete
  */
 add_filter( 'automatic_updates_is_vcs_checkout', '__return_false', 1 );
diff --git a/debug/log-hook-calls.php b/debug/log-hook-calls.php
@@ -2,6 +2,7 @@
 /**
  * log-hook-calls.php
  * Description: Log all hook calls to a file
+ * Version: 1.0.0
  * Status: Complete
  *
  * Place into wp-content/mu-plugins directory and log all hook calls
diff --git a/debug/show-browser-cookies.php b/debug/show-browser-cookies.php
@@ -2,6 +2,7 @@
 /** 
  * show-browser-cookies.php
  * Description Shows your browsers cookies
+ * Version: 1.0.0
  * Type: snippet
  * Status: Complete
  */
diff --git a/development/staging-environment.php b/development/staging-environment.php
@@ -2,6 +2,7 @@
 /**
  * staging-environment.php
  * Description: This snippet will enable and disable plugins based on the WP_ENVIRONMENT_TYPE 
+ * Version: 1.0.0
  * Type: Snippet
  * Status: Complete
  * 
diff --git a/generate-readme.sh b/generate-readme.sh
@@ -2,6 +2,14 @@
 # Generate README.md
 # Usage: ./generate-readme.sh
 
+# Initialize warning counters
+MISSING_PLUGIN_NAME=0
+MISSING_TYPE=0
+MISSING_STATUS=0
+MISSING_DESCRIPTION=0
+MISSING_VERSION=0
+TOTAL_FILES=0
+
 # Get all directories in the current directory
 DIRECTORIES=$(find . -mindepth 1 -maxdepth 1 -type d)
 README_SNIPPETS_FILE="README-snippets.md"
@@ -18,25 +26,42 @@ for DIRECTORY in $DIRECTORIES; do
     DIRECTORY_NAME=$(basename $DIRECTORY)
     echo "## [$DIRECTORY_NAME]($DIRECTORY_NAME)" >> $README_SNIPPETS_FILE
     echo "" >> $README_SNIPPETS_FILE
-    echo "| Title | Type | Status | Description |" >> $README_SNIPPETS_FILE
-    echo "| ----- | ---- | ------ | ----------- |" >> $README_SNIPPETS_FILE
+    echo "| Title | Version | Type | Status | Description |" >> $README_SNIPPETS_FILE
+    echo "| ----- | ------- | ---- | ------ | ----------- |" >> $README_SNIPPETS_FILE
     for FILE in $DIRECTORY/*.php; do
         FILE_NAME=$(basename $FILE)
-        if [ "$FILE_NAME" != "README.md" ] && [ "$FILE_NAME" != "$README_SNIPPETS_FILE" ]; then            
+        if [ "$FILE_NAME" != "README.md" ] && [ "$FILE_NAME" != "$README_SNIPPETS_FILE" ]; then
+            TOTAL_FILES=$((TOTAL_FILES + 1))
+            
             # -- Title
             TITLE=$(grep -i "Plugin Name:" "$FILE" | tail -n 1 | sed 's/ \* Plugin Name: //')
             if [[ -z "$TITLE" ]]; then
                 TITLE="$FILE_NAME"
+                echo "⚠️  Warning: No 'Plugin Name:' found in $FILE - using filename as title"
+                MISSING_PLUGIN_NAME=$((MISSING_PLUGIN_NAME + 1))
+            fi
+
+            # -- Version
+            VERSION=$(grep -i "Version:" "$FILE" | tail -n 1 | sed 's/ \* Version: //')
+            if [[ -z "$VERSION" ]]; then
+                VERSION="Unknown"
+                echo "⚠️  Warning: No 'Version:' found in $FILE"
+                MISSING_VERSION=$((MISSING_VERSION + 1))
             fi
 
             # -- Type
             TYPE=$(grep -i "Type:" "$FILE" | tail -n 1 | sed 's/ \* Type: //')
+            if [[ -z "$TYPE" ]]; then
+                echo "⚠️  Warning: No 'Type:' found in $FILE"
+                MISSING_TYPE=$((MISSING_TYPE + 1))
+            fi
 
             # -- Status
             STATUS=$(grep -i "Status:" "$FILE" | tail -n 1 | sed 's/ \* Status: //')
             if [[ -z $STATUS ]]; then
                 STATUS="Unknown"
-                echo "Warning: No status found for $FILE"
+                echo "⚠️  Warning: No 'Status:' found in $FILE"
+                MISSING_STATUS=$((MISSING_STATUS + 1))
             fi
             # -- Set Status emoji
             if [[ $STATUS == "Complete" ]]; then
@@ -53,29 +78,55 @@ for DIRECTORY in $DIRECTORIES; do
             DESCRIPTION=$(grep " * Description" "$FILE" | tail -n 1 | sed 's/ \* Description: //')
             if [[ -z "$DESCRIPTION" ]]; then
                 DESCRIPTION="No description"
-                echo "Warning: No description found for $FILE"
+                echo "⚠️  Warning: No 'Description:' found in $FILE"
+                MISSING_DESCRIPTION=$((MISSING_DESCRIPTION + 1))
             fi
 
             # -- Set default values for plugins
             if [[ -z $TYPE && -n $TITLE ]]; then
-                TYPE="Plugin"                
+                TYPE="Plugin"
+                echo "ℹ️  Info: Setting default type 'Plugin' for $FILE"
             fi
             if [[ -z $TYPE && -z $TITLE ]]; then
                 TYPE="Unknown"
-                echo "Warning: No type found for $FILE"
+                echo "⚠️  Warning: No type or title found for $FILE - setting both to 'Unknown'"
             fi
             
-            echo "| [$TITLE]($FILE) | $TYPE | $STATUS | $DESCRIPTION |" >> $README_SNIPPETS_FILE
+            echo "| [$TITLE]($FILE) | $VERSION | $TYPE | $STATUS | $DESCRIPTION |" >> $README_SNIPPETS_FILE
         fi
     done
     echo "" >> $README_SNIPPETS_FILE
 done
 
 # -- Generate CHANGELOG.md
 echo "# Changelog" > CHANGELOG.md
-git log --pretty=format:"## %s%n%b%n" | sed '/^## /b; /^[[:space:]]*$/b; s/^/* /' >> CHANGELOG.md
+git log --pretty=format:"## %s%n%b%n" | sed '/^## /!{ /^[[:space:]]*$/!s/^/* /; }' >> CHANGELOG.md
 
 # Generate README.md
 cat README-header.md $README_SNIPPETS_FILE CHANGELOG.md > README.md
 
+# Print summary
+echo ""
+echo "📊 Generation Summary:"
+echo "===================="
+echo "Total PHP files processed: $TOTAL_FILES"
+echo "Files missing Plugin Name: $MISSING_PLUGIN_NAME"
+echo "Files missing Version: $MISSING_VERSION"
+echo "Files missing Type: $MISSING_TYPE"
+echo "Files missing Status: $MISSING_STATUS"
+echo "Files missing Description: $MISSING_DESCRIPTION"
+
+if [[ $MISSING_PLUGIN_NAME -gt 0 || $MISSING_VERSION -gt 0 || $MISSING_TYPE -gt 0 || $MISSING_STATUS -gt 0 || $MISSING_DESCRIPTION -gt 0 ]]; then
+    echo ""
+    echo "🔧 To fix warnings, add the following to your PHP file headers:"
+    echo "   * Plugin Name: Your Plugin Name"
+    echo "   * Version: 1.0.0"
+    echo "   * Type: mu-plugin|plugin|script|etc"
+    echo "   * Status: Complete|WIP|Broken"
+    echo "   * Description: Brief description of what this does"
+else
+    echo ""
+    echo "✅ All files have complete metadata!"
+fi
+
 
diff --git a/mail/wp-mail-log-to-file.php b/mail/wp-mail-log-to-file.php
@@ -2,6 +2,7 @@
 /**
  * wp-mail-log-to-file.php
  * Description: Log wp_mail function to a file
+ * Version: 1.0.0
  * Status: Complete
  *
  * Place into wp-content/mu-plugins directory and log the wp_mail function and data
diff --git a/mail/wp-mail-test.php b/mail/wp-mail-test.php
@@ -2,6 +2,7 @@
 /**
  * wp-mail-test.php
  * Description: Used to send a test email to test the wp_mail function.
+ * Version: 1.0.0
  * Status: Complete
  * 
  * Visit the media upload section to trigger the email.
diff --git a/maintenance/wp-maintenance-mode.php b/maintenance/wp-maintenance-mode.php
@@ -2,6 +2,7 @@
 /**
  * wp-maintenance-mode.php
  * Description: Maintenance mode for WordPress - Originally from https://wordpress.stackexchange.com/questions/398037/maintenance-mode-excluding-site-administrators
+ * Version: 1.0.0
  * Status: Complete
  */
 
diff --git a/maintenance/wp-maintenance-mode2.php b/maintenance/wp-maintenance-mode2.php
@@ -2,6 +2,7 @@
 /**
  * wp-maintenance-mode2.php
  * Description: This plugin displays a maintenance message for non-administrative users.
+ * Version: 1.0.0
  * Status: Complete
  */
 
diff --git a/monitoring/betteruptime-heartbeat.php b/monitoring/betteruptime-heartbeat.php
@@ -2,6 +2,7 @@
 /**
  * betteruptime-heartbeat.php
  * Description: Monitor WordPress cron via Better Uptime heartbeat checks. Originally from https://www.sprucely.net/knowledge-base/monitoring-wordpress-cron-via-heartbeat-checks/
+ * Version: 1.0.0
  * Status: Complete
  * 
  * Add define( 'BETTERUPTIME_CRON_MONITOR_KEY', 'SXuNXxHWREsstjnXrBMhNx3B' ); to wp-config.php
diff --git a/multisite/sunrise-subdomain-to-subdirectory-mapping.php b/multisite/sunrise-subdomain-to-subdirectory-mapping.php
@@ -2,7 +2,7 @@
 /**
  * sunrise-subdomain-to-subdirectory-mapping.php
  * Description: Redirect domain names to multisite subdirectories and include query arguments in the redirect.
- * Status: Complete
+ * Version: 1.0.0
  * Status: Complete
  * 
  * You must have the domain name setup on your hosting account, typically as a addon domain or domain alias.
diff --git a/plugins/powerkit-svg-lazyload-fix.php b/plugins/powerkit-svg-lazyload-fix.php
diff --git a/plugins/redirection-search-replace.php b/plugins/redirection-search-replace.php
diff --git a/tests/check-ports.php b/tests/check-ports.php
diff --git a/theme/post-title-permalink.php b/theme/post-title-permalink.php
diff --git a/woocommerce/woocommerce-hide-costofgoodssold-metadata.php b/woocommerce/woocommerce-hide-costofgoodssold-metadata.php
diff --git a/woocommerce/woocommerce-order-search-in-admin-bar.php b/woocommerce/woocommerce-order-search-in-admin-bar.php
diff --git a/woocommerce/woocommerce-wc_product_loop_transient-expiration-to-1-day.php b/woocommerce/woocommerce-wc_product_loop_transient-expiration-to-1-day.php
diff --git a/wp-failover/wp-failover.php b/wp-failover/wp-failover.php
