theme-check 1.0.0 → 1.4.0

data/lib/theme_check/checks/app_block_valid_tags.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when invalid tags are used in a Theme App
+  # Extension block
+  class AppBlockValidTags < LiquidCheck
+    severity :error
+    category :liquid
+    doc docs_url(__FILE__)
+
+    # Don't allow this check to be disabled with a comment,
+    # since we need to be able to enforce this server-side
+    can_disable false
+
+    OFFENSE_MSG = "Theme app extension blocks cannot contain %s tags"
+
+    def on_javascript(node)
+      add_offense(OFFENSE_MSG % 'javascript', node: node)
+    end
+
+    def on_stylesheet(node)
+      add_offense(OFFENSE_MSG % 'stylesheet', node: node)
+    end
+
+    def on_include(node)
+      add_offense(OFFENSE_MSG % 'include', node: node)
+    end
+
+    def on_layout(node)
+      add_offense(OFFENSE_MSG % 'layout', node: node)
+    end
+
+    def on_section(node)
+      add_offense(OFFENSE_MSG % 'section', node: node)
+    end
+  end
+end

data/lib/theme_check/checks/asset_size_app_block_css.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when too much CSS is being referenced from a Theme App
+  # Extension block
+  class AssetSizeAppBlockCSS < LiquidCheck
+    severity :error
+    category :performance
+    doc docs_url(__FILE__)
+
+    # Don't allow this check to be disabled with a comment,
+    # since we need to be able to enforce this server-side
+    can_disable false
+
+    attr_reader :threshold_in_bytes
+
+    def initialize(threshold_in_bytes: 100_000)
+      @threshold_in_bytes = threshold_in_bytes
+    end
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if (stylesheet = schema["stylesheet"])
+        size = asset_size(stylesheet)
+        if size && size > threshold_in_bytes
+          add_offense(
+            "CSS in Theme App Extension blocks exceeds compressed size threshold (#{threshold_in_bytes} Bytes)",
+            node: node
+          )
+        end
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    private
+
+    def asset_size(name)
+      asset = @theme["assets/#{name}"]
+      return if asset.nil?
+      asset.gzipped_size
+    end
+  end
+end

data/lib/theme_check/checks/asset_size_app_block_javascript.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when too much JS is being referenced from a Theme App
+  # Extension block
+  class AssetSizeAppBlockJavaScript < LiquidCheck
+    severity :error
+    category :performance
+    doc docs_url(__FILE__)
+
+    # Don't allow this check to be disabled with a comment,
+    # since we need to be able to enforce this server-side
+    can_disable false
+
+    attr_reader :threshold_in_bytes
+
+    def initialize(threshold_in_bytes: 10_000)
+      @threshold_in_bytes = threshold_in_bytes
+    end
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if (javascript = schema["javascript"])
+        size = asset_size(javascript)
+        if size && size > threshold_in_bytes
+          add_offense(
+            "JavaScript in Theme App Extension blocks exceeds compressed size threshold (#{threshold_in_bytes} Bytes)",
+            node: node
+          )
+        end
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    private
+
+    def asset_size(name)
+      asset = @theme["assets/#{name}"]
+      return if asset.nil?
+      asset.gzipped_size
+    end
+  end
+end

data/lib/theme_check/checks/asset_size_css.rb

@@ -13,12 +13,12 @@ module ThemeCheck
     end
 
     def on_link(node)
-      return if node.attributes['rel']&.value != "stylesheet"
-      file_size = href_to_file_size(node.attributes['href']&.value)
+      return if node.attributes['rel'] != "stylesheet"
+      file_size = href_to_file_size(node.attributes['href'])
       return if file_size.nil?
       return if file_size <= threshold_in_bytes
       add_offense(
-        "CSS on every page load exceeding compressed size threshold (#{threshold_in_bytes} Bytes).",
+        "CSS on every page load exceeding compressed size threshold (#{threshold_in_bytes} Bytes)",
         node: node
       )
     end

data/lib/theme_check/checks/asset_size_javascript.rb

@@ -16,7 +16,7 @@ module ThemeCheck
     end
 
     def on_script(node)
-      file_size = src_to_file_size(node.attributes['src']&.value)
+      file_size = src_to_file_size(node.attributes['src'])
       return if file_size.nil?
       return if file_size <= threshold_in_bytes
       add_offense(
@@ -28,7 +28,7 @@ module ThemeCheck
     def src_to_file_size(src)
       # We're kind of intentionally only looking at {{ 'asset' | asset_url }} or full urls in here.
       # More complicated liquid statements are not in scope.
-      if src =~ /^#{VARIABLE}$/o && src =~ /asset_url/ && src =~ Liquid::QuotedString
+      if src =~ /^#{LIQUID_VARIABLE}$/o && src =~ /asset_url/ && src =~ Liquid::QuotedString
         asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
         asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
         return if asset.nil?

data/lib/theme_check/checks/convert_include_to_render.rb

@@ -7,7 +7,9 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_include(node)
-      add_offense("`include` is deprecated - convert it to `render`", node: node)
+      add_offense("`include` is deprecated - convert it to `render`", node: node) do |corrector|
+        corrector.replace(node, "render \'#{node.value.template_name_expr}\' ")
+      end
     end
   end
 end

data/lib/theme_check/checks/default_locale.rb

@@ -7,7 +7,9 @@ module ThemeCheck
 
     def on_end
       return if @theme.default_locale_json
-      add_offense("Default translation file not found (for example locales/en.default.json)")
+      add_offense("Default translation file not found (for example locales/en.default.json)") do |corrector|
+        corrector.create_default_locale_json(@theme)
+      end
     end
   end
 end

data/lib/theme_check/checks/deprecate_bgsizes.rb

@@ -6,7 +6,7 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_div(node)
-      class_list = node.attributes["class"]&.value&.split(" ")
+      class_list = node.attributes["class"]&.split(" ")
       add_offense("Use the native loading=\"lazy\" attribute instead of lazysizes", node: node) if class_list&.include?("lazyload")
       add_offense("Use the CSS imageset attribute instead of data-bgset", node: node) if node.attributes["data-bgset"]
     end

data/lib/theme_check/checks/deprecate_lazysizes.rb

@@ -6,11 +6,14 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_img(node)
-      class_list = node.attributes["class"]&.value&.split(" ")
+      class_list = node.attributes["class"]&.split(" ")
+      has_loading_lazy = node.attributes["loading"] == "lazy"
+      has_native_source = node.attributes["src"] || node.attributes["srcset"]
+      return if has_native_source && has_loading_lazy
+      has_lazysize_source = node.attributes["data-srcset"] || node.attributes["data-src"]
+      has_lazysize_class = class_list&.include?("lazyload")
+      return unless has_lazysize_class && has_lazysize_source
       add_offense("Use the native loading=\"lazy\" attribute instead of lazysizes", node: node) if class_list&.include?("lazyload")
-      add_offense("Use the native srcset attribute instead of data-srcset", node: node) if node.attributes["data-srcset"]
-      add_offense("Use the native sizes attribute instead of data-sizes", node: node) if node.attributes["data-sizes"]
-      add_offense("Do not set the data-sizes attribute to auto", node: node) if node.attributes["data-sizes"]&.value == "auto"
     end
   end
 end

data/lib/theme_check/checks/img_lazy_loading.rb

@@ -8,7 +8,7 @@ module ThemeCheck
     ACCEPTED_LOADING_VALUES = %w[lazy eager]
 
     def on_img(node)
-      loading = node.attributes["loading"]&.value&.downcase
+      loading = node.attributes["loading"]&.downcase
       return if ACCEPTED_LOADING_VALUES.include?(loading)
       if loading == "auto"
         add_offense("Prefer loading=\"lazy\" to defer loading of images", node: node)

data/lib/theme_check/checks/img_width_and_height.rb

@@ -9,8 +9,8 @@ module ThemeCheck
     ENDS_IN_CSS_UNIT = /(cm|mm|in|px|pt|pc|em|ex|ch|rem|vw|vh|vmin|vmax|%)$/i
 
     def on_img(node)
-      width = node.attributes["width"]&.value
-      height = node.attributes["height"]&.value
+      width = node.attributes["width"]
+      height = node.attributes["height"]
 
       record_units_in_field_offenses("width", width, node: node)
       record_units_in_field_offenses("height", height, node: node)
@@ -35,7 +35,7 @@ module ThemeCheck
       return unless value =~ ENDS_IN_CSS_UNIT
       value_without_units = value.gsub(ENDS_IN_CSS_UNIT, '')
       add_offense(
-        "The #{attribute} attribute does not take units. Replace with \"#{value_without_units}\".",
+        "The #{attribute} attribute does not take units. Replace with \"#{value_without_units}\"",
         node: node,
       )
     end

data/lib/theme_check/checks/missing_template.rb

@@ -7,20 +7,36 @@ module ThemeCheck
     doc docs_url(__FILE__)
     single_file false
 
+    def initialize(ignore_missing: [])
+      @ignore_missing = ignore_missing
+    end
+
     def on_include(node)
       template = node.value.template_name_expr
       if template.is_a?(String)
-        unless theme["snippets/#{template}"]
-          add_offense("'snippets/#{template}.liquid' is not found", node: node)
-        end
+        add_missing_offense("snippets/#{template}", node: node)
       end
     end
+
     alias_method :on_render, :on_include
 
     def on_section(node)
       template = node.value.section_name
-      unless theme["sections/#{template}"]
-        add_offense("'sections/#{template}.liquid' is not found", node: node)
+      add_missing_offense("sections/#{template}", node: node)
+    end
+
+    private
+
+    def ignore?(path)
+      @ignore_missing.any? { |pattern| File.fnmatch?(pattern, path) }
+    end
+
+    def add_missing_offense(name, node:)
+      path = "#{name}.liquid"
+      unless ignore?(path) || theme[name]
+        add_offense("'#{path}' is not found", node: node) do |corrector|
+          corrector.create(@theme, "#{name}.liquid", "")
+        end
       end
     end
   end

data/lib/theme_check/checks/pagination_size.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class PaginationSize < LiquidCheck
+    severity :suggestion
+    categories :performance
+    doc docs_url(__FILE__)
+
+    attr_reader :min_size
+    attr_reader :max_size
+
+    def initialize(min_size: 1, max_size: 50)
+      @min_size = min_size
+      @max_size = max_size
+    end
+
+    def on_document(_node)
+      @paginations = {}
+      @schema_settings = {}
+    end
+
+    def on_paginate(node)
+      size = node.value.page_size
+      unless @paginations.key?(size)
+        @paginations[size] = []
+      end
+      @paginations[size].push(node)
+    end
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if (settings = schema["settings"])
+        @schema_settings = settings
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    def after_document(_node)
+      @paginations.each_pair do |size, nodes|
+        numerical_size = if size.is_a?(Numeric)
+          size
+        else
+          get_setting_default_value(size.lookups.last)
+        end
+        if numerical_size.nil?
+          nodes.each { |node| add_offense("Default pagination size should be defined in the section settings", node: node) }
+        elsif numerical_size > @max_size || numerical_size < @min_size || !numerical_size.is_a?(Integer)
+          nodes.each { |node| add_offense("Pagination size must be a positive integer between #{@min_size} and #{@max_size}", node: node) }
+        end
+      end
+    end
+
+    private
+
+    def get_setting_default_value(setting_id)
+      setting = @schema_settings.select { |s| s['id'] == setting_id }
+      unless setting.empty?
+        return setting.last['default']
+      end
+      # Setting does not exist
+      nil
+    end
+  end
+end

data/lib/theme_check/checks/parser_blocking_javascript.rb

@@ -8,7 +8,7 @@ module ThemeCheck
 
     def on_script(node)
       return unless node.attributes["src"]
-      return if node.attributes["defer"] || node.attributes["async"] || node.attributes["type"]&.value == "module"
+      return if node.attributes["defer"] || node.attributes["async"] || node.attributes["type"] == "module"
 
       add_offense("Missing async or defer attribute on script tag", node: node)
     end

data/lib/theme_check/checks/remote_asset.rb

@@ -14,7 +14,7 @@ module ThemeCheck
     def on_element(node)
       return unless TAGS.include?(node.name)
 
-      resource_url = node.attributes["src"]&.value || node.attributes["href"]&.value
+      resource_url = node.attributes["src"] || node.attributes["href"]
       return if resource_url.nil? || resource_url.empty?
 
       # Ignore if URL is Liquid, taken care of by AssetUrlFilters check
@@ -23,9 +23,9 @@ module ThemeCheck
       return if resource_url =~ RELATIVE_PATH
       return if url_hosted_by_shopify?(resource_url)
 
-      # Ignore non-stylesheet rel tags
+      # Ignore non-stylesheet link tags
       rel = node.attributes["rel"]
-      return if rel && rel.value != "stylesheet"
+      return if node.name == "link" && rel != "stylesheet"
 
       add_offense(
         "Asset should be served by the Shopify CDN for better performance.",

data/lib/theme_check/checks/space_inside_braces.rb

@@ -14,18 +14,38 @@ module ThemeCheck
       return unless node.markup
       return if :assign == node.type_name
 
-      outside_of_strings(node.markup) do |chunk|
+      outside_of_strings(node.markup) do |chunk, chunk_start|
         chunk.scan(/([,:|]|==|<>|<=|>=|<|>|!=)  +/) do |_match|
-          add_offense("Too many spaces after '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+          add_offense(
+            "Too many spaces after '#{Regexp.last_match(1)}'",
+            node: node,
+            markup: Regexp.last_match(0),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+          )
         end
         chunk.scan(/([,:|]|==|<>|<=|>=|<\b|>\b|!=)(\S|\z)/) do |_match|
-          add_offense("Space missing after '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+          add_offense(
+            "Space missing after '#{Regexp.last_match(1)}'",
+            node: node,
+            markup: Regexp.last_match(0),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(0),
+          )
         end
         chunk.scan(/  (\||==|<>|<=|>=|<|>|!=)+/) do |_match|
-          add_offense("Too many spaces before '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+          add_offense(
+            "Too many spaces before '#{Regexp.last_match(1)}'",
+            node: node,
+            markup: Regexp.last_match(0),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+          )
         end
         chunk.scan(/(\A|\S)(?<match>\||==|<>|<=|>=|<|\b>|!=)/) do |_match|
-          add_offense("Space missing before '#{Regexp.last_match(1)}'", node: node, markup: Regexp.last_match(0))
+          add_offense(
+            "Space missing before '#{Regexp.last_match(1)}'",
+            node: node,
+            markup: Regexp.last_match(0),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+          )
         end
       end
     end
@@ -51,13 +71,13 @@ module ThemeCheck
     end
 
     def on_variable(node)
-      return if @ignore
+      return if @ignore || node.markup.empty?
       if node.markup[0] != " "
         add_offense("Space missing after '{{'", node: node) do |corrector|
           corrector.insert_before(node, " ")
         end
       end
-      if node.markup[-1] != " "
+      if node.markup[-1] != " " && node.markup[-1] != "\n"
         add_offense("Space missing before '}}'", node: node) do |corrector|
           corrector.insert_after(node, " ")
         end