Requirements
The tool only runs when the following conditions are met:File Types
- Only processes pull requests changing
*.liquidfiles
Configuration Files
- Requires either
.theme-check.ymlor.theme-check.yamlconfiguration 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/
When we skip Shopify Theme Check
CodeRabbit will skip running Shopify Theme Check when:- No
.liquidfiles are changed in the pull request. - The repository does not have the required Shopify theme directory structure.
- No config file is found (
.theme-check.ymlor.theme-check.yaml). - Shopify Theme Check is already running in GitHub workflows.
Validation Rules
The tool checks for:Theme Validation
- Liquid syntax errors
- Theme requirements compliance
- Asset organization
- Performance best practices
- Accessibility standards
UndefinedObject and MissingTemplate checks, reporting only errors and warnings for other issues.
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