Skip to main content

SchemaSectionOrBlockOnly

Identifies {% schema %} tags in files where schemas aren't valid. Theme Check reports a schema tag unless it's in a section or block file.

Schema tags define settings for sections and blocks only. Keep schema tags out of templates, snippets, layouts, and other theme files.


The following examples contain code snippets that either fail or pass this check.

In the following example, templates/index.liquid contains a {% schema %} tag:

templates/index.liquid

{% schema %}
{
"name": "Home page"
}
{% endschema %}

In the following example, sections/hero.liquid contains a {% schema %} tag in a section file:

sections/hero.liquid

{% schema %}
{
"name": "Hero"
}
{% endschema %}

The following example contains the default configuration for this check:

SchemaSectionOrBlockOnly:
enabled: true
severity: error
ParameterDescription
enabledWhether this check is enabled.
severityThe severity of the check.

Anchor to Disabling this checkDisabling this check

Disabling this check isn't recommended. If you can't avoid violating the rule, then you should disable the check using the comment syntax. This ensures that you intentionally disable the check for each instance.

{% # theme-check-disable SchemaSectionOrBlockOnly %}
{% schema %}
{
"name": "Home page"
}
{% endschema %}
{% # theme-check-enable SchemaSectionOrBlockOnly %}

Was this page helpful?