theme-check 0.8.0 → 0.9.1

data/exe/theme-check-language-server

@@ -6,7 +6,6 @@ require 'theme_check'
 if ENV["THEME_CHECK_DEBUG"] == "true"
   $DEBUG = true
 end
-# Force encoding to UTF-8 to fix VSCode
-Encoding.default_external = Encoding::UTF_8
+
 status_code = ThemeCheck::LanguageServer.start
 exit! status_code

data/lib/theme_check.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 require "liquid"
 
+require_relative "theme_check/version"
+require_relative "theme_check/bug"
+require_relative "theme_check/exceptions"
 require_relative "theme_check/analyzer"
 require_relative "theme_check/check"
 require_relative "theme_check/checks_tracking"
 require_relative "theme_check/cli"
+require_relative "theme_check/disabled_check"
 require_relative "theme_check/disabled_checks"
 require_relative "theme_check/liquid_check"
 require_relative "theme_check/locale_diff"
@@ -14,6 +18,8 @@ require_relative "theme_check/regex_helpers"
 require_relative "theme_check/json_check"
 require_relative "theme_check/json_file"
 require_relative "theme_check/json_helpers"
+require_relative "theme_check/position_helper"
+require_relative "theme_check/position"
 require_relative "theme_check/language_server"
 require_relative "theme_check/checks"
 require_relative "theme_check/config"
@@ -30,6 +36,12 @@ require_relative "theme_check/template"
 require_relative "theme_check/theme"
 require_relative "theme_check/visitor"
 require_relative "theme_check/corrector"
-require_relative "theme_check/version"
+require_relative "theme_check/html_node"
+require_relative "theme_check/html_visitor"
+require_relative "theme_check/html_check"
 
 Dir[__dir__ + "/theme_check/checks/*.rb"].each { |file| require file }
+
+# UTF-8 is the default internal and external encoding, like in Rails & Shopify.
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8

data/lib/theme_check/analyzer.rb

@@ -1,53 +1,119 @@
 # frozen_string_literal: true
 module ThemeCheck
   class Analyzer
-    attr_reader :offenses
-
     def initialize(theme, checks = Check.all.map(&:new), auto_correct = false)
       @theme = theme
-      @offenses = []
       @auto_correct = auto_correct
 
       @liquid_checks = Checks.new
       @json_checks = Checks.new
+      @html_checks = Checks.new
 
       checks.each do |check|
         check.theme = @theme
-        check.offenses = @offenses
 
         case check
         when LiquidCheck
           @liquid_checks << check
         when JsonCheck
           @json_checks << check
+        when HtmlCheck
+          @html_checks << check
         end
       end
+    end
 
-      @visitor = Visitor.new(@liquid_checks)
+    def offenses
+      @liquid_checks.flat_map(&:offenses) +
+        @json_checks.flat_map(&:offenses) +
+        @html_checks.flat_map(&:offenses)
     end
 
     def analyze_theme
-      @offenses.clear
-      @theme.liquid.each { |template| @visitor.visit_template(template) }
+      reset
+
+      liquid_visitor = Visitor.new(@liquid_checks, @disabled_checks)
+      html_visitor = HtmlVisitor.new(@html_checks)
+      @theme.liquid.each do |template|
+        liquid_visitor.visit_template(template)
+        html_visitor.visit_template(template)
+      end
+
       @theme.json.each { |json_file| @json_checks.call(:on_file, json_file) }
-      @liquid_checks.call(:on_end)
-      @json_checks.call(:on_end)
-      @offenses
+
+      finish
+    end
+
+    def analyze_files(files)
+      reset
+
+      # Call all checks that run on the whole theme
+      liquid_visitor = Visitor.new(@liquid_checks.whole_theme, @disabled_checks)
+      html_visitor = HtmlVisitor.new(@html_checks.whole_theme)
+      @theme.liquid.each do |template|
+        liquid_visitor.visit_template(template)
+        html_visitor.visit_template(template)
+      end
+      @theme.json.each { |json_file| @json_checks.whole_theme.call(:on_file, json_file) }
+
+      # Call checks that run on a single files, only on specified file
+      liquid_visitor = Visitor.new(@liquid_checks.single_file, @disabled_checks)
+      html_visitor = HtmlVisitor.new(@html_checks.single_file)
+      files.each do |file|
+        if file.liquid?
+          liquid_visitor.visit_template(file)
+          html_visitor.visit_template(file)
+        elsif file.json?
+          @json_checks.single_file.call(:on_file, file)
+        end
+      end
+
+      finish
     end
 
     def uncorrectable_offenses
       unless @auto_correct
-        return @offenses
+        return offenses
       end
 
-      @offenses.select { |offense| !offense.correctable? }
+      offenses.select { |offense| !offense.correctable? }
     end
 
     def correct_offenses
       if @auto_correct
-        @offenses.each(&:correct)
+        offenses.each(&:correct)
         @theme.liquid.each(&:write)
       end
     end
+
+    private
+
+    def reset
+      @disabled_checks = DisabledChecks.new
+
+      @liquid_checks.each do |check|
+        check.offenses.clear
+      end
+
+      @html_checks.each do |check|
+        check.offenses.clear
+      end
+
+      @json_checks.each do |check|
+        check.offenses.clear
+      end
+    end
+
+    def finish
+      @liquid_checks.call(:on_end)
+      @html_checks.call(:on_end)
+      @json_checks.call(:on_end)
+
+      @disabled_checks.remove_disabled_offenses(@liquid_checks)
+      @disabled_checks.remove_disabled_offenses(@json_checks)
+      @disabled_checks.remove_disabled_offenses(@html_checks)
+
+      offenses
+    end
   end
 end

data/lib/theme_check/bug.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'theme_check/version'
+
+module ThemeCheck
+  BUG_POSTAMBLE = <<~EOS
+    Theme Check Version: #{VERSION}
+    Ruby Version: #{RUBY_VERSION}
+    Platform: #{RUBY_PLATFORM}
+    Muffin mode: activated
+
+    ------------------------
+    Whoops! It looks like you found a bug in Theme Check.
+    Please report it at https://github.com/Shopify/theme-check/issues, and include the message above.
+    Or cross your fingers real hard, and try again.
+  EOS
+
+  def self.bug(message)
+    abort(message + BUG_POSTAMBLE)
+  end
+end

data/lib/theme_check/check.rb

@@ -6,8 +6,8 @@ module ThemeCheck
     include JsonHelpers
 
     attr_accessor :theme
-    attr_accessor :offenses
-    attr_accessor :options
+    attr_accessor :options, :ignored_patterns
+    attr_writer :offenses
 
     SEVERITIES = [
       :error,
@@ -19,6 +19,7 @@ module ThemeCheck
       :liquid,
       :translation,
       :performance,
+      :html,
       :json,
       :performance,
     ]
@@ -67,6 +68,21 @@ 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
@@ -89,10 +105,6 @@ module ThemeCheck
       @ignored = true
     end
 
-    def unignore!
-      @ignored = false
-    end
-
     def ignored?
       defined?(@ignored) && @ignored
     end
@@ -101,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

@@ -1,22 +1,61 @@
 # frozen_string_literal: true
+require "pp"
+require "timeout"
+
 module ThemeCheck
   class Checks < Array
+    CHECK_METHOD_TIMEOUT = 5 # sec
+
     def call(method, *args)
       each do |check|
-        if check.respond_to?(method) && !check.ignored?
-          check.send(method, *args)
-        end
+        call_check_method(check, method, *args)
       end
     end
 
-    def always_enabled
-      self.class.new(reject(&:can_disable?))
+    def disableable
+      @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
 
-    def except_for(disabled_checks)
-      still_enabled = reject { |check| disabled_checks.all.include?(check.code_name) }
+    private
+
+    def call_check_method(check, method, *args)
+      return unless check.respond_to?(method) && !check.ignored?
+
+      Timeout.timeout(CHECK_METHOD_TIMEOUT) do
+        check.send(method, *args)
+      end
+    rescue Liquid::Error
+      # Pass-through Liquid errors
+      raise
+    rescue => e
+      node = args.first
+      template = node.respond_to?(:template) ? node.template.relative_path : "?"
+      markup = node.respond_to?(:markup) ? node.markup : ""
+      node_class = node.respond_to?(:value) ? node.value.class : "?"
+
+      ThemeCheck.bug(<<~EOS)
+        Exception while running `#{check.code_name}##{method}`:
+        ```
+        #{e.class}: #{e.message}
+          #{e.backtrace.join("\n  ")}
+        ```
 
-      self.class.new((always_enabled + still_enabled).uniq)
+        Template: `#{template}`
+        Node: `#{node_class}`
+        Markup:
+        ```
+        #{markup}
+        ```
+        Check options: `#{check.options.pretty_inspect}`
+      EOS
     end
   end
 end

data/lib/theme_check/checks/asset_url_filters.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module ThemeCheck
+  class AssetUrlFilters < LiquidCheck
+    severity :suggestion
+    categories :liquid, :performance
+    doc docs_url(__FILE__)
+
+    HTML_FILTERS = [
+      'stylesheet_tag',
+      'script_tag',
+      'img_tag',
+    ]
+    ASSET_URL_FILTERS = [
+      'asset_url',
+      'asset_img_url',
+      'file_img_url',
+      'file_url',
+      'global_asset_url',
+      'img_url',
+      'payment_type_img_url',
+      'shopify_asset_url',
+    ]
+
+    def on_variable(node)
+      record_variable_offense(node)
+    end
+
+    private
+
+    def record_variable_offense(variable_node)
+      # We flag HTML tags with URLs not hosted by Shopify
+      return if !html_resource_drop?(variable_node) || variable_hosted_by_shopify?(variable_node)
+      add_offense("Use one of the asset_url filters to serve assets", node: variable_node)
+    end
+
+    def html_resource_drop?(variable_node)
+      variable_node.value.filters
+        .any? { |(filter_name, *_filter_args)| HTML_FILTERS.include?(filter_name) }
+    end
+
+    def variable_hosted_by_shopify?(variable_node)
+      variable_node.value.filters
+        .any? { |(filter_name, *_filter_args)| ASSET_URL_FILTERS.include?(filter_name) }
+    end
+  end
+end

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