theme-check 1.7.1 → 1.9.1

data/lib/theme_check/checks/deprecated_filter.rb

@@ -5,18 +5,95 @@ module ThemeCheck
     category :liquid
     severity :suggestion
 
+    # The image_url filter does not accept width or height values
+    # greater than this numbr.
+    MAX_SIZE = 5760
+
     def on_variable(node)
       used_filters = node.value.filters.map { |name, *_rest| name }
       used_filters.each do |filter|
         alternatives = ShopifyLiquid::DeprecatedFilter.alternatives(filter)
         next unless alternatives
 
-        alternatives = alternatives.map { |alt| "`#{alt}`" }
-        add_offense(
-          "Deprecated filter `#{filter}`, consider using an alternative: #{alternatives.join(', ')}",
-          node: node,
+        case filter
+        when 'img_url'
+          add_img_url_offense(node)
+        else
+          add_default_offense(node, filter, alternatives)
+        end
+      end
+    end
+
+    def add_default_offense(node, filter, alternatives)
+      alternatives = alternatives.map { |alt| "`#{alt}`" }
+      add_offense(
+        "Deprecated filter `#{filter}`, consider using an alternative: #{alternatives.join(', ')}",
+        node: node,
+      )
+    end
+
+    def add_img_url_offense(node)
+      img_url_filter = node.value.filters.find { |filter| filter[0] == "img_url" }
+      _name, img_url_filter_size, img_url_filter_props = img_url_filter
+      size_spec = img_url_filter_size&.dig(0)
+      scale = img_url_filter_props&.delete("scale")
+
+      # Can't correct those.
+      return add_default_offense(node, 'img_url', ['image_url']) unless
+       (size_spec.nil? || size_spec.is_a?(String)) &&
+       (scale.nil? || scale.is_a?(Numeric)) &&
+       size_spec != 'small'
+
+      node_source = node.markup
+      node_start_index = node.start_index
+      match = node_source.match(/img_url[^|]*/)
+      img_url_character_range =
+        (node_start_index + match.begin(0))...(node_start_index + match.end(0))
+
+      scale = (scale || 1).to_i
+      width, height = (size_spec&.split('x') || [100, 100])
+        .map { |v| v.to_i * scale }
+
+      image_url_filter_params = [
+        width && width > 0 ? "width: #{[width, MAX_SIZE].min}" : nil,
+        height && height > 0 ? "height: #{[height, MAX_SIZE].min}" : nil,
+      ]
+      image_url_filter_params += (img_url_filter_props || {})
+        .map do |k, v|
+          case v
+          when Liquid::VariableLookup
+            "#{k}: #{v.name}"
+          when String
+            "#{k}: '#{v}'"
+          else
+            "#{k}: #{v}"
+          end
+        end
+      image_url_filter_params = image_url_filter_params
+        .reject(&:nil?)
+        .join(", ")
+
+      trailing_whitespace = match[0].match(/\s*\Z/)[0]
+
+      image_url_filter = "image_url"
+      image_url_filter += ": " + image_url_filter_params unless image_url_filter_params.empty?
+      image_url_filter += trailing_whitespace
+
+      add_offense(
+        "Deprecated filter `img_url`, consider using `image_url`",
+        node: node,
+        markup: match[0]
+      ) do |corrector|
+        corrector.replace(
+          node,
+          image_url_filter,
+          img_url_character_range,
         )
       end
+
+    # If anything goes wrong, fail gracefully by returning the default offense.
+    rescue
+      add_default_offense(node, 'img_url', ['image_url'])
     end
   end
 end

data/lib/theme_check/checks/deprecated_global_app_block_type.rb

@@ -9,7 +9,8 @@ module ThemeCheck
     VALID_GLOBAL_APP_BLOCK_TYPE = "@app"
 
     def on_schema(node)
-      schema = JSON.parse(node.value.nodelist.join)
+      schema = node.inner_json
+      return if schema.nil?
 
       if block_types_from(schema).include?(INVALID_GLOBAL_APP_BLOCK_TYPE)
         add_offense(
@@ -17,8 +18,6 @@ module ThemeCheck
           node: node
         )
       end
-    rescue JSON::ParserError
-      # Ignored, handled in ValidSchema.
     end
 
     def on_case(node)

data/lib/theme_check/checks/matching_schema_translations.rb

@@ -6,8 +6,8 @@ module ThemeCheck
     doc docs_url(__FILE__)
 
     def on_schema(node)
-      schema = JSON.parse(node.value.nodelist.join)
-
+      schema = node.inner_json
+      return if schema.nil?
       # Get all locales used in the schema
       used_locales = Set.new([theme.default_locale])
       visit_object(schema) do |_, locales|
@@ -19,26 +19,31 @@ module ThemeCheck
       visit_object(schema) do |key, locales|
         missing = used_locales - locales
         if missing.any?
-          add_offense("#{key} missing translations for #{missing.join(', ')}", node: node)
+          add_offense("#{key} missing translations for #{missing.join(', ')}", node: node) do |corrector|
+            key = key.split(".")
+            missing.each do |language|
+              SchemaHelper.schema_corrector(schema, key + [language], "TODO")
+            end
+            corrector.replace_inner_json(node, schema)
+          end
         end
       end
 
-      check_locales(schema["locales"], node: node)
-
-    rescue JSON::ParserError
-      # Ignored, handled in ValidSchema.
+      check_locales(schema, node: node)
     end
 
     private
 
-    def check_locales(locales, node:)
+    def check_locales(schema, node:)
+      locales = schema["locales"]
       return unless locales.is_a?(Hash)
 
       default_locale = locales[theme.default_locale]
+
       if default_locale
         locales.each_pair do |name, content|
           diff = LocaleDiff.new(default_locale, content)
-          diff.add_as_offenses(self, key_prefix: ["locales", name], node: node)
+          diff.add_as_offenses(self, key_prefix: ["locales", name], node: node, schema: schema)
         end
       else
         add_offense("Missing default locale in key: locales", node: node)

data/lib/theme_check/checks/matching_translations.rb

@@ -13,6 +13,7 @@ module ThemeCheck
     def on_file(file)
       return unless file.name.start_with?("locales/")
       return unless file.content.is_a?(Hash)
+      return if file.name =~ /\.schema$/
       return if file.name == @theme.default_locale_json&.name
 
       @files << file

data/lib/theme_check/checks/missing_required_template_files.rb

@@ -25,15 +25,15 @@ module ThemeCheck
     def on_end
       (REQUIRED_LIQUID_FILES - theme.liquid.map(&:name)).each do |file|
         add_offense("'#{file}.liquid' is missing") do |corrector|
-          corrector.create(@theme, "#{file}.liquid", "")
+          corrector.create_file(@theme.storage, "#{file}.liquid", "")
         end
       end
       (REQUIRED_TEMPLATE_FILES - (theme.liquid + theme.json).map(&:name)).each do |file|
         add_offense("'#{file}.liquid' or '#{file}.json' is missing") do |corrector|
           if REQUIRED_LIQUID_TEMPLATE_FILES.include?(file)
-            corrector.create(@theme, "#{file}.liquid", "")
+            corrector.create_file(@theme.storage, "#{file}.liquid", "")
           else
-            corrector.create(@theme, "#{file}.json", "")
+            corrector.create_file(@theme.storage, "#{file}.json", "")
           end
         end
       end

data/lib/theme_check/checks/missing_template.rb

@@ -35,7 +35,7 @@ module ThemeCheck
       path = "#{name}.liquid"
       unless ignore?(path) || theme[name]
         add_offense("'#{path}' is not found", node: node) do |corrector|
-          corrector.create(@theme, "#{name}.liquid", "")
+          corrector.create_file(@theme.storage, "#{name}.liquid", "")
         end
       end
     end

data/lib/theme_check/checks/pagination_size.rb

@@ -27,13 +27,12 @@ module ThemeCheck
     end
 
     def on_schema(node)
-      schema = JSON.parse(node.value.nodelist.join)
+      schema = node.inner_json
+      return if schema.nil?
 
       if (settings = schema["settings"])
         @schema_settings = settings
       end
-    rescue JSON::ParserError
-      # Ignored, handled in ValidSchema.
     end
 
     ##

data/lib/theme_check/checks/remote_asset.rb

@@ -22,6 +22,7 @@ module ThemeCheck
       return if resource_url =~ ABSOLUTE_PATH
       return if resource_url =~ RELATIVE_PATH
       return if url_hosted_by_shopify?(resource_url)
+      return if url_is_setting_variable?(resource_url)
 
       # Ignore non-stylesheet link tags
       rel = node.attributes["rel"]
@@ -39,5 +40,9 @@ module ThemeCheck
       url.start_with?(Liquid::VariableStart) &&
         AssetUrlFilters::ASSET_URL_FILTERS.any? { |filter| url.include?(filter) }
     end
+
+    def url_is_setting_variable?(url)
+      url.start_with?(Liquid::VariableStart) && url =~ /settings\./
+    end
   end
 end

data/lib/theme_check/checks/required_directories.rb

@@ -19,7 +19,7 @@ module ThemeCheck
 
     def add_missing_directories_offense(directory)
       add_offense("Theme is missing '#{directory}' directory") do |corrector|
-        corrector.mkdir(@theme, directory)
+        corrector.mkdir(@theme.storage, directory)
       end
     end
   end

data/lib/theme_check/checks/required_layout_theme_object.rb

@@ -27,14 +27,19 @@ module ThemeCheck
     def after_document(node)
       return unless node.theme_file.name == LAYOUT_FILENAME
 
-      add_missing_object_offense("content_for_layout") unless @content_for_layout_found
-      add_missing_object_offense("content_for_header") unless @content_for_header_found
+      add_missing_object_offense("content_for_layout", "</body>") unless @content_for_layout_found
+      add_missing_object_offense("content_for_header", "</head>") unless @content_for_header_found
     end
 
     private
 
-    def add_missing_object_offense(name)
-      add_offense("#{LAYOUT_FILENAME} must include {{#{name}}}", node: @layout_theme_node)
+    def add_missing_object_offense(name, tag)
+      add_offense("#{LAYOUT_FILENAME} must include {{#{name}}}", node: @layout_theme_node) do
+        if @layout_theme_node.source.index(tag)
+          @layout_theme_node.source.insert(@layout_theme_node.source.index(tag), "  {{ #{name} }}\n  ")
+          @layout_theme_node.markup = @layout_theme_node.source
+        end
+      end
     end
   end
 end

data/lib/theme_check/checks/schema_json_format.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class SchemaJsonFormat < LiquidCheck
+    severity :style
+    category :liquid
+    doc docs_url(__FILE__)
+
+    def initialize(start_level: 0, indent: '  ')
+      @pretty_json_opts = {
+        indent: indent,
+        start_level: start_level,
+      }
+    end
+
+    def on_schema(node)
+      schema = node.inner_json
+      return if schema.nil?
+      pretty_schema = pretty_json(schema, **@pretty_json_opts)
+      if pretty_schema != node.inner_markup
+        add_offense(
+          "JSON formatting could be improved",
+          node: node,
+        ) do |corrector|
+          corrector.replace_inner_json(node, schema, **@pretty_json_opts)
+        end
+      end
+    end
+  end
+end

data/lib/theme_check/checks/space_inside_braces.rb

@@ -6,115 +6,160 @@ module ThemeCheck
     category :liquid
     doc docs_url(__FILE__)
 
-    def initialize
-      @ignore = false
-    end
-
     def on_node(node)
       return unless node.markup
-      return if :assign == node.type_name
+      return if node.literal?
+      return if node.assigned_or_echoed_variable?
 
       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(2),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(2)
-          )
+        chunk.scan(/(?<token>[,:|]|==|<>|<=|>=|<|>|!=)(?<offense>  +)/) do |_match|
+          add_too_many_spaces_after_offense(Regexp.last_match, node, chunk_start)
         end
-        chunk.scan(/([,:|]|==|<>|<=|>=|<\b|>\b|!=)(\S|\z)/) do |_match|
-          add_offense(
-            "Space missing after '#{Regexp.last_match(1)}'",
-            node: node,
-            markup: Regexp.last_match(1),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(0),
-          )
+        chunk.scan(/(?<offense>(?<token>[,:|]|==|<>|<=|>=|<\b|>\b|!=)(\S|\z))/) do |_match|
+          add_space_missing_after_offense(Regexp.last_match, node, chunk_start)
         end
-        chunk.scan(/(  +)(\||==|<>|<=|>=|<|>|!=)+/) do |_match|
-          add_offense(
-            "Too many spaces before '#{Regexp.last_match(2)}'",
-            node: node,
-            markup: Regexp.last_match(1),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(1)
-          )
+        chunk.scan(/(?<offense>\s{2,})(?<token>\||==|<>|<=|>=|<|>|!=)+/) do |_match|
+          unless Regexp.last_match(:offense).include?("\n")
+            add_too_many_spaces_before_offense(Regexp.last_match, node, chunk_start)
+          end
         end
-        chunk.scan(/(\A|\S)(?<match>\||==|<>|<=|>=|<|\b>|!=)/) do |_match|
-          add_offense(
-            "Space missing before '#{Regexp.last_match(1)}'",
-            node: node,
-            markup: Regexp.last_match(:match),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(:match)
-          )
+        chunk.scan(/(\A|\S)(?<offense>(?<token>\||==|<>|<=|>=|<|\b>|!=))/) do |_match|
+          add_space_missing_before_offense(Regexp.last_match, node, chunk_start)
         end
       end
     end
 
+    BlockMarkup = Struct.new(:markup, :node_markup_offset)
+
     def on_tag(node)
-      unless node.inside_liquid_tag?
-        if node.markup[-1] != " " && node.markup[-1] != "\n"
-          add_offense(
-            "Space missing before '#{node.end_token}'",
-            node: node,
-            markup: node.markup[-1],
-            node_markup_offset: node.markup.size - 1,
-          )
-        elsif node.markup =~ /(\n?)(  +)\z/m && Regexp.last_match(1) != "\n"
-          add_offense(
-            "Too many spaces before '#{node.end_token}'",
-            node: node,
-            markup: Regexp.last_match(2),
-            node_markup_offset: node.markup.size - Regexp.last_match(2).size
-          )
+      return if node.inside_liquid_tag?
+
+      # Both the start and end tags
+      blocks = [
+        BlockMarkup.new(node.block_start_markup, node.block_start_start_index - node.start_index),
+        BlockMarkup.new(node.block_end_markup, node.block_end_start_index - node.start_index),
+      ]
+
+      blocks.each do |block|
+        # Looking at spaces after the start token
+        if block.markup =~ /^(?<token>{%-?)(?<offense>[^ \n\t-])/
+          add_space_missing_after_offense(Regexp.last_match, node, block.node_markup_offset)
+        end
+
+        if block.markup =~ /^(?<token>{%-?)(?<offense> {2,})\S/
+          add_too_many_spaces_after_offense(Regexp.last_match, node, block.node_markup_offset)
+        end
+
+        # Looking at spaces before the end token
+        if block.markup =~ /(?<offense>[^ \n\t-])(?<token>-?%})$/
+          add_space_missing_before_offense(Regexp.last_match, node, block.node_markup_offset)
         end
+
+        if block.markup =~ /\S(?<offense> {2,})(?<token>-?%})$/
+          add_too_many_spaces_before_offense(Regexp.last_match, node, block.node_markup_offset)
+        end
+
+        next
       end
-      @ignore = true
     end
 
-    def after_tag(_node)
-      @ignore = false
+    def on_variable(node)
+      return if node.markup.empty?
+      return if node.assigned_or_echoed_variable?
+
+      block_start_offset = node.block_start_start_index - node.start_index
+
+      # Looking at spaces after the start token
+      if node.block_start_markup =~ /^(?<token>{{-?)(?<offense>[^ \n\t-])/
+        add_space_missing_after_offense(Regexp.last_match, node, block_start_offset)
+      end
+
+      if node.block_start_markup =~ /^(?<token>{{-?)(?<offense> {2,})\S/
+        add_too_many_spaces_after_offense(Regexp.last_match, node, block_start_offset)
+      end
+
+      # Looking at spaces before the end token
+      if node.block_start_markup =~ /(?<offense>[^ \n\t-])(?<token>-?}})$/
+        add_space_missing_before_offense(Regexp.last_match, node, block_start_offset)
+      end
+
+      if node.block_start_markup =~ /\S(?<offense> {2,})(?<token>-?}})$/
+        add_too_many_spaces_before_offense(Regexp.last_match, node, block_start_offset)
+      end
     end
 
-    def on_variable(node)
-      return if @ignore || node.markup.empty?
-      if node.markup[0] != " "
-        add_offense(
-          "Space missing after '#{node.start_token}'",
-          node: node,
-          markup: node.markup[0]
-        ) do |corrector|
-          corrector.insert_before(node, " ")
-        end
+    def add_space_missing_after_offense(match, node, source_offset)
+      add_offense_for_match(
+        "Space missing after '#{match[:token]}'",
+        match,
+        node,
+        source_offset
+      ) do |corrector|
+        corrector.insert_after(
+          node,
+          ' ',
+          (node.start_index + source_offset + match.begin(:token))...
+          (node.start_index + source_offset + match.end(:token))
+        )
       end
-      if node.markup[-1] != " " && node.markup[-1] != "\n"
-        add_offense(
-          "Space missing before '#{node.end_token}'",
-          node: node,
-          markup: node.markup[-1],
-          node_markup_offset: node.markup.size - 1,
-        ) do |corrector|
-          corrector.insert_after(node, " ")
-        end
+    end
+
+    def add_too_many_spaces_after_offense(match, node, source_offset)
+      add_offense_for_match(
+        "Too many spaces after '#{match[:token]}'",
+        match,
+        node,
+        source_offset
+      ) do |corrector|
+        corrector.replace(
+          node,
+          ' ',
+          (node.start_index + source_offset + match.begin(:offense))...
+          (node.start_index + source_offset + match.end(:offense))
+        )
       end
-      if node.markup =~ /\A(  +)/m
-        add_offense(
-          "Too many spaces after '#{node.start_token}'",
-          node: node,
-          markup: Regexp.last_match(1),
-        ) do |corrector|
-          corrector.replace(node, " #{node.markup.lstrip}")
-        end
+    end
+
+    def add_space_missing_before_offense(match, node, source_offset)
+      add_offense_for_match(
+        "Space missing before '#{match[:token]}'",
+        match,
+        node,
+        source_offset
+      ) do |corrector|
+        corrector.insert_before(
+          node,
+          ' ',
+          (node.start_index + source_offset + match.begin(:token))...
+          (node.start_index + source_offset + match.end(:token))
+        )
       end
-      if node.markup =~ /(\n?)(  +)\z/m && Regexp.last_match(1) != "\n"
-        add_offense(
-          "Too many spaces before '#{node.end_token}'",
-          node: node,
-          markup: Regexp.last_match(2),
-          node_markup_offset: node.markup.size - Regexp.last_match(2).size
-        ) do |corrector|
-          corrector.replace(node, "#{node.markup.rstrip} ")
-        end
+    end
+
+    def add_too_many_spaces_before_offense(match, node, source_offset)
+      add_offense_for_match(
+        "Too many spaces before '#{match[:token]}'",
+        match,
+        node,
+        source_offset
+      ) do |corrector|
+        corrector.replace(
+          node,
+          ' ',
+          (node.start_index + source_offset + match.begin(:offense))...
+          (node.start_index + source_offset + match.end(:offense))
+        )
       end
     end
+
+    def add_offense_for_match(message, match, node, source_offset, &block)
+      add_offense(
+        message,
+        node: node,
+        markup: match[:offense],
+        node_markup_offset: source_offset + match.begin(:offense),
+        &block
+      )
+    end
   end
 end

data/lib/theme_check/checks/translation_key_exists.rb

@@ -5,28 +5,48 @@ module ThemeCheck
     category :translation
     doc docs_url(__FILE__)
 
+    def initialize
+      @schema_locales = {}
+      @nodes = {}
+    end
+
+    def on_document(node)
+      @nodes[node.theme_file.name] = []
+    end
+
     def on_variable(node)
       return unless @theme.default_locale_json&.content&.is_a?(Hash)
-
       return unless node.value.filters.any? { |name, _| name == "t" || name == "translate" }
-      return unless (key_node = node.children.first)
-      return unless key_node.value.is_a?(String)
-
-      unless key_exists?(key_node.value) || ShopifyLiquid::SystemTranslations.include?(key_node.value)
-        add_offense(
-          "'#{key_node.value}' does not have a matching entry in '#{@theme.default_locale_json.relative_path}'",
-          node: node,
-          markup: key_node.value,
-        ) do |corrector|
-          corrector.add_default_translation_key(@theme.default_locale_json, key_node.value.split("."), "TODO")
+
+      @nodes[node.theme_file.name] << node
+    end
+
+    def on_schema(node)
+      if (schema_locales = node.inner_json&.dig("locales", @theme.default_locale))
+        @schema_locales = schema_locales
+      end
+    end
+
+    def on_end
+      @nodes.each_pair do |_file_name, file_nodes|
+        file_nodes.each do |node|
+          next unless (key_node = node.children.first)
+          next unless key_node.value.is_a?(String)
+          next if key_exists?(key_node.value, @theme.default_locale_json.content) || key_exists?(key_node.value, @schema_locales) || ShopifyLiquid::SystemTranslations.include?(key_node.value)
+          add_offense(
+            @schema_locales.empty? ? "'#{key_node.value}' does not have a matching entry in '#{@theme.default_locale_json.relative_path}'" : "'#{key_node.value}' does not have a matching entry in '#{@theme.default_locale_json.relative_path}' or '#{node.theme_file.relative_path}'",
+            node: node,
+            markup: key_node.value
+          ) do |corrector|
+            corrector.add_translation(@theme.default_locale_json, key_node.value.split("."), "TODO")
+          end
         end
       end
     end
 
     private
 
-    def key_exists?(key)
-      pointer = @theme.default_locale_json.content
+    def key_exists?(key, pointer)
       key.split(".").each do |token|
         return false unless pointer.key?(token)
         pointer = pointer[token]

data/lib/theme_check/checks/unused_assign.rb

@@ -46,8 +46,9 @@ module ThemeCheck
       @templates.each_pair do |_, info|
         used = info.collect_used_assigns(@templates)
         info.assign_nodes.each_pair do |name, node|
-          unless used.include?(name)
-            add_offense("`#{name}` is never used", node: node)
+          next if used.include?(name)
+          add_offense("`#{name}` is never used", node: node) do |corrector|
+            corrector.remove(node)
           end
         end
       end

data/lib/theme_check/checks/unused_snippet.rb

@@ -25,7 +25,7 @@ module ThemeCheck
     def on_end
       missing_snippets.each do |theme_file|
         add_offense("This snippet is not used", theme_file: theme_file) do |corrector|
-          corrector.remove(@theme, theme_file.relative_path.to_s)
+          corrector.remove_file(@theme.storage, theme_file.relative_path.to_s)
         end
       end
     end

data/lib/theme_check/checks/valid_html_translation.rb

@@ -19,7 +19,7 @@ module ThemeCheck
 
     def html_key?(keys)
       pluralized_key = keys[-2] if keys.length > 1
-      keys[-1].end_with?('_html') || pluralized_key.end_with?('_html')
+      keys[-1].end_with?('_html') || pluralized_key&.end_with?('_html')
     end
 
     def parse_and_add_offense(key, value)