theme-check 1.0.0 → 1.4.0

data/lib/theme_check/checks/template_length.rb

@@ -5,7 +5,7 @@ module ThemeCheck
     category :liquid
     doc docs_url(__FILE__)
 
-    def initialize(max_length: 500, exclude_schema: true, exclude_stylesheet: true, exclude_javascript: true)
+    def initialize(max_length: 600, exclude_schema: true, exclude_stylesheet: true, exclude_javascript: true)
       @max_length = max_length
       @exclude_schema = exclude_schema
       @exclude_stylesheet = exclude_stylesheet

data/lib/theme_check/checks/undefined_object.rb

@@ -55,7 +55,7 @@ module ThemeCheck
       end
     end
 
-    def initialize(exclude_snippets: false)
+    def initialize(exclude_snippets: true)
       @exclude_snippets = exclude_snippets
       @files = {}
     end

data/lib/theme_check/checks/valid_html_translation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'nokogumbo'
+require 'nokogiri'
 
 module ThemeCheck
   class ValidHTMLTranslation < JsonCheck

data/lib/theme_check/checks.rb

@@ -29,8 +29,18 @@ module ThemeCheck
     def call_check_method(check, method, *args)
       return unless check.respond_to?(method) && !check.ignored?
 
-      Timeout.timeout(CHECK_METHOD_TIMEOUT) do
+      # If you want to use binding.pry in unit tests, define the
+      # THEME_CHECK_DEBUG environment variable. e.g.
+      #
+      #   $ export THEME_CHECK_DEBUG=true
+      #   $ bundle exec rake tests:in_memory
+      #
+      if ENV['THEME_CHECK_DEBUG']
         check.send(method, *args)
+      else
+        Timeout.timeout(CHECK_METHOD_TIMEOUT) do
+          check.send(method, *args)
+        end
       end
     rescue Liquid::Error
       # Pass-through Liquid errors

data/lib/theme_check/cli.rb

@@ -5,15 +5,19 @@ module ThemeCheck
   class Cli
     class Abort < StandardError; end
 
+    FORMATS = [:text, :json]
+
     attr_accessor :path
 
     def initialize
       @path = "."
       @command = :check
-      @only_categories = []
+      @include_categories = []
       @exclude_categories = []
       @auto_correct = false
       @config_path = nil
+      @fail_level = :error
+      @format = :text
     end
 
     def option_parser(parser = OptionParser.new, help: true)
@@ -25,20 +29,31 @@ 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 }
+        "-o", "--output FORMAT", FORMATS,
+        "The output format to use. (text|json, default: text)"
+      ) { |format| @format = format.to_sym }
+      @option_parser.on(
+        "-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 +92,8 @@ module ThemeCheck
 
     def parse(argv)
       @path = option_parser.parse(argv).first || "."
+    rescue OptionParser::InvalidArgument => e
+      abort(e.message)
     end
 
     def run!
@@ -84,13 +101,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 +116,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 +151,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
 
@@ -147,7 +173,7 @@ module ThemeCheck
     end
 
     def check
-      puts "Checking #{@config.root} ..."
+      STDERR.puts "Checking #{@config.root} ..."
       storage = ThemeCheck::FileSystemStorage.new(@config.root, ignored_patterns: @config.ignored_patterns)
       theme = ThemeCheck::Theme.new(storage)
       if theme.all.empty?
@@ -156,8 +182,19 @@ module ThemeCheck
       analyzer = ThemeCheck::Analyzer.new(theme, @config.enabled_checks, @config.auto_correct)
       analyzer.analyze_theme
       analyzer.correct_offenses
-      ThemeCheck::Printer.new.print(theme, analyzer.offenses, @config.auto_correct)
-      raise Abort, "" if analyzer.uncorrectable_offenses.any?
+      output_with_format(theme, analyzer)
+      raise Abort, "" if analyzer.uncorrectable_offenses.any? do |offense|
+        offense.check.severity_value <= Check.severity_value(@fail_level)
+      end
+    end
+
+    def output_with_format(theme, analyzer)
+      case @format
+      when :text
+        ThemeCheck::Printer.new.print(theme, analyzer.offenses, @config.auto_correct)
+      when :json
+        ThemeCheck::JsonPrinter.new.print(analyzer.offenses)
+      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/corrector.rb

@@ -27,5 +27,14 @@ module ThemeCheck
       line.insert(node.range[0], insert_before)
       line.insert(node.range[1] + 1 + insert_before.length, insert_after)
     end
+
+    def create(theme, relative_path, content)
+      theme.storage.write(relative_path, content)
+    end
+
+    def create_default_locale_json(theme)
+      theme.default_locale_json = JsonFile.new("locales/#{theme.default_locale}.default.json", theme.storage)
+      theme.default_locale_json.update_contents('{}')
+    end
   end
 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/file_system_storage.rb

@@ -20,6 +20,9 @@ module ThemeCheck
     end
 
     def write(relative_path, content)
+      reset_memoizers unless file_exists?(relative_path)
+
+      file(relative_path).dirname.mkpath unless file(relative_path).dirname.directory?
       file(relative_path).write(content)
     end
 
@@ -36,6 +39,15 @@ module ThemeCheck
 
     private
 
+    def file_exists?(relative_path)
+      !!@files[relative_path]
+    end
+
+    def reset_memoizers
+      @file_array = nil
+      @directories = nil
+    end
+
     def glob(pattern)
       @root.glob(pattern).reject do |path|
         relative_path = path.relative_path_from(@root)

data/lib/theme_check/html_check.rb

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