Skip to main content
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.

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
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:
  • .theme-check.yml
  • .theme-check.yaml
CodeRabbit also requires the standard Shopify theme directory structure at the project root:
  • 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 invokes shopify 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 .liquid files are changed in the pull request.
  • The repository does not have the required Shopify theme directory structure.
  • No config file is found (.theme-check.yml or .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 with error or warning severity. CodeRabbit filters out the UndefinedObject and MissingTemplate checks.