https://github.com/sidworks-dev/sw-plugin-devtools
Template inspector for Shopware 6. Instantly reveals the exact Twig source behind any storefront element and opens it in your IDE with one click.
https://github.com/sidworks-dev/sw-plugin-devtools
shopware6 shopware6-plugin
Last synced: 4 months ago
JSON representation
Template inspector for Shopware 6. Instantly reveals the exact Twig source behind any storefront element and opens it in your IDE with one click.
- Host: GitHub
- URL: https://github.com/sidworks-dev/sw-plugin-devtools
- Owner: sidworks-dev
- License: mit
- Created: 2025-11-17T18:38:21.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-02-15T00:27:45.000Z (4 months ago)
- Last Synced: 2026-02-15T00:52:22.761Z (4 months ago)
- Topics: shopware6, shopware6-plugin
- Language: JavaScript
- Homepage: https://www.sidworks.nl/
- Size: 15.3 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-shopware6 - Template inspector for Shopware 6
README
# Sidworks DevTools for Shopware 6
Never hunt for a Twig file again. Sidworks DevTools reveals the exact template and block behind every Shopware 6 element and lets you jump straight into your IDE with a single click. It also includes a optimised storefront watcher.
## Features
### Shopware Plugin
- **Smart Template Tracking**: Automatically tracks every Twig block with detailed metadata (template name, file path, line number, parent template)
- **HTML Markers**: Injects lightweight HTML comments (``) to map elements to their source templates
- **Intelligent Line Detection API**: Backend endpoint that searches template files to find the exact line of your selected element (not just the block start)
- **Security First**: Only active in debug mode (`APP_ENV=dev`) with configurable on/off switch
- **Zero Production Impact**: Completely disabled in production environments
### [Chrome extension](https://github.com/sidworks-dev/sw-plugin-devtools-chrome-extension)
- **DevTools Sidebar Integration**: Adds a "Shopware" panel in Chrome's Elements sidebar
- **Instant Template Info**: Select any element to see its template, block name, file path, and inheritance chain
- **Smart IDE Integration**: One-click to open templates at the exact line in PHPStorm or VSCode
- **Intelligent Line Search**: Automatically finds the precise element line by searching for classes, IDs, and tags
- **Multi-Editor Support**: Works with PHPStorm and VSCode
### Optimized Storefront Watcher
- **One command start**: `bin/console sidworks:watch-storefront`
- **Theme picker by default**: Choose theme + domain directly in the terminal
- **Fast feedback**: Live SCSS updates with readable JS/Twig/SCSS logs
- **Simple toggles**: `--no-js`, `--no-twig`, `--no-scss`
## Requirements
- Shopware 6.6.x or 6.7.x
- PHP 8.1 or higher
- Chrome or Edge browser (for extension)
- Node.js 20+ (required for storefront watcher)
- [Bun](https://bun.sh) optional (set `SHOPWARE_STOREFRONT_WATCH_PM=bun` to use it)
## Installation
### Plugin Installation
#### Via Composer (Recommended)
```bash
composer require sidworks/sw-plugin-devtools --dev
bin/console plugin:refresh
bin/console plugin:install --activate SidworksDevTools
bin/console cache:clear
```
#### Manual Installation
1. Clone or download this repository to `custom/plugins/SidworksDevTools`
2. Run the following commands:
```bash
bin/console plugin:refresh
bin/console plugin:install --activate SidworksDevTools
bin/console cache:clear
```
### Chrome Extension Installation
1. Download [Chrome extension](https://github.com/sidworks-dev/sw-plugin-devtools-chrome-extension)
2. Open Chrome and navigate to `chrome://extensions/`
3. Enable **Developer mode** (toggle in top right)
4. Click **Load unpacked**
5. Select the extension directory
6. The extension icon will appear in your toolbar
## Configuration
### Plugin Configuration
1. Ensure Shopware is running in debug mode: set `APP_ENV=dev` in your `.env` file
2. (Optional) Navigate to **Settings** → **System** → **Plugins** in Shopware admin
3. Find **Sidworks DevTools** and click **Configuration** to enable/disable
### Extension Configuration
1. Click the extension icon and select **Options**
2. Set your **Project Path** (e.g., `/Users/yourname/Projects/shopware`)
3. Choose your preferred **Editor** (PHPStorm or VSCode)
4. Enable/disable **IDE Integration**
The project path should be the absolute path to your Shopware root directory.
**Tip for Docker/DDEV users**: Add the `PROJECT_PATH` environment variable to your `docker-compose.yml` or `.ddev/config.yaml`:
```yaml
web_environment:
- PROJECT_PATH=/Users/yourname/Development/your-shopware-project
```
The plugin will automatically inject this path into the page, so you don't need to manually configure it in the extension options.
## Usage
### Storefront Watcher (`sidworks:watch-storefront`)
Run from your project root:
```bash
bin/console sidworks:watch-storefront
```
What this gives you:
- Interactive theme/domain selection by default
- Fast defaults for day-to-day storefront work
- Clear terminal output with `[SCSS]`, `[TWIG]`, and `[JS]` log tags
Common toggles:
```bash
bin/console sidworks:watch-storefront --no-js
bin/console sidworks:watch-storefront --no-twig
bin/console sidworks:watch-storefront --no-scss
```
Theme selection shortcuts:
```bash
bin/console sidworks:watch-storefront --theme-name=QsoTheme
bin/console sidworks:watch-storefront --theme-id=018e94f67ba2719da036725041793f30 --domain-url=https://carclean.ddev.site/nl
bin/console sidworks:watch-storefront --pick-theme
```
`--domain-url` requires `--theme-id` (or use `--pick-theme` for interactive theme + domain selection).
### Template Inspector — Basic Workflow
1. **Enable debug mode** in Shopware (`.env`: `APP_ENV=dev`)
2. **Install both** the plugin and [Chrome extension](https://github.com/sidworks-dev/sw-plugin-devtools-chrome-extension)
3. **Visit your storefront** in Chrome
4. **Open DevTools** (F12 or right-click → Inspect)
5. **Select any element** in the Elements panel
6. **View template info** in the "Shopware" sidebar on the right
7. **Click the IDE link** to jump directly to the template file at the exact line
### What You'll See
When you inspect an element, the sidebar shows:
- **Template Type**: Page, Component, or Utility
- **Block Name**: The Twig block that rendered this element
- **Template Path**: Full Shopware namespace path (e.g., `@Storefront/storefront/page/product-detail/index.html.twig`)
- **Parent Template**: The template this one extends (inheritance chain)
- **File Path**: Relative filesystem path
- **IDE Link**: Click to open in PHPStorm/VSCode at the exact element line
- **Element Info**: Tag name, ID, and classes
### Smart Line Detection
The extension doesn't just open templates at the block start—it searches for the exact line:
1. **Exact ID match**: `id="product-detail-123"` → finds exact match
2. **Partial ID match**: `id="product-{{ product.id }}"` → matches static prefix
3. **Multi-class match**: `class="btn btn-primary"` → tries all combinations
4. **Parent context**: Uses parent element classes to disambiguate similar elements
5. **Dynamic class prefix**: `class="card-{{ type }}"` → matches `card-` prefix
6. **Tag fallback**: Falls back to tag name (`
`, `![]()
`) if needed
### Example Output
```
📄 Page Template: index.html.twig
🚀 Open in PHPStorm
└─ Open file at line 42
└─ ✓ Found element at line 42 (matched: product-detail-content)
📦 Block Name: page_product_detail
📂 Full Path: @Storefront/storefront/page/product-detail/index.html.twig
⬆️ Extends: @Storefront/storefront/base.html.twig
💻 File Path: vendor/shopware/storefront/Resources/views/storefront/page/product-detail/index.html.twig
🏷️ Element: DIV#product-123.product-detail-content
🎨 Classes: product-detail-content container
```
## How It Works
### Backend (Plugin)
1. **TemplateDebugNodeVisitor**: Twig compiler visitor that wraps every block with tracking functions
2. **TemplateDebugExtension**: Twig extension providing `swdt_track_block()`, `swdt_start_marker()`, and `swdt_end_marker()`
3. **TemplateRegistry**: In-memory registry collecting all template metadata during page render
4. **ResponseSubscriber**: Injects collected data into HTML response as JSON and wraps elements with `data-swdt` attributes
5. **TemplateSearchController**: API endpoint (`/_action/sidworks-devtools/find-line`) that searches template files to find exact element lines
### Frontend (Extension)
1. **content.js**: Content script that detects DevTools data on page
2. **background.js**: Service worker managing extension state
3. **devtools-init.js**: Creates the "Shopware" sidebar panel
4. **inspector.js**: Sidebar logic that reads element data and communicates with the page
5. **Smart search**: Sends element classes/ID/tag to backend API to find exact line in template file
## Security
- **Debug Mode Only**: Plugin is completely disabled when `APP_ENV=prod`
- **Configurable**: Can be disabled even in debug mode via plugin settings
- **Input Validation**: API endpoint validates all inputs (class names, IDs, file paths)
- **Path Traversal Protection**: Only allows reading `.twig` files within project directory
- **No Production Data**: No overhead or data collection in production
## Browser Compatibility
The [Chrome extension](https://github.com/sidworks-dev/sw-plugin-devtools-chrome-extension) works with:
- Google Chrome (Manifest V3)
- Microsoft Edge (Chromium-based)
- Brave
- Other Chromium-based browsers
## License
MIT License - See [LICENSE](LICENSE.md) file for details
## Author
**Sidworks**
Website: [www.sidworks.nl](https://www.sidworks.nl)
## Contributing
Contributions are welcome! Please feel free to submit issues or pull requests.
**Important**: This project consists of two components that work together:
- **[Shopware Plugin](https://github.com/sidworks-dev/sw-plugin-devtools)**
- **[Chrome extension](https://github.com/sidworks-dev/sw-plugin-devtools-chrome-extension)**
When updating the plugin, ensure you also update the extension if the changes affect the data format or API. Similarly, when updating the extension, verify compatibility with the plugin. Both components should be kept in sync.
## Support
For issues and questions:
- Create an issue on GitHub