theme-check 1.2.0 → 1.5.1

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,6 +5,8 @@ module ThemeCheck
   class Cli
     class Abort < StandardError; end
 
+    FORMATS = [:text, :json]
+
     attr_accessor :path
 
     def initialize
@@ -15,6 +17,7 @@ module ThemeCheck
       @auto_correct = false
       @config_path = nil
       @fail_level = :error
+      @format = :text
     end
 
     def option_parser(parser = OptionParser.new, help: true)
@@ -29,6 +32,10 @@ module ThemeCheck
         "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(
+        "-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"
@@ -71,6 +78,15 @@ module ThemeCheck
         "Print Theme Check version"
       ) { @command = :version }
 
+      if ENV["THEME_CHECK_DEBUG"]
+        @option_parser.separator("")
+        @option_parser.separator("Debugging:")
+        @option_parser.on(
+          "--profile",
+          "Output a profile to STDOUT compatible with FlameGraph."
+        ) { @command = :profile }
+      end
+
       @option_parser.separator("")
       @option_parser.separator(<<~EOS)
         Description:
@@ -165,8 +181,8 @@ module ThemeCheck
       puts option_parser.to_s
     end
 
-    def check
-      puts "Checking #{@config.root} ..."
+    def check(out_stream = STDOUT)
+      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?
@@ -175,10 +191,33 @@ 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)
+      output_with_format(theme, analyzer, out_stream)
       raise Abort, "" if analyzer.uncorrectable_offenses.any? do |offense|
         offense.check.severity_value <= Check.severity_value(@fail_level)
       end
     end
+
+    def profile
+      require 'ruby-prof-flamegraph'
+
+      result = RubyProf.profile do
+        check(STDERR)
+      end
+
+      # Print a graph profile to text
+      printer = RubyProf::FlameGraphPrinter.new(result)
+      printer.print(STDOUT, {})
+    rescue LoadError
+      STDERR.puts "Profiling is only available in development"
+    end
+
+    def output_with_format(theme, analyzer, out_stream)
+      case @format
+      when :text
+        ThemeCheck::Printer.new(out_stream).print(theme, analyzer.offenses, @config.auto_correct)
+      when :json
+        ThemeCheck::JsonPrinter.new(out_stream).print(analyzer.offenses)
+      end
+    end
   end
 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/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

data/lib/theme_check/html_node.rb

@@ -4,13 +4,14 @@ require "forwardable"
 module ThemeCheck
   class HtmlNode
     extend Forwardable
-    attr_reader :template
+    include RegexHelpers
+    attr_reader :template, :parent
 
-    def_delegators :@value, :content, :attributes
-
-    def initialize(value, template)
+    def initialize(value, template, placeholder_values = [], parent = nil)
       @value = value
       @template = template
+      @placeholder_values = placeholder_values
+      @parent = parent
     end
 
     def literal?
@@ -22,35 +23,55 @@ module ThemeCheck
     end
 
     def children
-      @value.children.map { |child| HtmlNode.new(child, template) }
+      @children ||= @value
+        .children
+        .map { |child| HtmlNode.new(child, template, @placeholder_values, self) }
     end
 
-    def parent
-      HtmlNode.new(@value.parent, template)
+    def attributes
+      @attributes ||= @value.attributes
+        .map { |k, v| [replace_placeholders(k), replace_placeholders(v.value)] }
+        .to_h
     end
 
-    def name
-      if @value.name == "#document-fragment"
-        "document"
-      else
-        @value.name
-      end
+    def content
+      @content ||= replace_placeholders(@value.content)
     end
 
+    # @value is not forwarded because we _need_ to replace the
+    # placeholders for the HtmlNode to make sense.
     def value
       if literal?
-        @value.content
+        content
       else
-        @value
+        markup
+      end
+    end
+
+    def name
+      if @value.name == "#document-fragment"
+        "document"
+      else
+        @value.name
       end
     end
 
     def markup
-      @value.to_html
+      @markup ||= replace_placeholders(@value.to_html)
     end
 
     def line_number
       @value.line
     end
+
+    private
+
+    def replace_placeholders(string)
+      # Replace all {%#{i}####%} with the actual content.
+      string.gsub(LIQUID_TAG) do |match|
+        key = /\d+/.match(match)[0]
+        @placeholder_values[key.to_i]
+      end
+    end
   end
 end

data/lib/theme_check/html_visitor.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
-require "nokogumbo"
+require "nokogiri"
 require "forwardable"
 
 module ThemeCheck
   class HtmlVisitor
+    include RegexHelpers
     attr_reader :checks
 
     def initialize(checks)
       @checks = checks
+      @placeholder_values = []
     end
 
     def visit_template(template)
       doc = parse(template)
-      visit(HtmlNode.new(doc, template))
+      visit(HtmlNode.new(doc, template, @placeholder_values))
     rescue ArgumentError => e
       call_checks(:on_parse_error, e, template)
     end
@@ -20,7 +22,19 @@ module ThemeCheck
     private
 
     def parse(template)
-      Nokogiri::HTML5.fragment(template.source, max_tree_depth: 400, max_attributes: 400)
+      parseable_source = +template.source.clone
+
+      # Replace all liquid tags with {%#{i}######%} to prevent the HTML
+      # parser from freaking out. We transparently replace those placeholders in
+      # HtmlNode.
+      matches(parseable_source, LIQUID_TAG_OR_VARIABLE).each do |m|
+        value = m[0]
+        @placeholder_values.push(value)
+        key = (@placeholder_values.size - 1).to_s
+        parseable_source[m.begin(0)...m.end(0)] = "{%#{key.ljust(m.end(0) - m.begin(0) - 4, '#')}%}"
+      end
+
+      Nokogiri::HTML5.fragment(parseable_source, max_tree_depth: 400, max_attributes: 400)
     end
 
     def visit(node)

data/lib/theme_check/json_check.rb

@@ -4,8 +4,8 @@ module ThemeCheck
   class JsonCheck < Check
     extend ChecksTracking
 
-    def add_offense(message, markup: nil, line_number: nil, template: nil)
-      offenses << Offense.new(check: self, message: message, markup: markup, line_number: line_number, template: template)
+    def add_offense(message, markup: nil, line_number: nil, template: nil, &block)
+      offenses << Offense.new(check: self, message: message, markup: markup, line_number: line_number, template: template, correction: block)
     end
   end
 end

data/lib/theme_check/json_file.rb

@@ -20,6 +20,17 @@ module ThemeCheck
       @parser_error
     end
 
+    def update_contents(new_content = '{}')
+      @content = new_content
+    end
+
+    def write
+      if source != @content
+        @storage.write(@relative_path, content)
+        @source = content
+      end
+    end
+
     def json?
       true
     end

data/lib/theme_check/json_printer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'json'
+
+module ThemeCheck
+  class JsonPrinter
+    def initialize(out_stream = STDOUT)
+      @out = out_stream
+    end
+
+    def print(offenses)
+      json = offenses_by_path(offenses)
+      @out.puts JSON.dump(json)
+    end
+
+    def offenses_by_path(offenses)
+      offenses
+        .map(&:to_h)
+        .group_by { |offense| offense[:path] }
+        .map do |(path, path_offenses)|
+          {
+            path: path,
+            offenses: path_offenses.map { |offense| offense.filter { |k, _v| k != :path } },
+            errorCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:error] },
+            suggestionCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:suggestion] },
+            styleCount: path_offenses.count { |offense| offense[:severity] == Check::SEVERITY_VALUES[:style] },
+          }
+        end
+        .sort_by { |o| o[:path] }
+    end
+  end
+end

data/lib/theme_check/language_server/constants.rb

@@ -2,21 +2,28 @@
 
 module ThemeCheck
   module LanguageServer
-    PARTIAL_RENDER = %r{
-      \{\%-?\s*render\s+'(?<partial>[^']*)'|
-      \{\%-?\s*render\s+"(?<partial>[^"]*)"|
+    def self.partial_tag(tag)
+      %r{
+        \{\%-?\s*#{tag}\s+'(?<partial>[^']*)'|
+        \{\%-?\s*#{tag}\s+"(?<partial>[^"]*)"|
+
+        # in liquid tags the whole line is white space until the tag
+        ^\s*#{tag}\s+'(?<partial>[^']*)'|
+        ^\s*#{tag}\s+"(?<partial>[^"]*)"
+      }mix
+    end
+
+    PARTIAL_RENDER = partial_tag('render')
+    PARTIAL_INCLUDE = partial_tag('include')
+    PARTIAL_SECTION = partial_tag('section')
 
-      # in liquid tags the whole line is white space until render
-      ^\s*render\s+'(?<partial>[^']*)'|
-      ^\s*render\s+"(?<partial>[^"]*)"
-    }mix
     ASSET_INCLUDE = %r{
-      \{\%-?\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
-      \{\%-?\s*"(?<partial>[^"]*)"\s*\|\s*asset_url|
+      \{\{-?\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
+      \{\{-?\s*"(?<partial>[^"]*)"\s*\|\s*asset_url|
 
       # in liquid tags the whole line is white space until the asset partial
-      ^\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
-      ^\s*"(?<partial>[^"]*)"\s*\|\s*asset_url
+      ^\s*(?:echo|assign[^=]*\=)\s*'(?<partial>[^']*)'\s*\|\s*asset_url|
+      ^\s*(?:echo|assign[^=]*\=)\s*"(?<partial>[^"]*)"\s*\|\s*asset_url
     }mix
   end
 end

data/lib/theme_check/language_server/document_link_engine.rb

@@ -3,81 +3,17 @@
 module ThemeCheck
   module LanguageServer
     class DocumentLinkEngine
-      include PositionHelper
-      include RegexHelpers
-
       def initialize(storage)
         @storage = storage
+        @providers = DocumentLinkProvider.all.map { |x| x.new(storage) }
       end
 
       def document_links(relative_path)
         buffer = @storage.read(relative_path)
         return [] unless buffer
-        snippet_matches = matches(buffer, PARTIAL_RENDER).map do |match|
-          start_line, start_character = from_index_to_row_column(
-            buffer,
-            match.begin(:partial),
-          )
-
-          end_line, end_character = from_index_to_row_column(
-            buffer,
-            match.end(:partial)
-          )
-
-          {
-            target: snippet_link(match[:partial]),
-            range: {
-              start: {
-                line: start_line,
-                character: start_character,
-              },
-              end: {
-                line: end_line,
-                character: end_character,
-              },
-            },
-          }
+        @providers.flat_map do |p|
+          p.document_links(buffer)
         end
-        asset_matches = matches(buffer, ASSET_INCLUDE).map do |match|
-          start_line, start_character = from_index_to_row_column(
-            buffer,
-            match.begin(:partial),
-          )
-
-          end_line, end_character = from_index_to_row_column(
-            buffer,
-            match.end(:partial)
-          )
-
-          {
-            target: asset_link(match[:partial]),
-            range: {
-              start: {
-                line: start_line,
-                character: start_character,
-              },
-              end: {
-                line: end_line,
-                character: end_character,
-              },
-            },
-          }
-        end
-        snippet_matches + asset_matches
-      end
-
-      def snippet_link(partial)
-        file_link('snippets', partial, '.liquid')
-      end
-
-      def asset_link(partial)
-        file_link('assets', partial, '')
-      end
-
-      private
-
-      def file_link(directory, partial, extension)
-        "file://#{@storage.path(directory + '/' + partial + extension)}"
       end
     end
   end