Static Cache Wrangler – Coverage Assistant

Coverage Assistant is a companion plugin for Static Cache Wrangler that helps you monitor which posts and pages have been cached as static HTML files.

Get instant visibility into your static cache coverage with a modern, card-based dashboard that shows:

• Coverage Percentage – See at a glance what % of your content is cached
• Uncached Content List – Identify exactly which pages need caching
• One-Click Copy Links – Copy uncached URLs to clipboard for manual caching
• GUI Crawler – Interactive browser-based crawler unlocks at 65% coverage
• Cache Statistics – View total files, cache size, and more

Perfect for site owners who want to ensure complete static site generation before deploying to CDN, Amazon S3®, or creating offline copies.

Key Features

• Visual Dashboard – Modern card-based UI with 4 key metrics
• Coverage Cards – Color-coded indicators (green/yellow/red) for quick status checks
• Uncached Content Table – Complete list with page titles, types, and last modified dates
• One-Click Copy Links – Copy uncached URLs to clipboard for manual caching
• GUI Crawler – Interactive browser-based crawler with progress tracking (unlocks at 65% coverage)
• Adaptive Throttling – Smart crawling speed adjusts to your server’s performance
• Recently Cached – See the last 10 pages that were successfully cached
• Auto-Cache Command – Use wp scw crawl-uncached to automatically cache all remaining pages
• WP-CLI Integration – Full command-line interface for coverage monitoring and automation
• Batch Processing – Concurrent crawling with --concurrency flag for faster cache generation
• Export URLs – wp scw uncached-urls outputs URLs for piping to external tools
• Zero Configuration – Works immediately after activation
• Clean Uninstall – Removes all data when plugin is deleted

Requirements

• WordPress 5.0 or higher
• PHP 7.4 or higher
• Static Cache Wrangler 2.0.5+ (parent plugin must be active)

Perfect For

• Site owners deploying to CDN or Amazon S3®
• Developers creating offline-ready static sites
• Agencies managing multiple static WordPress installations
• Anyone who wants to monitor cache generation progress
• Teams ensuring 100% coverage before launch

How It Works

1. Install and activate both Static Cache Wrangler and Coverage Assistant
2. Enable static site generation in Static Cache settings
3. Browse your site normally – pages are cached as you visit them
4. Check the Coverage Assistant dashboard to see progress
5. Use the uncached content list to identify pages that need caching
6. Click “Copy Link” buttons to copy URLs for manual visiting
7. NEW: At 65% coverage, unlock the GUI crawler to batch-process remaining pages
8. Alternative: Use wp scw crawl-uncached CLI command for fastest bulk caching

Additional Information

About the Author

Created by Derick Schaefer – Developer, writer, and WordPress enthusiast.

• Website: ModernCLI.dev
• GitHub: @derickschaefer

Related Plugins

• Static Cache Wrangler – Parent plugin (required)

Planned Features

• Custom post type support
• Multisite compatibility
• Configurable exclusion rules
• Advanced filtering options
• Enhanced reporting and analytics

Contributing

This is an open-source project. Contributions are welcome!

• GitHub Repository: https://github.com/derickschaefer/stcw-assistant
• Submit Issues: https://github.com/derickschaefer/stcw-assistant/issues
• Pull Requests: https://github.com/derickschaefer/stcw-assistant/pulls
• More details and examples: Modern CLI Book

License

This plugin is licensed under the GNU General Public License v2.0 or later.

Copyright (C) 2025 Derick Schaefer

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Trademark Recognition

Amazon S3® is a registered trademark of Amazon Technologies, Inc.

This plugin is not endorsed by, affiliated with, or sponsored by Amazon Technologies, Inc. or any trademark owners mentioned in this documentation.

Privacy Policy

Data Collection

This plugin does not:
* Collect any personal data
* Send data to external servers
* Use cookies or tracking
* Store user information

Data Storage

The plugin does not store any data in the WordPress database. All coverage statistics are calculated in real-time from your existing WordPress posts and pages. No historical data, user information, or statistics are stored.

This data is:
* Stored locally in your WordPress database
* Not shared with any third parties

GDPR Compliance

This plugin is GDPR compliant as it:
* Does not process personal data
* Does not track users
* Does not use cookies
* Stores only aggregate statistics locally

Technical Details

Database Usage

• No WordPress options created or stored
• No custom database tables created
• No database schema modifications
• Queries existing WordPress posts table only (read-only)
• Clean uninstall (nothing to remove)

Performance

• Lightweight – minimal resource usage
• Queries optimized with prepared statements
• No frontend performance impact
• Dashboard-only calculations (not run on frontend)
• GUI crawler uses adaptive throttling to prevent server overload

Security

• All database queries use $wpdb->prepare()
• All output escaped (esc_html, esc_url, esc_attr)
• All input sanitized (sanitize_text_field, sanitize_key, absint)
• Capability checks on all admin functions
• Nonce verification on all form submissions
• AJAX endpoints protected with nonce validation

Compatibility

• WordPress 5.0+
• PHP 7.4, 8.0, 8.1, 8.2, 8.3
• Compatible with all major themes
• Compatible with all major page builders
• Compatible with Static Cache Wrangler 2.0.5+

File Structure

stcw-coverage-assistant/
    stcw-coverage-assistant.php    Main plugin file
    LICENSE                        GPL v2+ license
    readme.txt                     This file
    uninstall.php                  Clean removal script
    includes/
        class-stcwca-core.php      Coverage calculation engine
        class-stcwca-cli.php       WP-CLI commands
        class-stcwca-crawler.php   Shared crawler logic
    admin/
        class-stcwca-admin.php     Admin dashboard controller
        css/
            admin-style.css        Modern UI styling
        js/
            admin-script.js        Copy Link functionality
            crawler.js             GUI crawler with adaptive throttling
        views/
            dashboard.php          Dashboard template

Code Quality

• Follows WordPress Coding Standards
• PHPCS compliant
• Plugin Check compliant
• Proper PHPDoc comments throughout
• Meaningful variable and function names
• DRY principles applied

Interested in learning more about command-line interfaces and WP-CLI?
Check out ModernCLI.dev — a practical guide to mastering modern CLI workflows.

Automatic Installation

1. Log in to your WordPress admin panel
2. Navigate to Plugins > Add New
3. Search for “Static Cache Wrangler – Coverage Assistant”
4. Click Install Now then Activate
5. Ensure Static Cache Wrangler is also installed and activated
6. Navigate to Static Cache > Coverage Assistant

Manual Installation

1. Download the plugin ZIP file
2. Log in to your WordPress admin panel
3. Navigate to Plugins > Add New > Upload Plugin
4. Choose the downloaded ZIP file
5. Click Install Now then Activate
6. Ensure Static Cache Wrangler is also installed and activated
7. Navigate to Static Cache > Coverage Assistant

After Installation

1. Go to Settings > Static Cache and enable static generation
2. Browse your site to generate some cached pages
3. Go to Static Cache > Coverage Assistant to view your dashboard

1. 

   Coverage dashboard showing 28.6% coverage with color-coded metric cards

2. 

   Instructions and available CLI commands for automation and batch processing

3. 

   Cached content passes 65% threshold enabling batch processing in GUI

4. 

   GUI crawler interface with adaptive throttling and progress tracking

1.0.6 – 2025-11-09

New: GUI Crawler + Fixes

• Introduced interactive GUI crawler for browser-based batch caching
• GUI crawler unlocks at 65% coverage (configurable via wp-config.php)
• Adaptive throttling automatically adjusts crawl speed to server performance
• Real-time progress tracking with success/error counts
• Smart delay calculation prevents server overload
• Copy clarifications on multiple UI cards
• Readme updates and corrections
• Removed legacy trend tracking feature (not actively used)

1.0.5 – 2025-11-07

New: WP-CLI Support

• Introduced wp scw CLI commands for coverage management:
  • wp scw coverage – Display current cache stats (table, JSON, CSV, YAML)
  • wp scw uncached – List uncached pages/posts with filtering and formats
  • wp scw uncached-urls – Export uncached URLs for external crawlers
  • wp scw crawl-uncached – Automatically crawl and cache all missing pages
• CLI output includes warning indicators, progress bars, and real-time status
• Ideal for CI/CD pipelines, cron jobs, and batch caching automation
• Extensive format and concurrency options for advanced scripting

1.0.4 – 2025-09-29

Enhancement: File Counting & Cache Stats

• Added display of total cached file count and total content items
• New metric for cache size in MB added to dashboard
• Improved support for custom file paths during coverage analysis
• Admin UI: tooltip hints added to clarify coverage formula

1.0.3 – 2025-08-10

Fixes + Compliance

• Fixed bug with incorrect uncached post count in rare conditions
• Escaped all admin output strings for WordPress.org security compliance
• Removed legacy helper functions and optimized data handling
• Improved compatibility with Static Cache Wrangler 2.0.5

1.0.2 – 2025-06-21

Improvements: Accuracy & Performance

• Refined coverage percentage calculation logic for mixed post statuses
• Added logic to exclude drafts, private posts, and trashed items from stats
• Reduced database queries on the dashboard by ~30% for faster load

1.0.1 – 2025-04-18

Initial Fixes and Minor Enhancements

• Fixed issue where some pages were misidentified as uncached
• Added “Last Cached” timestamp to recently cached list
• Adjusted color thresholds for coverage indicators (green/yellow/red)
• Internal refactoring of coverage engine for extensibility
• Minor styling tweaks for better mobile admin view

1.0.0 – 2025-01-15

Initial Release

• Coverage percentage calculation and display
• Uncached content identification and listing
• Recently cached content display
• Modern card-based dashboard UI
• Color-coded status indicators (green/yellow/red)
• One-click “Copy Link” buttons for uncached pages
• Quick actions sidebar
• WordPress.org coding standards compliance
• Clean uninstall support
• Full i18n/translation readiness