theme-check 1.3.0 → 1.5.2

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/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_lazysizes.rb

@@ -7,10 +7,13 @@ module ThemeCheck
 
     def on_img(node)
       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"] == "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/liquid_tag.rb

@@ -13,7 +13,7 @@ module ThemeCheck
     end
 
     def on_tag(node)
-      if !node.inside_liquid_tag?
+      if node.inside_liquid_tag?
         reset_consecutive_statements
       # Ignore comments
       elsif !node.comment?

data/lib/theme_check/checks/pagination_size.rb

@@ -36,16 +36,32 @@ module ThemeCheck
       # Ignored, handled in ValidSchema.
     end
 
+    ##
+    # Section settings look like:
+    #   #<Liquid::VariableLookup:0x00007fd699c50c48 @name="section", @lookups=["settings", "products_per_page"], @command_flags=0>
+    def size_is_a_section_setting?(size)
+      size.is_a?(Liquid::VariableLookup) &&
+        size.name == 'section' &&
+        size.lookups.first == 'settings'
+    end
+
+    ##
+    # We'll work with either an explicit value, or the default value of the section setting.
+    def get_value(size)
+      return size if size.is_a?(Numeric)
+      return get_setting_default_value(size) if size_is_a_section_setting?(size)
+    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?
+        # Validate presence of default section setting.
+        if size_is_a_section_setting?(size) && !get_setting_default_value(size)
           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)
+        end
+
+        # Validate if size is within range.
+        next unless (numerical_size = get_value(size))
+        if 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
@@ -53,13 +69,16 @@ module ThemeCheck
 
     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
+    def get_setting_default_value(variable_lookup)
+      setting = @schema_settings.select { |s| s['id'] == variable_lookup.lookups.last }
+
+      # Setting does not exist.
+      return nil if setting.empty?
+
+      default_value = setting.last['default'].to_i
+      return nil if default_value == 0
+
+      default_value
     end
   end
 end

data/lib/theme_check/checks/remote_asset.rb

@@ -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 != "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/required_directories.rb

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

data/lib/theme_check/checks/space_inside_braces.rb

@@ -15,52 +15,57 @@ module ThemeCheck
       return if :assign == node.type_name
 
       outside_of_strings(node.markup) do |chunk, chunk_start|
-        chunk.scan(/([,:|]|==|<>|<=|>=|<|>|!=)  +/) do |_match|
+        chunk.scan(/([,:|]|==|<>|<=|>=|<|>|!=)(  +)/) do |_match|
           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)
+            markup: Regexp.last_match(2),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(2)
           )
         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),
+            markup: Regexp.last_match(1),
             node_markup_offset: chunk_start + Regexp.last_match.begin(0),
           )
         end
-        chunk.scan(/  (\||==|<>|<=|>=|<|>|!=)+/) do |_match|
+        chunk.scan(/(  +)(\||==|<>|<=|>=|<|>|!=)+/) do |_match|
           add_offense(
-            "Too many spaces before '#{Regexp.last_match(1)}'",
+            "Too many spaces before '#{Regexp.last_match(2)}'",
             node: node,
-            markup: Regexp.last_match(0),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+            markup: Regexp.last_match(1),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(1)
           )
         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),
-            node_markup_offset: chunk_start + Regexp.last_match.begin(0)
+            markup: Regexp.last_match(:match),
+            node_markup_offset: chunk_start + Regexp.last_match.begin(:match)
           )
         end
       end
     end
 
     def on_tag(node)
-      if node.inside_liquid_tag?
-        markup = if node.whitespace_trimmed?
-          "-%}"
-        else
-          "%}"
-        end
+      unless node.inside_liquid_tag?
         if node.markup[-1] != " " && node.markup[-1] != "\n"
-          add_offense("Space missing before '#{markup}'", node: node, markup: node.markup[-1] + markup)
+          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 '#{markup}'", node: node, markup: Regexp.last_match(2) + markup)
+          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
+          )
         end
       end
       @ignore = true
@@ -73,22 +78,40 @@ module ThemeCheck
     def on_variable(node)
       return if @ignore || node.markup.empty?
       if node.markup[0] != " "
-        add_offense("Space missing after '{{'", node: node) do |corrector|
+        add_offense(
+          "Space missing after '#{node.start_token}'",
+          node: node,
+          markup: node.markup[0]
+        ) do |corrector|
           corrector.insert_before(node, " ")
         end
       end
       if node.markup[-1] != " " && node.markup[-1] != "\n"
-        add_offense("Space missing before '}}'", node: node) do |corrector|
+        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
-      if node.markup[0] == " " && node.markup[1] == " "
-        add_offense("Too many spaces after '{{'", node: node) do |corrector|
+      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
-      if node.markup[-1] == " " && node.markup[-2] == " "
-        add_offense("Too many spaces before '}}'", node: node) do |corrector|
+      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

data/lib/theme_check/checks/template_length.rb

@@ -5,7 +5,7 @@ module ThemeCheck
     category :liquid
     doc docs_url(__FILE__)
 
-    def initialize(max_length: 500, exclude_schema: true, exclude_stylesheet: true, exclude_javascript: true)
+    def initialize(max_length: 600, exclude_schema: true, exclude_stylesheet: true, exclude_javascript: true)
       @max_length = max_length
       @exclude_schema = exclude_schema
       @exclude_stylesheet = exclude_stylesheet

data/lib/theme_check/cli.rb

@@ -78,6 +78,15 @@ module ThemeCheck
         "Print Theme Check version"
       ) { @command = :version }
 
+      if ENV["THEME_CHECK_DEBUG"]
+        @option_parser.separator("")
+        @option_parser.separator("Debugging:")
+        @option_parser.on(
+          "--profile",
+          "Output a profile to STDOUT compatible with FlameGraph."
+        ) { @command = :profile }
+      end
+
       @option_parser.separator("")
       @option_parser.separator(<<~EOS)
         Description:
@@ -172,7 +181,7 @@ module ThemeCheck
       puts option_parser.to_s
     end
 
-    def check
+    def check(out_stream = STDOUT)
       STDERR.puts "Checking #{@config.root} ..."
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)
       theme = ThemeCheck::Theme.new(storage)
@@ -182,18 +191,32 @@ module ThemeCheck
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme
       analyzer.correct_offenses
-      output_with_format(theme, analyzer)
+      output_with_format(theme, analyzer, out_stream)
       raise Abort, "" if analyzer.uncorrectable_offenses.any? do |offense|
         offense.check.severity_value <= Check.severity_value(@fail_level)
       end
     end
 
-    def output_with_format(theme, analyzer)
+    def profile
+      require 'ruby-prof-flamegraph'
+
+      result = RubyProf.profile do
+        check(STDERR)
+      end
+
+      # Print a graph profile to text
+      printer = RubyProf::FlameGraphPrinter.new(result)
+      printer.print(STDOUT, {})
+    rescue LoadError
+      STDERR.puts "Profiling is only available in development"
+    end
+
+    def output_with_format(theme, analyzer, out_stream)
       case @format
       when :text
-        ThemeCheck::Printer.new.print(theme, analyzer.offenses, @config.auto_correct)
+        ThemeCheck::Printer.new(out_stream).print(theme, analyzer.offenses, @config.auto_correct)
       when :json
-        ThemeCheck::JsonPrinter.new.print(analyzer.offenses)
+        ThemeCheck::JsonPrinter.new(out_stream).print(analyzer.offenses)
       end
     end
   end

data/lib/theme_check/corrector.rb

@@ -31,5 +31,14 @@ module ThemeCheck
     def create(theme, relative_path, content)
       theme.storage.write(relative_path, content)
     end
+
+    def create_default_locale_json(theme)
+      theme.default_locale_json = JsonFile.new("locales/#{theme.default_locale}.default.json", theme.storage)
+      theme.default_locale_json.update_contents('{}')
+    end
+
+    def mkdir(theme, relative_path)
+      theme.storage.mkdir(relative_path)
+    end
   end
 end

data/lib/theme_check/file_system_storage.rb

@@ -26,6 +26,12 @@ module ThemeCheck
       file(relative_path).write(content)
     end
 
+    def mkdir(relative_path)
+      reset_memoizers unless file_exists?(relative_path)
+
+      file(relative_path).mkpath unless file(relative_path).directory?
+    end
+
     def files
       @file_array ||= glob("**/*")
         .map { |path| path.relative_path_from(@root).to_s }

data/lib/theme_check/in_memory_storage.rb

@@ -23,6 +23,10 @@ module ThemeCheck
       @files[relative_path] = content
     end
 
+    def mkdir(relative_path)
+      @files[relative_path] = nil
+    end
+
     def files
       @files.keys
     end

data/lib/theme_check/json_file.rb

@@ -20,6 +20,17 @@ module ThemeCheck
       @parser_error
     end
 
+    def update_contents(new_content = '{}')
+      @content = new_content
+    end
+
+    def write
+      if source != @content
+        @storage.write(@relative_path, content)
+        @source = content
+      end
+    end
+
     def json?
       true
     end