theme-check 0.8.3 → 0.9.0

data/lib/theme_check/check.rb

@@ -6,7 +6,7 @@ module ThemeCheck
     include JsonHelpers
 
     attr_accessor :theme
-    attr_accessor :options
+    attr_accessor :options, :ignored_patterns
     attr_writer :offenses
 
     SEVERITIES = [
@@ -19,6 +19,7 @@ module ThemeCheck
       :liquid,
       :translation,
       :performance,
+      :html,
       :json,
       :performance,
     ]
@@ -67,12 +68,23 @@ module ThemeCheck
         end
         defined?(@can_disable) ? @can_disable : true
       end
+
+      def single_file(single_file = nil)
+        unless single_file.nil?
+          @single_file = single_file
+        end
+        defined?(@single_file) ? @single_file : !method_defined?(:on_end)
+      end
     end
 
     def offenses
       @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)
+    end
+
     def severity
       self.class.severity
     end
@@ -93,10 +105,6 @@ module ThemeCheck
       @ignored = true
     end
 
-    def unignore!
-      @ignored = false
-    end
-
     def ignored?
       defined?(@ignored) && @ignored
     end
@@ -105,9 +113,26 @@ module ThemeCheck
       self.class.can_disable
     end
 
+    def single_file?
+      self.class.single_file
+    end
+
+    def whole_theme?
+      !single_file?
+    end
+
+    def ==(other)
+      other.is_a?(Check) && code_name == other.code_name
+    end
+
     def to_s
       s = +"#{code_name}:\n"
-      properties = { severity: severity, categories: categories, doc: doc }.merge(options)
+      properties = {
+        severity: severity,
+        categories: categories,
+        doc: doc,
+        ignored_patterns: ignored_patterns,
+      }.merge(options)
       properties.each_pair do |name, value|
         s << "  #{name}: #{value}\n" if value
       end

data/lib/theme_check/checks.rb

@@ -13,7 +13,15 @@ module ThemeCheck
     end
 
     def disableable
-      self.class.new(select(&:can_disable?))
+      @disableable ||= self.class.new(select(&:can_disable?))
+    end
+
+    def whole_theme
+      @whole_theme ||= self.class.new(select(&:whole_theme?))
+    end
+
+    def single_file
+      @single_file ||= self.class.new(select(&:single_file?))
     end
 
     private

data/lib/theme_check/checks/content_for_header_modification.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class ContentForHeaderModification < LiquidCheck
+    severity :error
+    category :liquid
+    doc docs_url(__FILE__)
+
+    def initialize
+      @in_assign = false
+      @in_capture = false
+    end
+
+    def on_variable(node)
+      return unless node.value.name.is_a?(Liquid::VariableLookup)
+      return unless node.value.name.name == "content_for_header"
+
+      if @in_assign || @in_capture || node.value.filters.any?
+        add_offense(
+          "Do not rely on the content of `content_for_header`",
+          node: node,
+        )
+      end
+    end
+
+    def on_assign(_node)
+      @in_assign = true
+    end
+
+    def after_assign(_node)
+      @in_assign = false
+    end
+
+    def on_capture(_node)
+      @in_capture = true
+    end
+
+    def after_capture(_node)
+      @in_capture = false
+    end
+  end
+end

data/lib/theme_check/checks/img_width_and_height.rb

@@ -1,41 +1,21 @@
 # frozen_string_literal: true
 module ThemeCheck
   # Reports errors when trying to use parser-blocking script tags
-  class ImgWidthAndHeight < LiquidCheck
-    include RegexHelpers
+  class ImgWidthAndHeight < HtmlCheck
     severity :error
-    categories :liquid, :performance
+    categories :html, :performance
     doc docs_url(__FILE__)
 
-    # Not implemented with lookbehinds and lookaheads because performance was shit!
-    IMG_TAG = %r{<img#{HTML_ATTRIBUTES}/?>}oxim
-    SRC_ATTRIBUTE = /\s(src)=(#{QUOTED_LIQUID_ATTRIBUTE})/oxim
-    WIDTH_ATTRIBUTE = /\s(width)=(#{QUOTED_LIQUID_ATTRIBUTE})/oxim
-    HEIGHT_ATTRIBUTE = /\s(height)=(#{QUOTED_LIQUID_ATTRIBUTE})/oxim
-
-    FIELDS = [WIDTH_ATTRIBUTE, HEIGHT_ATTRIBUTE]
     ENDS_IN_CSS_UNIT = /(cm|mm|in|px|pt|pc|em|ex|ch|rem|vw|vh|vmin|vmax|%)$/i
 
-    def on_document(node)
-      @source = node.template.source
-      @node = node
-      record_offenses
-    end
+    def on_img(node)
+      width = node.attributes["width"]&.value
+      height = node.attributes["height"]&.value
 
-    private
+      record_units_in_field_offenses("width", width, node: node)
+      record_units_in_field_offenses("height", height, node: node)
 
-    def record_offenses
-      matches(@source, IMG_TAG).each do |img_match|
-        next unless img_match[0] =~ SRC_ATTRIBUTE
-        record_missing_field_offenses(img_match)
-        record_units_in_field_offenses(img_match)
-      end
-    end
-
-    def record_missing_field_offenses(img_match)
-      width = WIDTH_ATTRIBUTE.match(img_match[0])
-      height = HEIGHT_ATTRIBUTE.match(img_match[0])
-      return if width && height
+      return if node.attributes["src"].nil? || (width && height)
       missing_width = width.nil?
       missing_height = height.nil?
       error_message = if missing_width && missing_height
@@ -46,29 +26,18 @@ module ThemeCheck
         "Missing height attribute"
       end
 
-      add_offense(
-        error_message,
-        node: @node,
-        markup: img_match[0],
-        line_number: @source[0...img_match.begin(0)].count("\n") + 1
-      )
+      add_offense(error_message, node: node)
     end
 
-    def record_units_in_field_offenses(img_match)
-      FIELDS.each do |field|
-        field_match = field.match(img_match[0])
-        next if field_match.nil?
-        value = field_match[2].gsub(START_OR_END_QUOTE, '')
-        next unless value =~ ENDS_IN_CSS_UNIT
-        value_without_units = value.gsub(ENDS_IN_CSS_UNIT, '')
-        start = img_match.begin(0) + field_match.begin(2)
-        add_offense(
-          "The #{field_match[1]} attribute does not take units. Replace with \"#{value_without_units}\".",
-          node: @node,
-          markup: value,
-          line_number: @source[0...start].count("\n") + 1
-        )
-      end
+    private
+
+    def record_units_in_field_offenses(attribute, value, node:)
+      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}\".",
+        node: node,
+      )
     end
   end
 end

data/lib/theme_check/checks/missing_template.rb

@@ -5,6 +5,7 @@ module ThemeCheck
     severity :suggestion
     category :liquid
     doc docs_url(__FILE__)
+    single_file false
 
     def on_include(node)
       template = node.value.template_name_expr

data/lib/theme_check/checks/parser_blocking_javascript.rb

@@ -1,48 +1,16 @@
 # frozen_string_literal: true
 module ThemeCheck
   # Reports errors when trying to use parser-blocking script tags
-  class ParserBlockingJavaScript < LiquidCheck
-    include RegexHelpers
+  class ParserBlockingJavaScript < HtmlCheck
     severity :error
-    categories :liquid, :performance
+    categories :html, :performance
     doc docs_url(__FILE__)
 
-    PARSER_BLOCKING_SCRIPT_TAG = %r{
-      <script                                    # Find the start of a script tag
-      (?=[^>]+?src=)                             # Make sure src= is in the script with a lookahead
-      (?:(?!defer|async|type=["']module['"]).)*? # Find tags that don't have defer|async|type="module"
-      /?>
-    }xim
-    SCRIPT_TAG_FILTER = /\{\{[^}]+script_tag\s+\}\}/
+    def on_script(node)
+      return unless node.attributes["src"]
+      return if node.attributes["defer"] || node.attributes["async"] || node.attributes["type"]&.value == "module"
 
-    def on_document(node)
-      @source = node.template.source
-      @node = node
-      record_offenses
-    end
-
-    private
-
-    def record_offenses
-      record_offenses_from_regex(
-        message: "Missing async or defer attribute on script tag",
-        regex: PARSER_BLOCKING_SCRIPT_TAG,
-      )
-      record_offenses_from_regex(
-        message: "The script_tag filter is parser-blocking. Use a script tag with the async or defer attribute for better performance",
-        regex: SCRIPT_TAG_FILTER,
-      )
-    end
-
-    def record_offenses_from_regex(regex: nil, message: nil)
-      matches(@source, regex).each do |match|
-        add_offense(
-          message,
-          node: @node,
-          markup: match[0],
-          line_number: @source[0...match.begin(0)].count("\n") + 1
-        )
-      end
+      add_offense("Missing async or defer attribute on script tag", node: node)
     end
   end
 end

data/lib/theme_check/checks/parser_blocking_script_tag.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when trying to use parser-blocking script tags
+  class ParserBlockingScriptTag < LiquidCheck
+    severity :error
+    categories :liquid, :performance
+    doc docs_url(__FILE__)
+
+    def on_variable(node)
+      used_filters = node.value.filters.map { |name, *_rest| name }
+      if used_filters.include?("script_tag")
+        add_offense(
+          "The script_tag filter is parser-blocking. Use a script tag with the async or defer " \
+          "attribute for better performance",
+          node: node
+        )
+      end
+    end
+  end
+end

data/lib/theme_check/checks/template_length.rb

@@ -8,6 +8,9 @@ module ThemeCheck
     def initialize(max_length: 200, exclude_schema: true)
       @max_length = max_length
       @exclude_schema = exclude_schema
+    end
+
+    def on_document(_node)
       @excluded_lines = 0
     end
 

data/lib/theme_check/checks/valid_html_translation.rb

@@ -5,6 +5,7 @@ require 'nokogumbo'
 module ThemeCheck
   class ValidHTMLTranslation < JsonCheck
     severity :suggestion
+    category :translation
     doc docs_url(__FILE__)
 
     def on_file(file)

data/lib/theme_check/config.rb

@@ -91,11 +91,13 @@ module ThemeCheck
 
         options_for_check = options.transform_keys(&:to_sym)
         options_for_check.delete(:enabled)
+        ignored_patterns = options_for_check.delete(:ignore) || []
         check = if options_for_check.empty?
           check_class.new
         else
           check_class.new(**options_for_check)
         end
+        check.ignored_patterns = ignored_patterns
         check.options = options_for_check
         check
       end.compact

data/lib/theme_check/disabled_check.rb

@@ -4,10 +4,11 @@
 # We'll use the node position to figure out if the test is disabled or not.
 module ThemeCheck
   class DisabledCheck
-    attr_reader :name, :ranges
+    attr_reader :name, :template, :ranges
     attr_accessor :first_line
 
-    def initialize(name)
+    def initialize(template, name)
+      @template = template
       @name = name
       @ranges = []
       @first_line = false
@@ -24,7 +25,8 @@ module ThemeCheck
     end
 
     def disabled?(index)
-      ranges.any? { |range| range.cover?(index) }
+      index == 0 && first_line ||
+        ranges.any? { |range| range.cover?(index) }
     end
 
     def last
@@ -33,7 +35,7 @@ module ThemeCheck
 
     def missing_end_index?
       return false if first_line && ranges.size == 1
-      last.end.nil?
+      last&.end.nil?
     end
   end
 end

data/lib/theme_check/disabled_checks.rb

@@ -10,28 +10,36 @@ module ThemeCheck
     ACTION_ENABLE_CHECKS = :enable
 
     def initialize
-      @disabled_checks = {}
+      @disabled_checks = Hash.new do |hash, key|
+        template, check_name = key
+        hash[key] = DisabledCheck.new(template, check_name)
+      end
     end
 
     def update(node)
       text = comment_text(node)
       if start_disabling?(text)
         checks_from_text(text).each do |check_name|
-          @disabled_checks[check_name] ||= DisabledCheck.new(check_name)
-          @disabled_checks[check_name].start_index = node.start_index
-          @disabled_checks[check_name].first_line = true if node.line_number == 1
+          disabled = @disabled_checks[[node.template, check_name]]
+          disabled.start_index = node.start_index
+          disabled.first_line = true if node.line_number == 1
         end
       elsif stop_disabling?(text)
         checks_from_text(text).each do |check_name|
-          next unless @disabled_checks.key?(check_name)
-          @disabled_checks[check_name].end_index = node.end_index
+          disabled = @disabled_checks[[node.template, check_name]]
+          next unless disabled
+          disabled.end_index = node.end_index
         end
       end
     end
 
-    def disabled?(key, index)
-      @disabled_checks[:all]&.disabled?(index) ||
-        @disabled_checks[key]&.disabled?(index)
+    def disabled?(check, template, check_name, index)
+      return true if check.ignored_patterns&.any? do |pattern|
+        template.relative_path.fnmatch?(pattern)
+      end
+
+      @disabled_checks[[template, :all]]&.disabled?(index) ||
+        @disabled_checks[[template, check_name]]&.disabled?(index)
     end
 
     def checks_missing_end_index
@@ -40,6 +48,14 @@ module ThemeCheck
         .map(&:name)
     end
 
+    def remove_disabled_offenses(checks)
+      checks.disableable.each do |check|
+        check.offenses.reject! do |offense|
+          disabled?(check, offense.template, offense.code_name, offense.start_index)
+        end
+      end
+    end
+
     private
 
     def comment_text(node)

data/lib/theme_check/html_check.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  class HtmlCheck < Check
+    extend ChecksTracking
+  end
+end