Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Skip to main content
🐰 New: Triage — a self-updating cross-repository queue that prioritizes pull requests by value and risk, so you always know what to review next. Now in beta! Explore Triage →
Shopify Theme Check
How CodeRabbit handles Shopify Theme Check for Liquid theme files.
Shopify Theme Check is a linter for Shopify themes and Liquid files. CodeRabbit’s configuration reference pins Shopify CLI version 4.6.1 and Shopify Theme version 3.58.2, but CodeRabbit currently skips Shopify Theme Check because the CLI is not installed in the sandbox tools image.
When the runner is available, CodeRabbit searches the repository recursively for the first of these configuration files outside common generated and dependency directories and GitHub Actions or CircleCI pipeline paths:
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
reviews:
tools:
shopifyThemeCheck:
enabled: true
Go to Reviews → Tools → Shopify Theme Check in your organization or repository settings and toggle Shopify Theme Check
on or off..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.
Links
Was this page helpful?
