theme-check 1.1.0 → 1.5.0

data/docs/checks/missing_template.md

@@ -25,8 +25,33 @@ The default configuration for this check is the following:
 ```yaml
 MissingTemplate:
   enabled: true
+  ignore_missing: []
 ```
 
+### `ignore_missing`
+
+Specify a list of patterns of missing template files to ignore.
+
+While the `ignore` option will ignore all occurrences of `MissingTemplate` according to the file in which they appear, `ignore_missing` allows ignoring all occurrences of `MissingTemplate` based on the target template, the template being rendered.
+
+For example:
+
+```yaml
+MissingTemplate:
+  ignore_missing:
+  - snippets/icon-*
+```
+
+Would ignore offenses on `{% render 'icon-missing' %}` across all theme files.
+
+```yaml
+MissingTemplate:
+  ignore:
+  - templates/index.liquid
+```
+
+Would ignore all `MissingTemplate` in `templates/index.liquid`, no mater the file being rendered.
+
 ## Version
 
 This check has been introduced in Theme Check 0.1.0.

data/docs/checks/pagination_size.md

@@ -0,0 +1,44 @@
+# Ensure `paginate` tags are used with performant sizes
+
+## Check Details
+
+This check is aimed at keeping response times low.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<!-- Using too large of page size -->
+{% paginate collection.products by 999 %}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{% paginate collection.products by 12 %}
+```
+
+Use sizes that are integers below the `max_size`, and above the `min_size`.
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+PaginationSize:
+  enabled: true
+  ignore: []
+  min_size: 1
+  max_size: 50
+```
+
+## When Not To Use It
+
+N/A
+
+## Version
+
+This check has been introduced in Theme Check 1.3.0.
+
+## Resources
+
+[paginate]: https://shopify.dev/api/liquid/objects/paginate

data/docs/checks/template_length.md

@@ -21,7 +21,7 @@ The default configuration for this check is the following:
 ```yaml
 TemplateLength:
   enabled: true
-  max_length: 500
+  max_length: 600
   exclude_schema: true
   exclude_stylesheet: true
   exclude_javascript: true

data/docs/checks/undefined_object.md

@@ -33,8 +33,13 @@ The default configuration for this check is the following:
 ```yaml
 UndefinedObject:
   enabled: true
+  exclude_snippets: true
 ```
 
+### `exclude_snippets`
+
+The `exclude_snippets` (Default: `true`) option determines whether to check for undefined objects in snippets file (as objects _may_ be defined as arguments)
+
 ## When Not To Use It
 
 It is discouraged to disable this rule.

data/lib/theme_check/analyzer.rb

@@ -87,6 +87,7 @@ module ThemeCheck
       if @auto_correct
         offenses.each(&:correct)
         @theme.liquid.each(&:write)
+        @theme.json.each(&:write)
       end
     end
 

data/lib/theme_check/check.rb

@@ -69,7 +69,7 @@ module ThemeCheck
       end
 
       def docs_url(path)
-        "https://github.com/Shopify/theme-check/blob/master/docs/checks/#{File.basename(path, '.rb')}.md"
+        "https://github.com/Shopify/theme-check/blob/main/docs/checks/#{File.basename(path, '.rb')}.md"
       end
 
       def can_disable(disableable = nil)
@@ -91,8 +91,8 @@ module ThemeCheck
       @offenses ||= []
     end
 
-    def add_offense(message, node: nil, template: node&.template, markup: nil, line_number: nil, &block)
-      offenses << Offense.new(check: self, message: message, template: template, node: node, markup: markup, line_number: line_number, correction: block)
+    def add_offense(message, node: nil, template: node&.template, markup: nil, line_number: nil, node_markup_offset: 0, &block)
+      offenses << Offense.new(check: self, message: message, template: template, node: node, markup: markup, line_number: line_number, node_markup_offset: node_markup_offset, correction: block)
     end
 
     def severity

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_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/deprecated_global_app_block_type.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class DeprecatedGlobalAppBlockType < LiquidCheck
+    severity :error
+    category :liquid
+    doc docs_url(__FILE__)
+
+    INVALID_GLOBAL_APP_BLOCK_TYPE = "@global"
+    VALID_GLOBAL_APP_BLOCK_TYPE = "@app"
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if block_types_from(schema).include?(INVALID_GLOBAL_APP_BLOCK_TYPE)
+        add_offense(
+          "Deprecated '#{INVALID_GLOBAL_APP_BLOCK_TYPE}' block type defined in the schema, use '#{VALID_GLOBAL_APP_BLOCK_TYPE}' block type instead.",
+          node: node
+        )
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    def on_case(node)
+      if node.value == INVALID_GLOBAL_APP_BLOCK_TYPE
+        report_offense(node)
+      end
+    end
+
+    def on_condition(node)
+      if node.value.right == INVALID_GLOBAL_APP_BLOCK_TYPE || node.value.left == INVALID_GLOBAL_APP_BLOCK_TYPE
+        report_offense(node)
+      end
+    end
+
+    def on_variable(node)
+      if node.value.name == INVALID_GLOBAL_APP_BLOCK_TYPE
+        report_offense(node)
+      end
+    end
+
+    private
+
+    def report_offense(node)
+      add_offense(
+        "Deprecated '#{INVALID_GLOBAL_APP_BLOCK_TYPE}' block type, use '#{VALID_GLOBAL_APP_BLOCK_TYPE}' block type instead.",
+        node: node
+      )
+    end
+
+    def block_types_from(schema)
+      schema.fetch("blocks", []).map do |block|
+        block.fetch("type", "")
+      end
+    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,64 @@
+# 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.find { |s| s['id'] == setting_id }
+      return nil if setting.empty?
+      default_value = setting['default'].to_i
+      return nil if default_value == 0
+      default_value
+    end
+  end
+end