Theme Check failing with errors on two files

dominicmichaud commented 6 months ago

Describe the current behavior

Running shopify theme check on the latest version of Dawn brings about two errors which should be fixed. The files in questions are:

sections/header.liquid
sections/email-signup-banner.liquid

Describe the expected behavior

Running shopify theme check on the latest version of Dawn should pass and be successful and only highlights some warnings. No errors should be detected.

Version information (Dawn, browsers and operating systems)

Dawn Version: 13.0.0
Chrome Version: 121.0.6167.184 (arm64)
macOS Version: Sonoma 14.3

Possible solution

I've modified the Liquid and Schema code that were wrong and Theme Check passes successfully, like so:

sections/header.liquid (Line 144 and line 340) The HTML for the sticky header wasn't able to be parsed correctly because the tagname was not the first element. It was the inline Liquid if statement that was first which resulted in bad content parsing.

Line 144, fix:

{% if section.settings.sticky_header_type != 'none' %}
<sticky-header data-sticky-type="{{ section.settings.sticky_header_type }}" class="header-wrapper color-{{ section.settings.color_scheme }} gradient{% if section.settings.show_line_separator %} header-wrapper--border-bottom{% endif %}">
{% else %}
<div class="header-wrapper color-{{ section.settings.color_scheme }} gradient{% if section.settings.show_line_separator %} header-wrapper--border-bottom{% endif %}">
{% endif %}

Line 340, fix:

{% if section.settings.sticky_header_type != 'none' %}
</sticky-header>
{% else %}
</div>
{% endif %}

sections/email-signup-banner.liquid The templates attribute in the schema doesn't work in that context. It is deprecated.

It should be replaced with enabled_on and be moved up near the top of the schema:

"name": "t:sections.email-signup-banner.name",
  "tag": "section",
  "class": "section",
  "enabled_on": {
    "templates": ["password"]
  },

Additional context/screenshots

I am setting up a new GitLab CI/CD pipeline structure for our projects with the Shopify CLI and added a Test stage. In this stage, I am running Theme Check to ensure that the Theme is correctly maintained and error-free before merging in branches. My builds were failing because the Check summary detected these two errors. After correcting said-errors like mentioned above, the builds were successful.

Screenshots: Fail: gitlab-ci-cd-build-fail

Success: gitlab-ci-cd-success-build

captainscorch commented 6 months ago

Thank you! Using

"name": "t:sections.email-signup-banner.name",
  "tag": "section",
  "class": "section",
  "enabled_on": {
    "templates": ["password"]
  },

in the sections/email-signup-banner.liquid fixed the theme check error for me.

dominicmichaud commented 6 months ago

@captainscorch You're quite welcome! Happy to hear it helped you out :)

Shopify / dawn