Requirements
The tool only runs when the following conditions are met:File Types
- Only processes pull requests changing
*.liquid
files
Configuration Files
- Requires either
.theme-check.yml
or.theme-check.yaml
configuration file in the project root
Directory Structure
- Requires the standard Shopify theme directory structure at the project root:
assets/
config/
layout/
locales/
sections/
snippets/
templates/
Validation Rules
The tool checks for:Theme Validation
- Liquid syntax errors
- Theme requirements compliance
- Asset organization
- Performance best practices
- Accessibility standards
App Validation
- App extension configuration
- Function implementation
- API version compatibility
- Security best practices
Common Issues
The tool helps identify and fix:-
Theme Issues:
- Invalid Liquid syntax
- Missing required templates
- Performance bottlenecks
- Accessibility violations
-
App Issues:
- Invalid API usage
- Missing dependencies
- Configuration errors
- Security vulnerabilities