theme-check 0.3.1 → 0.6.0

data/lib/theme_check/checks/default_locale.rb

@@ -3,6 +3,7 @@ module ThemeCheck
   class DefaultLocale < JsonCheck
     severity :suggestion
     category :translation
+    doc docs_url(__FILE__)
 
     def on_end
       return if @theme.default_locale_json

data/lib/theme_check/checks/deprecated_filter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module ThemeCheck
   class DeprecatedFilter < LiquidCheck
-    doc "https://shopify.dev/docs/themes/liquid/reference/filters/deprecated-filters"
+    doc docs_url(__FILE__)
     category :liquid
     severity :suggestion
 

data/lib/theme_check/checks/img_width_and_height.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when trying to use parser-blocking script tags
+  class ImgWidthAndHeight < LiquidCheck
+    include RegexHelpers
+    severity :error
+    categories :liquid, :performance
+    doc docs_url(__FILE__)
+
+    # Not implemented with lookbehinds and lookaheads because performance was shit!
+    IMG_TAG = /<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
+
+    private
+
+    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.present? && height.present?
+      missing_width = width.nil?
+      missing_height = height.nil?
+      error_message = if missing_width && missing_height
+        "Missing width and height attributes"
+      elsif missing_width
+        "Missing width attribute"
+      elsif missing_height
+        "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
+      )
+    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
+    end
+  end
+end

data/lib/theme_check/checks/liquid_tag.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 module ThemeCheck
-  # Recommends using {% liquid ... %} if 3 or more consecutive {% ... %} are found.
+  # Recommends using {% liquid ... %} if 4 or more consecutive {% ... %} are found.
   class LiquidTag < LiquidCheck
     severity :suggestion
     category :liquid
-    doc "https://shopify.dev/docs/themes/liquid/reference/tags/theme-tags#liquid"
+    doc docs_url(__FILE__)
 
-    def initialize(min_consecutive_statements: 10)
+    def initialize(min_consecutive_statements: 4)
       @first_statement = nil
       @consecutive_statements = 0
       @min_consecutive_statements = min_consecutive_statements

data/lib/theme_check/checks/matching_schema_translations.rb

@@ -3,6 +3,7 @@ module ThemeCheck
   class MatchingSchemaTranslations < LiquidCheck
     severity :suggestion
     category :translation
+    doc docs_url(__FILE__)
 
     def on_schema(node)
       schema = JSON.parse(node.value.nodelist.join)

data/lib/theme_check/checks/matching_translations.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class MatchingTranslations < JsonCheck
     severity :suggestion
     category :translation
+    doc docs_url(__FILE__)
 
     def initialize
       @files = []

data/lib/theme_check/checks/missing_enable_comment.rb

@@ -2,6 +2,7 @@
 module ThemeCheck
   class MissingEnableComment < LiquidCheck
     severity :error
+    doc docs_url(__FILE__)
 
     # Don't allow this check to be disabled with a comment,
     # as we need to be able to check for disabled checks.

data/lib/theme_check/checks/missing_required_template_files.rb

@@ -3,11 +3,10 @@
 module ThemeCheck
   # Reports missing shopify required theme files
   # required templates: https://shopify.dev/tutorials/review-theme-store-requirements-files
-
   class MissingRequiredTemplateFiles < LiquidCheck
     severity :error
     category :liquid
-    doc "https://shopify.dev/docs/themes/theme-templates"
+    doc docs_url(__FILE__)
 
     REQUIRED_LIQUID_FILES = %w(layout/theme)
     REQUIRED_TEMPLATE_FILES = %w(

data/lib/theme_check/checks/missing_template.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class MissingTemplate < LiquidCheck
     severity :suggestion
     category :liquid
+    doc docs_url(__FILE__)
 
     def on_include(node)
       template = node.value.template_name_expr

data/lib/theme_check/checks/nested_snippet.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class NestedSnippet < LiquidCheck
     severity :suggestion
     category :liquid
+    doc docs_url(__FILE__)
 
     class TemplateInfo < Struct.new(:includes)
       def with_deep_nested(templates, max, current_level = 0)

data/lib/theme_check/checks/parser_blocking_javascript.rb

@@ -2,12 +2,14 @@
 module ThemeCheck
   # Reports errors when trying to use parser-blocking script tags
   class ParserBlockingJavaScript < LiquidCheck
+    include RegexHelpers
     severity :error
-    category :liquid
+    categories :liquid, :performance
+    doc docs_url(__FILE__)
 
     PARSER_BLOCKING_SCRIPT_TAG = %r{
       <script                                    # Find the start of a script tag
-      (?=(?:[^>]|\n|\r)+?src=)+?                 # Make sure src= is in the script with a lookahead
+      (?=[^>]+?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
@@ -32,23 +34,14 @@ module ThemeCheck
       )
     end
 
-    # The trickiness here is matching on scripts that are defined on
-    # multiple lines (or repeat matches). This makes the line_number
-    # calculation a bit weird. So instead, we traverse the string in
-    # a very imperative way.
     def record_offenses_from_regex(regex: nil, message: nil)
-      i = 0
-      while (i = @source.index(regex, i))
-        script = @source.match(regex, i)[0]
-
+      matches(@source, regex).each do |match|
         add_offense(
           message,
           node: @node,
-          markup: script,
-          line_number: @source[0...i].count("\n") + 1
+          markup: match[0],
+          line_number: @source[0...match.begin(0)].count("\n") + 1
         )
-
-        i += script.size
       end
     end
   end

data/lib/theme_check/checks/required_directories.rb

@@ -5,7 +5,7 @@ module ThemeCheck
   class RequiredDirectories < LiquidCheck
     severity :error
     category :liquid
-    doc "https://shopify.dev/tutorials/develop-theme-files"
+    doc docs_url(__FILE__)
 
     REQUIRED_DIRECTORIES = %w(assets config layout locales sections snippets templates)
 

data/lib/theme_check/checks/required_layout_theme_object.rb

@@ -4,7 +4,7 @@ module ThemeCheck
   class RequiredLayoutThemeObject < LiquidCheck
     severity :error
     category :liquid
-    doc "https://shopify.dev/docs/themes/theme-templates/theme-liquid"
+    doc docs_url(__FILE__)
 
     LAYOUT_FILENAME = "layout/theme"
 

data/lib/theme_check/checks/space_inside_braces.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class SpaceInsideBraces < LiquidCheck
     severity :style
     category :liquid
+    doc docs_url(__FILE__)
 
     def initialize
       @ignore = false

data/lib/theme_check/checks/syntax_error.rb

@@ -4,6 +4,7 @@ module ThemeCheck
   class SyntaxError < LiquidCheck
     severity :error
     category :liquid
+    doc docs_url(__FILE__)
 
     def on_document(node)
       node.template.warnings.each do |warning|

data/lib/theme_check/checks/template_length.rb

@@ -3,6 +3,7 @@ module ThemeCheck
   class TemplateLength < LiquidCheck
     severity :suggestion
     category :liquid
+    doc docs_url(__FILE__)
 
     def initialize(max_length: 200, exclude_schema: true)
       @max_length = max_length

data/lib/theme_check/checks/translation_key_exists.rb

@@ -1,8 +1,24 @@
 # frozen_string_literal: true
 module ThemeCheck
+  module SystemTranslations
+    extend self
+
+    def translations
+      @translations ||= begin
+        # loaded as a Set because the include? lookup will be much faster.
+        YAML.load(File.read("#{__dir__}/../../../data/shopify_translation_keys.yml")).to_set
+      end
+    end
+
+    def include?(key)
+      translations.include?(key)
+    end
+  end
+
   class TranslationKeyExists < LiquidCheck
     severity :error
     category :translation
+    doc docs_url(__FILE__)
 
     def on_variable(node)
       return unless @theme.default_locale_json&.content&.is_a?(Hash)
@@ -11,7 +27,7 @@ module ThemeCheck
       return unless (key_node = node.children.first)
       return unless key_node.value.is_a?(String)
 
-      unless key_exists?(key_node.value)
+      unless key_exists?(key_node.value) || 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,

data/lib/theme_check/checks/undefined_object.rb

@@ -2,7 +2,7 @@
 module ThemeCheck
   class UndefinedObject < LiquidCheck
     category :liquid
-    doc "https://shopify.dev/docs/themes/liquid/reference/objects"
+    doc docs_url(__FILE__)
     severity :error
 
     class TemplateInfo
@@ -21,7 +21,13 @@ module ThemeCheck
       end
 
       def add_variable_lookup(name:, node:)
-        line_number = node.parent.line_number
+        parent = node
+        line_number = nil
+        loop do
+          line_number = parent.line_number
+          parent = parent.parent
+          break unless line_number.nil? && parent
+        end
         key = [name, line_number]
         @all_variable_lookups[key] = node
       end
@@ -49,23 +55,28 @@ module ThemeCheck
       end
     end
 
-    def initialize
+    def initialize(exclude_snippets: false)
+      @exclude_snippets = exclude_snippets
       @files = {}
     end
 
     def on_document(node)
+      return if ignore?(node)
       @files[node.template.name] = TemplateInfo.new
     end
 
     def on_assign(node)
+      return if ignore?(node)
       @files[node.template.name].all_assigns[node.value.to] = node
     end
 
     def on_capture(node)
+      return if ignore?(node)
       @files[node.template.name].all_captures[node.value.instance_variable_get('@to')] = node
     end
 
     def on_for(node)
+      return if ignore?(node)
       @files[node.template.name].all_forloops[node.value.variable_name] = node
     end
 
@@ -75,6 +86,7 @@ module ThemeCheck
     end
 
     def on_render(node)
+      return if ignore?(node)
       return unless node.value.template_name_expr.is_a?(String)
 
       snippet_name = "snippets/#{node.value.template_name_expr}"
@@ -85,6 +97,7 @@ module ThemeCheck
     end
 
     def on_variable_lookup(node)
+      return if ignore?(node)
       @files[node.template.name].add_variable_lookup(
         name: node.value.name,
         node: node,
@@ -114,15 +127,20 @@ module ThemeCheck
       end
     end
 
+    private
+
+    def ignore?(node)
+      @exclude_snippets && node.template.snippet?
+    end
+
     def each_template
       @files.each do |(name, info)|
         next if name.starts_with?('snippets/')
         yield [name, info]
       end
     end
-    private :each_template
 
-    def check_object(info, all_global_objects, render_node = nil)
+    def check_object(info, all_global_objects, render_node = nil, visited_snippets = Set.new)
       check_undefined(info, all_global_objects, render_node)
 
       info.each_snippet do |(snippet_name, node)|
@@ -131,16 +149,18 @@ module ThemeCheck
 
         snippet_variables = node.value.attributes.keys +
           Array[node.value.instance_variable_get("@alias_name")]
-        check_object(snippet_info, all_global_objects + snippet_variables, node)
+        unless visited_snippets.include?(snippet_name)
+          visited_snippets << snippet_name
+          check_object(snippet_info, all_global_objects + snippet_variables, node, visited_snippets)
+        end
       end
     end
-    private :check_object
 
     def check_undefined(info, all_global_objects, render_node)
       all_variables = info.all_variables
 
       info.each_variable_lookup(!!render_node) do |(key, node)|
-        name, _line_number = key
+        name, line_number = key
         next if all_variables.include?(name)
         next if all_global_objects.include?(name)
 
@@ -150,10 +170,9 @@ module ThemeCheck
         if render_node
           add_offense("Missing argument `#{name}`", node: render_node)
         else
-          add_offense("Undefined object `#{name}`", node: node)
+          add_offense("Undefined object `#{name}`", node: node, line_number: line_number)
         end
       end
     end
-    private :check_undefined
   end
 end

data/lib/theme_check/checks/unknown_filter.rb

@@ -12,6 +12,7 @@ module ThemeCheck
   class UnknownFilter < LiquidCheck
     severity :error
     category :liquid
+    doc docs_url(__FILE__)
 
     def on_variable(node)
       used_filters = node.value.filters.map { |name, *_rest| name }

data/lib/theme_check/checks/unused_assign.rb

@@ -4,14 +4,16 @@ module ThemeCheck
   class UnusedAssign < LiquidCheck
     severity :suggestion
     category :liquid
+    doc docs_url(__FILE__)
 
     class TemplateInfo < Struct.new(:used_assigns, :assign_nodes, :includes)
-      def collect_used_assigns(templates)
+      def collect_used_assigns(templates, visited = Set.new)
         collected = used_assigns
         # Check recursively inside included snippets for use
         includes.each do |name|
-          if templates[name]
-            collected += templates[name].collect_used_assigns(templates)
+          if templates[name] && !visited.include?(name)
+            visited << name
+            collected += templates[name].collect_used_assigns(templates, visited)
           end
         end
         collected