theme-check 0.10.1 → 1.2.0

data/lib/theme_check/checks/liquid_tag.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 module ThemeCheck
-  # Recommends using {% liquid ... %} if 4 or more consecutive {% ... %} are found.
+  # Recommends using {% liquid ... %} if 5 or more consecutive {% ... %} are found.
   class LiquidTag < LiquidCheck
     severity :suggestion
     category :liquid
     doc docs_url(__FILE__)
 
-    def initialize(min_consecutive_statements: 4)
+    def initialize(min_consecutive_statements: 5)
       @first_statement = nil
       @consecutive_statements = 0
       @min_consecutive_statements = min_consecutive_statements

data/lib/theme_check/checks/remote_asset.rb

@@ -9,6 +9,7 @@ module ThemeCheck
     PROTOCOL = %r{(https?:)?//}
     ABSOLUTE_PATH = %r{\A/[^/]}im
     RELATIVE_PATH = %r{\A(?!#{PROTOCOL})[^/\{]}oim
+    CDN_ROOT = "https://cdn.shopify.com/"
 
     def on_element(node)
       return unless TAGS.include?(node.name)
@@ -17,6 +18,7 @@ module ThemeCheck
       return if resource_url.nil? || resource_url.empty?
 
       # Ignore if URL is Liquid, taken care of by AssetUrlFilters check
+      return if resource_url.start_with?(CDN_ROOT)
       return if resource_url =~ ABSOLUTE_PATH
       return if resource_url =~ RELATIVE_PATH
       return if url_hosted_by_shopify?(resource_url)

data/lib/theme_check/checks/space_inside_braces.rb

@@ -51,7 +51,7 @@ module ThemeCheck
     end
 
     def on_variable(node)
-      return if @ignore
+      return if @ignore || node.markup.empty?
       if node.markup[0] != " "
         add_offense("Space missing after '{{'", node: node) do |corrector|
           corrector.insert_before(node, " ")

data/lib/theme_check/checks/template_length.rb

@@ -5,9 +5,11 @@ module ThemeCheck
     category :liquid
     doc docs_url(__FILE__)
 
-    def initialize(max_length: 200, exclude_schema: true)
+    def initialize(max_length: 500, exclude_schema: true, exclude_stylesheet: true, exclude_javascript: true)
       @max_length = max_length
       @exclude_schema = exclude_schema
+      @exclude_stylesheet = exclude_stylesheet
+      @exclude_javascript = exclude_javascript
     end
 
     def on_document(_node)
@@ -15,9 +17,15 @@ module ThemeCheck
     end
 
     def on_schema(node)
-      if @exclude_schema
-        @excluded_lines += node.value.nodelist.join.count("\n")
-      end
+      exclude_node_lines(node) if @exclude_schema
+    end
+
+    def on_stylesheet(node)
+      exclude_node_lines(node) if @exclude_stylesheet
+    end
+
+    def on_javascript(node)
+      exclude_node_lines(node) if @exclude_javascript
     end
 
     def after_document(node)
@@ -26,5 +34,11 @@ module ThemeCheck
         add_offense("Template has too many lines [#{lines}/#{@max_length}]", template: node.template)
       end
     end
+
+    private
+
+    def exclude_node_lines(node)
+      @excluded_lines += node.value.nodelist.join.count("\n")
+    end
   end
 end

data/lib/theme_check/cli.rb

@@ -10,10 +10,11 @@ module ThemeCheck
     def initialize
       @path = "."
       @command = :check
-      @only_categories = []
+      @include_categories = []
       @exclude_categories = []
       @auto_correct = false
       @config_path = nil
+      @fail_level = :error
     end
 
     def option_parser(parser = OptionParser.new, help: true)
@@ -25,20 +26,27 @@ module ThemeCheck
       @option_parser.separator("Basic Options:")
       @option_parser.on(
         "-C", "--config PATH",
-        "Use the config provided, overriding .theme-check.yml if present"
+        "Use the config provided, overriding .theme-check.yml if present",
+        "Use :theme_app_extension to use default checks for theme app extensions"
       ) { |path| @config_path = path }
       @option_parser.on(
-        "-c", "--category CATEGORY",
-        "Only run this category of checks"
-      ) { |category| @only_categories << category.to_sym }
+        "-c", "--category CATEGORY", Check::CATEGORIES, "Only run this category of checks",
+        "Runs checks matching all categories when specified more than once"
+      ) { |category| @include_categories << category.to_sym }
       @option_parser.on(
-        "-x", "--exclude-category CATEGORY",
-        "Exclude this category of checks"
+        "-x", "--exclude-category CATEGORY", Check::CATEGORIES, "Exclude this category of checks",
+        "Excludes checks matching any category when specified more than once"
       ) { |category| @exclude_categories << category.to_sym }
       @option_parser.on(
         "-a", "--auto-correct",
         "Automatically fix offenses"
       ) { @auto_correct = true }
+      @option_parser.on(
+        "--fail-level SEVERITY", Check::SEVERITIES,
+        "Minimum severity (error|suggestion|style) for exit with error code"
+      ) do |severity|
+        @fail_level = severity.to_sym
+      end
 
       @option_parser.separator("")
       @option_parser.separator("Miscellaneous:")
@@ -77,6 +85,8 @@ module ThemeCheck
 
     def parse(argv)
       @path = option_parser.parse(argv).first || "."
+    rescue OptionParser::InvalidArgument => e
+      abort(e.message)
     end
 
     def run!
@@ -84,13 +94,13 @@ module ThemeCheck
         @config = if @config_path
           ThemeCheck::Config.new(
             root: @path,
-            configuration: ThemeCheck::Config.load_file(@config_path)
+            configuration: ThemeCheck::Config.load_config(@config_path)
           )
         else
           ThemeCheck::Config.from_path(@path)
         end
-        @config.only_categories = @only_categories
-        @config.exclude_categories = @exclude_categories
+        @config.include_categories = @include_categories unless @include_categories.empty?
+        @config.exclude_categories = @exclude_categories unless @exclude_categories.empty?
         @config.auto_correct = @auto_correct
       end
 
@@ -99,12 +109,16 @@ module ThemeCheck
 
     def run
       run!
+      exit(0)
     rescue Abort => e
       if e.message.empty?
         exit(1)
       else
         abort(e.message)
       end
+    rescue ThemeCheckError => e
+      STDERR.puts(e.message)
+      exit(2)
     end
 
     def self.parse_and_run!(argv)
@@ -130,11 +144,16 @@ module ThemeCheck
     def init
       dotfile_path = ThemeCheck::Config.find(@path)
       if dotfile_path.nil?
-        File.write(File.join(@path, ThemeCheck::Config::DOTFILE), File.read(ThemeCheck::Config::DEFAULT_CONFIG))
+        config_name = if @config_path && @config_path[0] == ":"
+          "#{@config_path[1..]}.yml"
+        else
+          "default.yml"
+        end
+        File.write(File.join(@path, ThemeCheck::Config::DOTFILE), File.read(ThemeCheck::Config.bundled_config_path(config_name)))
 
         puts "Writing new #{ThemeCheck::Config::DOTFILE} to #{@path}"
       else
-        raise Abort, "#{ThemeCheck::Config::DOTFILE} already exists at #{@path}."
+        raise Abort, "#{ThemeCheck::Config::DOTFILE} already exists at #{@path}"
       end
     end
 
@@ -157,7 +176,9 @@ module ThemeCheck
       analyzer.analyze_theme
       analyzer.correct_offenses
       ThemeCheck::Printer.new.print(theme, analyzer.offenses, @config.auto_correct)
-      raise Abort, "" if analyzer.uncorrectable_offenses.any?
+      raise Abort, "" if analyzer.uncorrectable_offenses.any? do |offense|
+        offense.check.severity_value <= Check.severity_value(@fail_level)
+      end
     end
   end
 end

data/lib/theme_check/config.rb

@@ -3,11 +3,11 @@
 module ThemeCheck
   class Config
     DOTFILE = '.theme-check.yml'
-    DEFAULT_CONFIG = "#{__dir__}/../../config/default.yml"
+    BUNDLED_CONFIGS_DIR = "#{__dir__}/../../config"
     BOOLEAN = [true, false]
 
     attr_reader :root
-    attr_accessor :only_categories, :exclude_categories, :auto_correct
+    attr_accessor :auto_correct
 
     class << self
       attr_reader :last_loaded_config
@@ -42,18 +42,46 @@ module ThemeCheck
         YAML.load_file(absolute_path)
       end
 
+      def bundled_config_path(name)
+        "#{BUNDLED_CONFIGS_DIR}/#{name}"
+      end
+
+      def load_bundled_config(name)
+        load_file(bundled_config_path(name))
+      end
+
+      def load_config(path)
+        if path[0] == ":"
+          load_bundled_config("#{path[1..]}.yml")
+        elsif path.is_a?(Symbol)
+          load_bundled_config("#{path}.yml")
+        else
+          load_file(path)
+        end
+      end
+
       def default
-        @default ||= load_file(DEFAULT_CONFIG)
+        @default ||= load_config(":default")
       end
     end
 
     def initialize(root: nil, configuration: nil, should_resolve_requires: true)
       @configuration = if configuration
+        # TODO: Do we need to handle extends here? What base configuration
+        # should we validate against once Theme App Extensions has its own
+        # checks? :all?
         validate_configuration(configuration)
       else
         {}
       end
-      merge_with_default_configuration!(@configuration)
+
+      # Follow extends
+      extends = @configuration["extends"] || ":default"
+      while extends
+        extended_configuration = self.class.load_config(extends)
+        extends = extended_configuration["extends"]
+        @configuration = merge_configurations!(@configuration, extended_configuration)
+      end
 
       @root = if root && @configuration.key?("root")
         Pathname.new(root).join(@configuration["root"])
@@ -61,8 +89,6 @@ module ThemeCheck
         Pathname.new(root)
       end
 
-      @only_categories = []
-      @exclude_categories = []
       @auto_correct = false
 
       resolve_requires if @root && should_resolve_requires
@@ -87,16 +113,18 @@ module ThemeCheck
         check_class = ThemeCheck.const_get(check_name)
 
         next if check_class.categories.any? { |category| exclude_categories.include?(category) }
-        next if only_categories.any? && check_class.categories.none? { |category| only_categories.include?(category) }
+        next if include_categories.any? && !include_categories.all? { |category| check_class.categories.include?(category) }
 
         options_for_check = options.transform_keys(&:to_sym)
         options_for_check.delete(:enabled)
+        severity = options_for_check.delete(:severity)
         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.severity = severity.to_sym if severity
         check.ignored_patterns = ignored_patterns
         check.options = options_for_check
         check
@@ -107,6 +135,22 @@ module ThemeCheck
       self["ignore"] || []
     end
 
+    def include_categories
+      self["include_categories"] || []
+    end
+
+    def include_categories=(categories)
+      @configuration["include_categories"] = categories
+    end
+
+    def exclude_categories
+      self["exclude_categories"] || []
+    end
+
+    def exclude_categories=(categories)
+      @configuration["exclude_categories"] = categories
+    end
+
     private
 
     def check_name?(name)
@@ -133,6 +177,8 @@ module ThemeCheck
           else
             warn("bad configuration type for #{name}: expected a Hash, got #{value.inspect}")
           end
+        elsif key == "severity"
+          valid_configuration[key] = value
         elsif default.nil?
           warn("unknown configuration: #{name}")
         elsif BOOLEAN.include?(default) && !BOOLEAN.include?(value)
@@ -147,13 +193,13 @@ module ThemeCheck
       valid_configuration
     end
 
-    def merge_with_default_configuration!(configuration, default_configuration = self.class.default)
-      default_configuration.each do |key, default|
+    def merge_configurations!(configuration, extended_configuration)
+      extended_configuration.each do |key, default|
         value = configuration[key]
 
         case value
         when Hash
-          merge_with_default_configuration!(value, default)
+          merge_configurations!(value, default)
         when nil
           configuration[key] = default
         end

data/lib/theme_check/exceptions.rb

@@ -1,32 +1,34 @@
 # frozen_string_literal: true
 require "net/http"
 
-TIMEOUT_EXCEPTIONS = [
-  Net::ReadTimeout,
-  Net::OpenTimeout,
-  Net::WriteTimeout,
-  Errno::ETIMEDOUT,
-  Timeout::Error,
-]
+module ThemeCheck
+  TIMEOUT_EXCEPTIONS = [
+    Net::ReadTimeout,
+    Net::OpenTimeout,
+    Net::WriteTimeout,
+    Errno::ETIMEDOUT,
+    Timeout::Error,
+  ]
 
-CONNECTION_EXCEPTIONS = [
-  IOError,
-  EOFError,
-  SocketError,
-  Errno::EINVAL,
-  Errno::ECONNRESET,
-  Errno::ECONNABORTED,
-  Errno::EPIPE,
-  Errno::ECONNREFUSED,
-  Errno::EAGAIN,
-  Errno::EHOSTUNREACH,
-  Errno::ENETUNREACH,
-]
+  CONNECTION_EXCEPTIONS = [
+    IOError,
+    EOFError,
+    SocketError,
+    Errno::EINVAL,
+    Errno::ECONNRESET,
+    Errno::ECONNABORTED,
+    Errno::EPIPE,
+    Errno::ECONNREFUSED,
+    Errno::EAGAIN,
+    Errno::EHOSTUNREACH,
+    Errno::ENETUNREACH,
+  ]
 
-NET_HTTP_EXCEPTIONS = [
-  Net::HTTPBadResponse,
-  Net::HTTPHeaderSyntaxError,
-  Net::ProtocolError,
-  *TIMEOUT_EXCEPTIONS,
-  *CONNECTION_EXCEPTIONS,
-]
+  NET_HTTP_EXCEPTIONS = [
+    Net::HTTPBadResponse,
+    Net::HTTPHeaderSyntaxError,
+    Net::ProtocolError,
+    *TIMEOUT_EXCEPTIONS,
+    *CONNECTION_EXCEPTIONS,
+  ]
+end

data/lib/theme_check/html_check.rb

@@ -3,5 +3,7 @@
 module ThemeCheck
   class HtmlCheck < Check
     extend ChecksTracking
+    VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
+    START_OR_END_QUOTE = /(^['"])|(['"]$)/
   end
 end

data/lib/theme_check/html_visitor.rb

@@ -13,12 +13,14 @@ module ThemeCheck
     def visit_template(template)
       doc = parse(template)
       visit(HtmlNode.new(doc, template))
+    rescue ArgumentError => e
+      call_checks(:on_parse_error, e, template)
     end
 
     private
 
     def parse(template)
-      Nokogiri::HTML5.fragment(template.source)
+      Nokogiri::HTML5.fragment(template.source, max_tree_depth: 400, max_attributes: 400)
     end
 
     def visit(node)

data/lib/theme_check/json_file.rb

@@ -1,29 +1,15 @@
 # frozen_string_literal: true
 require "json"
-require "pathname"
 
 module ThemeCheck
-  class JsonFile
+  class JsonFile < ThemeFile
     def initialize(relative_path, storage)
-      @relative_path = relative_path
-      @storage = storage
+      super
       @loaded = false
       @content = nil
       @parser_error = nil
     end
 
-    def path
-      @storage.path(@relative_path)
-    end
-
-    def relative_path
-      @relative_pathname ||= Pathname.new(@relative_path)
-    end
-
-    def source
-      @source ||= @storage.read(@relative_path)
-    end
-
     def content
       load!
       @content
@@ -34,23 +20,10 @@ module ThemeCheck
       @parser_error
     end
 
-    def name
-      relative_path.sub_ext('').to_s
-    end
-
     def json?
       true
     end
 
-    def liquid?
-      false
-    end
-
-    def ==(other)
-      other.is_a?(JsonFile) && relative_path == other.relative_path
-    end
-    alias_method :eql?, :==
-
     private
 
     def load!