Files
Shopify Theme Check applies to changed files with the.liquid extension when the runner is available.
Configuration
Shopify Theme Check is enabled by default. Enable or disable it with.coderabbit.yaml or the CodeRabbit web UI:
- .coderabbit.yaml
- Web UI
.coderabbit.yaml
.theme-check.yml.theme-check.yaml
assets/config/layout/locales/sections/snippets/templates/
Security policy and restrictions
Shopify Theme Check runs inside the CodeRabbit sandbox when the runner is available. CodeRabbit invokesshopify theme check with JSON output and the detected .theme-check.yml or .theme-check.yaml file. This path does not run theme scripts or plugins.
When we skip Shopify Theme Check
CodeRabbit will skip running Shopify Theme Check when:- The Shopify CLI is unavailable in the sandbox tools image.
- 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 configured in GitHub Actions, GitLab CI, CircleCI, or Azure Pipelines.
Validation Rules
When the runner is available, CodeRabbit reports Shopify Theme Check offenses witherror or warning severity. CodeRabbit filters out the UndefinedObject and MissingTemplate checks.