theme-check 0.10.2 → 1.3.0

data/docs/checks/template_length.md

@@ -21,8 +21,10 @@ The default configuration for this check is the following:
 ```yaml
 TemplateLength:
   enabled: true
-  max_length: 200
+  max_length: 500
   exclude_schema: true
+  exclude_stylesheet: true
+  exclude_javascript: true
 ```
 
 ### `max_length`
@@ -31,7 +33,15 @@ The `max_length` (Default: `200`) option determines the maximum number of lines
 
 ### `exclude_schema`
 
-The `exclude_schema` (Default: `true`) option determines if the schema lines from a template should be excluded from the line count.
+The `exclude_schema` (Default: `true`) option determines if the lines inside `{% schema %}` blocks from a template should be excluded from the line count.
+
+### `exclude_stylesheet`
+
+The `exclude_stylesheet` (Default: `true`) option determines if the lines inside `{% stylesheet %}` blocks from a template should be excluded from the line count.
+
+### `exclude_javascript`
+
+The `exclude_javascript` (Default: `true`) option determines if the lines inside `{% javascript %}` blocks from a template should be excluded from the line count.
 
 ## When Not To Use It
 

data/docs/checks/undefined_object.md

@@ -33,8 +33,13 @@ The default configuration for this check is the following:
 ```yaml
 UndefinedObject:
   enabled: true
+  exclude_snippets: true
 ```
 
+### `exclude_snippets`
+
+The `exclude_snippets` (Default: `true`) option determines whether to check for undefined objects in snippets file (as objects _may_ be defined as arguments)
+
 ## When Not To Use It
 
 It is discouraged to disable this rule.

data/lib/theme_check/analyzer.rb

@@ -34,9 +34,11 @@ module ThemeCheck
 
       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)
+      ThemeCheck.with_liquid_c_disabled do
+        @theme.liquid.each do |template|
+          liquid_visitor.visit_template(template)
+          html_visitor.visit_template(template)
+        end
       end
 
       @theme.json.each { |json_file| @json_checks.call(:on_file, json_file) }
@@ -47,24 +49,26 @@ module ThemeCheck
     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)
+      ThemeCheck.with_liquid_c_disabled do
+        # 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
       end
 

data/lib/theme_check/asset_file.rb

@@ -1,27 +1,15 @@
 # frozen_string_literal: true
-require "pathname"
 require "zlib"
 
 module ThemeCheck
-  class AssetFile
+  class AssetFile < ThemeFile
     def initialize(relative_path, storage)
-      @relative_path = relative_path
-      @storage = storage
+      super
       @loaded = false
       @content = nil
     end
 
-    def path
-      @storage.path(@relative_path)
-    end
-
-    def relative_path
-      @relative_pathname ||= Pathname.new(@relative_path)
-    end
-
-    def content
-      @content ||= @storage.read(@relative_path)
-    end
+    alias_method :content, :source
 
     def gzipped_size
       @gzipped_size ||= Zlib.gzip(content).bytesize

data/lib/theme_check/bug.rb

@@ -2,6 +2,8 @@
 require 'theme_check/version'
 
 module ThemeCheck
+  class ThemeCheckError < StandardError; end
+
   BUG_POSTAMBLE = <<~EOS
     Theme Check Version: #{VERSION}
     Ruby Version: #{RUBY_VERSION}
@@ -15,6 +17,6 @@ module ThemeCheck
   EOS
 
   def self.bug(message)
-    abort(message + BUG_POSTAMBLE)
+    raise ThemeCheckError, message + BUG_POSTAMBLE
   end
 end

data/lib/theme_check/check.rb

@@ -9,12 +9,19 @@ module ThemeCheck
     attr_accessor :options, :ignored_patterns
     attr_writer :offenses
 
+    # The order matters.
     SEVERITIES = [
       :error,
       :suggestion,
       :style,
     ]
 
+    # [severity: sym] => number
+    SEVERITY_VALUES = SEVERITIES
+      .map
+      .with_index { |sev, i| [sev, i] }
+      .to_h
+
     CATEGORIES = [
       :liquid,
       :translation,
@@ -38,6 +45,10 @@ module ThemeCheck
         @severity if defined?(@severity)
       end
 
+      def severity_value(severity)
+        SEVERITY_VALUES[severity]
+      end
+
       def categories(*categories)
         @categories ||= []
         if categories.any?
@@ -58,7 +69,7 @@ module ThemeCheck
       end
 
       def docs_url(path)
-        "https://github.com/Shopify/theme-check/blob/master/docs/checks/#{File.basename(path, '.rb')}.md"
+        "https://github.com/Shopify/theme-check/blob/main/docs/checks/#{File.basename(path, '.rb')}.md"
       end
 
       def can_disable(disableable = nil)
@@ -80,12 +91,23 @@ module ThemeCheck
       @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)
+    def add_offense(message, node: nil, template: node&.template, markup: nil, line_number: nil, node_markup_offset: 0, &block)
+      offenses << Offense.new(check: self, message: message, template: template, node: node, markup: markup, line_number: line_number, node_markup_offset: node_markup_offset, correction: block)
     end
 
     def severity
-      self.class.severity
+      @severity ||= self.class.severity
+    end
+
+    def severity=(severity)
+      unless SEVERITIES.include?(severity)
+        raise ArgumentError, "unknown severity. Use: #{SEVERITIES.join(', ')}"
+      end
+      @severity = severity
+    end
+
+    def severity_value
+      SEVERITY_VALUES[severity]
     end
 
     def categories

data/lib/theme_check/checks/app_block_valid_tags.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when invalid tags are used in a Theme App
+  # Extension block
+  class AppBlockValidTags < LiquidCheck
+    severity :error
+    category :liquid
+    doc docs_url(__FILE__)
+
+    # Don't allow this check to be disabled with a comment,
+    # since we need to be able to enforce this server-side
+    can_disable false
+
+    OFFENSE_MSG = "Theme app extension blocks cannot contain %s tags"
+
+    def on_javascript(node)
+      add_offense(OFFENSE_MSG % 'javascript', node: node)
+    end
+
+    def on_stylesheet(node)
+      add_offense(OFFENSE_MSG % 'stylesheet', node: node)
+    end
+
+    def on_include(node)
+      add_offense(OFFENSE_MSG % 'include', node: node)
+    end
+
+    def on_layout(node)
+      add_offense(OFFENSE_MSG % 'layout', node: node)
+    end
+
+    def on_section(node)
+      add_offense(OFFENSE_MSG % 'section', node: node)
+    end
+  end
+end

data/lib/theme_check/checks/asset_size_app_block_css.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when too much CSS is being referenced from a Theme App
+  # Extension block
+  class AssetSizeAppBlockCSS < LiquidCheck
+    severity :error
+    category :performance
+    doc docs_url(__FILE__)
+
+    # Don't allow this check to be disabled with a comment,
+    # since we need to be able to enforce this server-side
+    can_disable false
+
+    attr_reader :threshold_in_bytes
+
+    def initialize(threshold_in_bytes: 100_000)
+      @threshold_in_bytes = threshold_in_bytes
+    end
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if (stylesheet = schema["stylesheet"])
+        size = asset_size(stylesheet)
+        if size && size > threshold_in_bytes
+          add_offense(
+            "CSS in Theme App Extension blocks exceeds compressed size threshold (#{threshold_in_bytes} Bytes)",
+            node: node
+          )
+        end
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    private
+
+    def asset_size(name)
+      asset = @theme["assets/#{name}"]
+      return if asset.nil?
+      asset.gzipped_size
+    end
+  end
+end

data/lib/theme_check/checks/asset_size_app_block_javascript.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module ThemeCheck
+  # Reports errors when too much JS is being referenced from a Theme App
+  # Extension block
+  class AssetSizeAppBlockJavaScript < LiquidCheck
+    severity :error
+    category :performance
+    doc docs_url(__FILE__)
+
+    # Don't allow this check to be disabled with a comment,
+    # since we need to be able to enforce this server-side
+    can_disable false
+
+    attr_reader :threshold_in_bytes
+
+    def initialize(threshold_in_bytes: 10_000)
+      @threshold_in_bytes = threshold_in_bytes
+    end
+
+    def on_schema(node)
+      schema = JSON.parse(node.value.nodelist.join)
+
+      if (javascript = schema["javascript"])
+        size = asset_size(javascript)
+        if size && size > threshold_in_bytes
+          add_offense(
+            "JavaScript in Theme App Extension blocks exceeds compressed size threshold (#{threshold_in_bytes} Bytes)",
+            node: node
+          )
+        end
+      end
+    rescue JSON::ParserError
+      # Ignored, handled in ValidSchema.
+    end
+
+    private
+
+    def asset_size(name)
+      asset = @theme["assets/#{name}"]
+      return if asset.nil?
+      asset.gzipped_size
+    end
+  end
+end

data/lib/theme_check/checks/asset_size_css.rb

@@ -1,89 +1,26 @@
 # frozen_string_literal: true
 module ThemeCheck
-  class AssetSizeCSS < LiquidCheck
+  class AssetSizeCSS < HtmlCheck
     include RegexHelpers
     severity :error
-    category :performance
+    category :html, :performance
     doc docs_url(__FILE__)
 
-    Link = Struct.new(:href, :index)
-
-    LINK_TAG_HREF = %r{
-      <link
-        (?=[^>]+?rel=['"]?stylesheet['"]?)    # Make sure rel=stylesheet is in the link with lookahead
-        [^>]+                                 # any non closing tag character
-        href=                                 # href attribute start
-        (?<href>#{QUOTED_LIQUID_ATTRIBUTE})   # href attribute value (may contain liquid)
-        [^>]*                                 # any non closing character till the end
-      >
-    }omix
-    STYLESHEET_TAG = %r{
-      #{Liquid::VariableStart}          # VariableStart
-      (?:(?!#{Liquid::VariableEnd}).)*? # anything that isn't followed by a VariableEnd
-      \|\s*asset_url\s*                 # | asset_url
-      \|\s*stylesheet_tag\s*            # | stylesheet_tag
-      #{Liquid::VariableEnd}            # VariableEnd
-    }omix
-
     attr_reader :threshold_in_bytes
 
     def initialize(threshold_in_bytes: 100_000)
       @threshold_in_bytes = threshold_in_bytes
     end
 
-    def on_document(node)
-      @node = node
-      @source = node.template.source
-      record_offenses
-    end
-
-    def record_offenses
-      stylesheets(@source).each do |stylesheet|
-        file_size = href_to_file_size(stylesheet.href)
-        next if file_size.nil?
-        next if file_size <= threshold_in_bytes
-        add_offense(
-          "CSS on every page load exceding compressed size threshold (#{threshold_in_bytes} Bytes).",
-          node: @node,
-          markup: stylesheet.href,
-          line_number: @source[0...stylesheet.index].count("\n") + 1
-        )
-      end
-    end
-
-    def stylesheets(source)
-      stylesheet_links = matches(source, LINK_TAG_HREF)
-        .map do |m|
-          Link.new(
-            m[:href].gsub(START_OR_END_QUOTE, ""),
-            m.begin(:href),
-          )
-        end
-
-      stylesheet_tags = matches(source, STYLESHEET_TAG)
-        .map do |m|
-          Link.new(
-            m[0],
-            m.begin(0),
-          )
-        end
-
-      stylesheet_links + stylesheet_tags
-    end
-
-    def href_to_file_size(href)
-      # asset_url (+ optional stylesheet_tag) variables
-      if href =~ /^#{VARIABLE}$/o && href =~ /asset_url/ && href =~ Liquid::QuotedString
-        asset_id = Regexp.last_match(0).gsub(START_OR_END_QUOTE, "")
-        asset = @theme.assets.find { |a| a.name.end_with?("/" + asset_id) }
-        return if asset.nil?
-        asset.gzipped_size
-
-      # remote URLs
-      elsif href =~ %r{^(https?:)?//}
-        asset = RemoteAssetFile.from_src(href)
-        asset.gzipped_size
-      end
+    def on_link(node)
+      return if node.attributes['rel'] != "stylesheet"
+      file_size = href_to_file_size(node.attributes['href'])
+      return if file_size.nil?
+      return if file_size <= threshold_in_bytes
+      add_offense(
+        "CSS on every page load exceeding compressed size threshold (#{threshold_in_bytes} Bytes)",
+        node: node
+      )
     end
   end
 end