Skip to content

arunphp29/shopify-debug-engine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

shopify-debug-engine

Lightweight Shopify Debug Dashboard for storefront debugging

Version License

A lightweight, production-safe debugging dashboard for Shopify themes — built to inspect real storefront state without switching to admin.


Preview

Why this exists

Debugging Shopify themes is rarely about fixing code.

It’s about understanding:

  • why data is missing
  • why a section behaves differently across templates
  • why logic silently fails

Instead of jumping between admin, theme files, and console — this dashboard brings everything into one place.


What it does

The Debug Engine runs inside the storefront and exposes:

Context

  • Page type
  • Template detection

Product & Cart

  • Variant state
  • Availability
  • Cart totals

Metafields

  • Product, Collection, Customer, Shop
  • Type-aware rendering

Metaobjects

  • Structured content debugging

Sections & Blocks

  • Active blocks
  • Empty section detection

Logic Signals

COMING SOON


Installation

  1. Add snippets:

/snippets/dev-dashboard.liquid

  1. Include in theme.liquid before closing body:

{% render 'dev-dashboard' %}

  1. Enable debug mode:

?debug=1 or in editor mode in admin

Quick Demo

Open any page and add:

?debug=1

The dashboard will appear in the bottom-right corner showing live store data and issues.


Learn More

For a deeper breakdown of the approach and patterns:

👉 https://www.linkedin.com/pulse/shopify-theme-debugging-2

👉 https://www.linkedin.com/pulse/shopify-theme-debugging


Debug Engine (Key Feature)

Instead of just showing data, it detects issues:

Examples:

  • ⚠ Missing metafield used in UI
  • ⚠ Variant unavailable but button active
  • ⚠ Empty section after merchant edit
  • ⚠ Template and object mismatch

This turns debugging from guessing into visibility.


Safety

  • Hidden by default
  • Works on live stores
  • No frontend impact
  • No dependency on apps

Use Cases

  • Debugging metafields not rendering
  • Understanding section behavior across templates
  • Verifying cart and product state
  • Identifying silent logic failures

Future Improvements

  • Severity-based issue detection
  • Namespace auto-detection
  • Variant-level debugging
  • UI enhancements

Contributing

Feel free to fork, extend, or adapt for your own workflow.


License

MIT

About

Lightweight Shopify Debug Dashboard for storefront debugging

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages