theme-check 0.7.3 → 0.9.0

data/lib/theme_check/json_file.rb

@@ -20,6 +20,10 @@ module ThemeCheck
       @relative_pathname ||= Pathname.new(@relative_path)
     end
 
+    def source
+      @source ||= @storage.read(@relative_path)
+    end
+
     def content
       load!
       @content
@@ -34,12 +38,20 @@ module ThemeCheck
       relative_path.sub_ext('').to_s
     end
 
+    def json?
+      true
+    end
+
+    def liquid?
+      false
+    end
+
     private
 
     def load!
       return if @loaded
 
-      @content = JSON.parse(@storage.read(@relative_path))
+      @content = JSON.parse(source)
     rescue JSON::ParserError => e
       @parser_error = e
     ensure

data/lib/theme_check/language_server.rb

@@ -4,11 +4,12 @@ require_relative "language_server/constants"
 require_relative "language_server/handler"
 require_relative "language_server/server"
 require_relative "language_server/tokens"
-require_relative "language_server/position_helper"
+require_relative "language_server/variable_lookup_finder"
 require_relative "language_server/completion_helper"
 require_relative "language_server/completion_provider"
 require_relative "language_server/completion_engine"
 require_relative "language_server/document_link_engine"
+require_relative "language_server/diagnostics_tracker"
 
 Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
   require file

data/lib/theme_check/language_server/completion_engine.rb

@@ -12,7 +12,7 @@ module ThemeCheck
 
       def completions(relative_path, line, col)
         buffer = @storage.read(relative_path)
-        cursor = from_line_column_to_index(buffer, line, col)
+        cursor = from_row_column_to_index(buffer, line, col)
         token = find_token(buffer, cursor)
         return [] if token.nil?
 

data/lib/theme_check/language_server/completion_providers/filter_completion_provider.rb

@@ -37,6 +37,7 @@ module ThemeCheck
         partial_match = matches(content, NAMED_FILTER).find do |match|
           match.begin(1) <= cursor && cursor < match.end(1) + 1 # including next character
         end
+        return '' if partial_match.nil?
         partial_match[1]
       end
 

data/lib/theme_check/language_server/completion_providers/object_completion_provider.rb

@@ -4,18 +4,20 @@ module ThemeCheck
   module LanguageServer
     class ObjectCompletionProvider < CompletionProvider
       def completions(content, cursor)
-        return [] unless can_complete?(content, cursor)
-        partial = first_word(content) || ''
+        return [] unless (variable_lookup = variable_lookup_at_cursor(content, cursor))
+        return [] unless variable_lookup.lookups.empty?
+        return [] if content[cursor - 1] == "."
         ShopifyLiquid::Object.labels
-          .select { |w| w.start_with?(partial) }
+          .select { |w| w.start_with?(partial(variable_lookup)) }
           .map { |object| object_to_completion(object) }
       end
 
-      def can_complete?(content, cursor)
-        content.match?(Liquid::VariableStart) && (
-          cursor_on_first_word?(content, cursor) ||
-          cursor_on_start_content?(content, cursor, Liquid::VariableStart)
-        )
+      def variable_lookup_at_cursor(content, cursor)
+        VariableLookupFinder.lookup(content, cursor)
+      end
+
+      def partial(variable_lookup)
+        variable_lookup.name || ''
       end
 
       private

data/lib/theme_check/language_server/constants.rb

@@ -4,7 +4,11 @@ module ThemeCheck
   module LanguageServer
     PARTIAL_RENDER = %r{
       \{\%-?\s*render\s+'(?<partial>[^']*)'|
-      \{\%-?\s*render\s+"(?<partial>[^"]*)"
+      \{\%-?\s*render\s+"(?<partial>[^"]*)"|
+
+      # in liquid tags the whole line is white space until render
+      ^\s*render\s+'(?<partial>[^']*)'|
+      ^\s*render\s+"(?<partial>[^"]*)"
     }mix
   end
 end

data/lib/theme_check/language_server/diagnostics_tracker.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class DiagnosticsTracker
+      def initialize
+        @previously_reported_files = Set.new
+        @single_files_offenses = {}
+        @first_run = true
+      end
+
+      def first_run?
+        @first_run
+      end
+
+      def build_diagnostics(offenses, analyzed_files: nil)
+        reported_files = Set.new
+        new_single_file_offenses = {}
+
+        offenses.group_by(&:template).each do |template, template_offenses|
+          next unless template
+          reported_offenses = template_offenses
+          previous_offenses = @single_files_offenses[template.path]
+          if analyzed_files.nil? || analyzed_files.include?(template.path)
+            # We re-analyzed the file, so we know the template_offenses are update to date.
+            reported_single_file_offenses = reported_offenses.select(&:single_file?)
+            if reported_single_file_offenses.any?
+              new_single_file_offenses[template.path] = reported_single_file_offenses
+            end
+          elsif previous_offenses
+            # Merge in the previous ones, if some
+            reported_offenses |= previous_offenses
+          end
+          yield template.path, reported_offenses
+          reported_files << template.path
+        end
+
+        @single_files_offenses.each do |path, _|
+          # Already reported above, skip
+          next if reported_files.include?(path)
+
+          if analyzed_files.nil? || analyzed_files.include?(path)
+            # We re-analyzed this file, if it was not reported, all offenses in it got fixed
+            yield path, []
+            new_single_file_offenses[path] = nil
+          end
+          # NOTE: No need to re-report previous offenses as LSP should keep them around until
+          # we clear them.
+          reported_files << path
+        end
+
+        # Publish diagnostics with empty array if all issues on a previously reported template
+        # have been fixed.
+        (@previously_reported_files - reported_files).each do |path|
+          yield path, []
+        end
+
+        @previously_reported_files = reported_files
+        @single_files_offenses.merge!(new_single_file_offenses)
+        @first_run = false
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_engine.rb

@@ -14,12 +14,12 @@ module ThemeCheck
         buffer = @storage.read(relative_path)
         return [] unless buffer
         matches(buffer, PARTIAL_RENDER).map do |match|
-          start_line, start_character = from_index_to_line_column(
+          start_line, start_character = from_index_to_row_column(
             buffer,
             match.begin(:partial),
           )
 
-          end_line, end_character = from_index_to_line_column(
+          end_line, end_character = from_index_to_row_column(
             buffer,
             match.end(:partial)
           )

data/lib/theme_check/language_server/handler.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require "benchmark"
 
 module ThemeCheck
   module LanguageServer
@@ -19,21 +20,21 @@ module ThemeCheck
 
       def initialize(server)
         @server = server
-        @previously_reported_files = Set.new
+        @diagnostics_tracker = DiagnosticsTracker.new
       end
 
       def on_initialize(id, params)
-        @root_path = params["rootPath"]
+        @root_path = path_from_uri(params["rootUri"]) || params["rootPath"]
+
+        # Tell the client we don't support anything if there's no rootPath
+        return send_response(id, { capabilities: {} }) if @root_path.nil?
         @storage = in_memory_storage(@root_path)
         @completion_engine = CompletionEngine.new(@storage)
         @document_link_engine = DocumentLinkEngine.new(@storage)
         # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#responseMessage
-        send_response(
-          id: id,
-          result: {
-            capabilities: CAPABILITIES,
-          }
-        )
+        send_response(id, {
+          capabilities: CAPABILITIES,
+        })
       end
 
       def on_exit(_id, _params)
@@ -52,6 +53,7 @@ module ThemeCheck
       end
 
       def on_text_document_did_open(_id, params)
+        return unless @diagnostics_tracker.first_run?
         relative_path = relative_path_from_text_document_uri(params)
         @storage.write(relative_path, text_document_text(params))
         analyze_and_send_offenses(text_document_uri(params))
@@ -63,20 +65,14 @@ module ThemeCheck
 
       def on_text_document_document_link(id, params)
         relative_path = relative_path_from_text_document_uri(params)
-        send_response(
-          id: id,
-          result: document_links(relative_path)
-        )
+        send_response(id, document_links(relative_path))
       end
 
       def on_text_document_completion(id, params)
         relative_path = relative_path_from_text_document_uri(params)
         line = params.dig('position', 'line')
         col = params.dig('position', 'character')
-        send_response(
-          id: id,
-          result: completions(relative_path, line, col)
-        )
+        send_response(id, completions(relative_path, line, col))
       end
 
       private
@@ -99,7 +95,11 @@ module ThemeCheck
       end
 
       def text_document_uri(params)
-        params.dig('textDocument', 'uri').sub('file://', '')
+        path_from_uri(params.dig('textDocument', 'uri'))
+      end
+
+      def path_from_uri(uri)
+        uri&.sub('file://', '')
       end
 
       def relative_path_from_text_document_uri(params)
@@ -126,17 +126,32 @@ module ThemeCheck
           ignored_patterns: config.ignored_patterns
         )
         theme = ThemeCheck::Theme.new(storage)
-
-        offenses = analyze(theme, config)
-        log("Found #{theme.all.size} templates, and #{offenses.size} offenses")
-        send_diagnostics(offenses)
-      end
-
-      def analyze(theme, config)
         analyzer = ThemeCheck::Analyzer.new(theme, config.enabled_checks)
-        log("Checking #{config.root}")
-        analyzer.analyze_theme
-        analyzer.offenses
+
+        if @diagnostics_tracker.first_run?
+          # Analyze the full theme on first run
+          log("Checking #{config.root}")
+          offenses = nil
+          time = Benchmark.measure do
+            offenses = analyzer.analyze_theme
+          end
+          log("Found #{offenses.size} offenses in #{format("%0.2f", time.real)}s")
+          send_diagnostics(offenses)
+        else
+          # Analyze selected files
+          relative_path = Pathname.new(@storage.relative_path(absolute_path))
+          file = theme[relative_path]
+          # Skip if not a theme file
+          if file
+            log("Checking #{relative_path}")
+            offenses = nil
+            time = Benchmark.measure do
+              offenses = analyzer.analyze_files([file])
+            end
+            log("Found #{offenses.size} new offenses in #{format("%0.2f", time.real)}s")
+            send_diagnostics(offenses, [absolute_path])
+          end
+        end
       end
 
       def completions(relative_path, line, col)
@@ -147,33 +162,18 @@ module ThemeCheck
         @document_link_engine.document_links(relative_path)
       end
 
-      def send_diagnostics(offenses)
-        reported_files = Set.new
-
-        offenses.group_by(&:template).each do |template, template_offenses|
-          next unless template
-          send_diagnostic(template.path, template_offenses)
-          reported_files << template.path
-        end
-
-        # Publish diagnostics with empty array if all issues on a previously reported template
-        # have been solved.
-        (@previously_reported_files - reported_files).each do |path|
-          send_diagnostic(path, [])
+      def send_diagnostics(offenses, analyzed_files = nil)
+        @diagnostics_tracker.build_diagnostics(offenses, analyzed_files: analyzed_files) do |path, diagnostic_offenses|
+          send_diagnostic(path, diagnostic_offenses)
         end
-
-        @previously_reported_files = reported_files
       end
 
       def send_diagnostic(path, offenses)
         # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#notificationMessage
-        send_response(
-          method: 'textDocument/publishDiagnostics',
-          params: {
-            uri: "file://#{path}",
-            diagnostics: offenses.map { |offense| offense_to_diagnostic(offense) },
-          },
-        )
+        send_notification('textDocument/publishDiagnostics', {
+          uri: "file://#{path}",
+          diagnostics: offenses.map { |offense| offense_to_diagnostic(offense) },
+        })
       end
 
       def offense_to_diagnostic(offense)
@@ -220,11 +220,24 @@ module ThemeCheck
         }
       end
 
-      def send_response(message)
+      def send_message(message)
         message[:jsonrpc] = '2.0'
         @server.send_response(message)
       end
 
+      def send_response(id, result = nil, error = nil)
+        message = { id: id }
+        message[:result] = result if result
+        message[:error] = error if error
+        send_message(message)
+      end
+
+      def send_notification(method, params)
+        message = { method: method }
+        message[:params] = params
+        send_message(message)
+      end
+
       def log(message)
         @server.log(message)
       end

data/lib/theme_check/language_server/server.rb

@@ -52,7 +52,7 @@ module ThemeCheck
         response_body = JSON.dump(response)
         log(JSON.pretty_generate(response)) if $DEBUG
 
-        @out.write("Content-Length: #{response_body.size}\r\n")
+        @out.write("Content-Length: #{response_body.bytesize}\r\n")
         @out.write("\r\n")
         @out.write(response_body)
         @out.flush

data/lib/theme_check/language_server/variable_lookup_finder.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    module VariableLookupFinder
+      extend self
+
+      UNCLOSED_SQUARE_BRACKET = /\[[^\]]*\Z/
+      ENDS_IN_BRACKET_POSITION_THAT_CANT_BE_COMPLETED = %r{
+        (
+          # quotes not preceded by a [
+          (?<!\[)['"]|
+          # closing ]
+          \]|
+          # opening [
+          \[
+        )$
+      }x
+
+      VARIABLE_LOOKUP_CHARACTERS = /[a-z0-9_.'"\]\[]/i
+      VARIABLE_LOOKUP = /#{VARIABLE_LOOKUP_CHARACTERS}+/o
+      SYMBOLS_PRECEDING_POTENTIAL_LOOKUPS = %r{
+        (?:
+          \s(?:
+            if|elsif|unless|and|or|#{Liquid::Condition.operators.keys.join("|")}
+            |echo
+            |case|when
+            |cycle
+            |in
+          )
+          |[:,=]
+        )
+        \s+
+      }omix
+      ENDS_WITH_BLANK_POTENTIAL_LOOKUP = /#{SYMBOLS_PRECEDING_POTENTIAL_LOOKUPS}$/oimx
+      ENDS_WITH_POTENTIAL_LOOKUP = /#{SYMBOLS_PRECEDING_POTENTIAL_LOOKUPS}#{VARIABLE_LOOKUP}$/oimx
+
+      def lookup(content, cursor)
+        return if cursor_is_on_bracket_position_that_cant_be_completed(content, cursor)
+        potential_lookup = lookup_liquid_variable(content, cursor) || lookup_liquid_tag(content, cursor)
+
+        # And we only return it if it's parsed by Liquid as VariableLookup
+        return unless potential_lookup.is_a?(Liquid::VariableLookup)
+        potential_lookup
+      end
+
+      private
+
+      def cursor_is_on_bracket_position_that_cant_be_completed(content, cursor)
+        content[0..cursor - 1] =~ ENDS_IN_BRACKET_POSITION_THAT_CANT_BE_COMPLETED
+      end
+
+      def cursor_is_on_liquid_variable_lookup_position(content, cursor)
+        previous_char = content[cursor - 1]
+        is_liquid_variable = content =~ Liquid::VariableStart
+        is_in_variable_segment = previous_char =~ VARIABLE_LOOKUP_CHARACTERS
+        is_on_blank_variable_lookup_position = content[0..cursor - 1] =~ /[{:,-]\s+$/
+        (
+          is_liquid_variable && (
+            is_in_variable_segment ||
+            is_on_blank_variable_lookup_position
+          )
+        )
+      end
+
+      def lookup_liquid_variable(content, cursor)
+        return unless cursor_is_on_liquid_variable_lookup_position(content, cursor)
+        start_index = content.match(/#{Liquid::VariableStart}-?/o).end(0) + 1
+        end_index = cursor - 1
+
+        # We take the following content
+        # - start after the first two {{
+        # - end at cursor position
+        #
+        # That way, we'll have a partial liquid variable that
+        # can be parsed such that the "last" variable_lookup
+        # will be the one we're trying to complete.
+        markup = content[start_index..end_index]
+
+        # Early return for incomplete variables
+        return empty_lookup if markup =~ /\s+$/
+
+        # Now we go to hack city... The cursor might be in the middle
+        # of a string/square bracket lookup. We need to close those
+        # otherwise the variable parse won't work.
+        markup += "'" if markup.count("'").odd?
+        markup += '"' if markup.count('"').odd?
+        markup += "]" if markup =~ UNCLOSED_SQUARE_BRACKET
+
+        variable = variable_from_markup(markup)
+
+        variable_lookup_for_liquid_variable(variable)
+      end
+
+      def cursor_is_on_liquid_tag_lookup_position(content, cursor)
+        markup = content[0..cursor - 1]
+        is_liquid_tag = content.match?(Liquid::TagStart)
+        is_in_variable_segment = markup =~ ENDS_WITH_POTENTIAL_LOOKUP
+        is_on_blank_variable_lookup_position = markup =~ ENDS_WITH_BLANK_POTENTIAL_LOOKUP
+        (
+          is_liquid_tag && (
+            is_in_variable_segment ||
+            is_on_blank_variable_lookup_position
+          )
+        )
+      end
+
+      # Context:
+      #
+      # We know full well that the code as it is being typed is probably not
+      # something that can be parsed by liquid.
+      #
+      # How this works:
+      #
+      # 1. Attempt to turn the code of the token until the cursor position into
+      #    valid liquid code with some hacks.
+      # 2. If the code ends in space at a "potential lookup" spot
+      #   a. Then return an empty variable lookup
+      # 3. Parse the valid liquid code
+      # 4. Attempt to extract a VariableLookup from Liquid::Template
+      def lookup_liquid_tag(content, cursor)
+        return unless cursor_is_on_liquid_tag_lookup_position(content, cursor)
+
+        markup = parseable_markup(content, cursor)
+        return empty_lookup if markup == :empty_lookup_markup
+
+        template = Liquid::Template.parse(markup)
+        current_tag = template.root.nodelist[0]
+
+        case current_tag.tag_name
+        when "if", "unless"
+          variable_lookup_for_if_tag(current_tag)
+        when "case"
+          variable_lookup_for_case_tag(current_tag)
+        when "cycle"
+          variable_lookup_for_cycle_tag(current_tag)
+        when "for"
+          variable_lookup_for_for_tag(current_tag)
+        when "tablerow"
+          variable_lookup_for_tablerow_tag(current_tag)
+        when "render"
+          variable_lookup_for_render_tag(current_tag)
+        when "assign"
+          variable_lookup_for_assign_tag(current_tag)
+        when "echo"
+          variable_lookup_for_echo_tag(current_tag)
+        end
+
+      # rubocop:disable Style/RedundantReturn
+      rescue Liquid::SyntaxError
+        # We don't complete variable for liquid syntax errors
+        return
+      end
+      # rubocop:enable Style/RedundantReturn
+
+      def parseable_markup(content, cursor)
+        start_index = 0
+        end_index = cursor - 1
+        markup = content[start_index..end_index]
+
+        # Welcome to Hackcity
+        markup += "'" if markup.count("'").odd?
+        markup += '"' if markup.count('"').odd?
+        markup += "]" if markup =~ UNCLOSED_SQUARE_BRACKET
+
+        # Now check if it's a liquid tag
+        is_liquid_tag = markup =~ tag_regex('liquid')
+        ends_with_blank_potential_lookup = markup =~ ENDS_WITH_BLANK_POTENTIAL_LOOKUP
+        last_line = markup.rstrip.lines.last
+        markup = "{% #{last_line}" if is_liquid_tag
+
+        # Close the tag
+        markup += ' %}'
+
+        # if statements
+        is_if_tag = markup =~ tag_regex('if')
+        return :empty_lookup_markup if is_if_tag && ends_with_blank_potential_lookup
+        markup += '{% endif %}' if is_if_tag
+
+        # unless statements
+        is_unless_tag = markup =~ tag_regex('unless')
+        return :empty_lookup_markup if is_unless_tag && ends_with_blank_potential_lookup
+        markup += '{% endunless %}' if is_unless_tag
+
+        # elsif statements
+        is_elsif_tag = markup =~ tag_regex('elsif')
+        return :empty_lookup_markup if is_elsif_tag && ends_with_blank_potential_lookup
+        markup = '{% if x %}' + markup + '{% endif %}' if is_elsif_tag
+
+        # case statements
+        is_case_tag = markup =~ tag_regex('case')
+        return :empty_lookup_markup if is_case_tag && ends_with_blank_potential_lookup
+        markup += "{% endcase %}" if is_case_tag
+
+        # when
+        is_when_tag = markup =~ tag_regex('when')
+        return :empty_lookup_markup if is_when_tag && ends_with_blank_potential_lookup
+        markup = "{% case x %}" + markup + "{% endcase %}" if is_when_tag
+
+        # for statements
+        is_for_tag = markup =~ tag_regex('for')
+        return :empty_lookup_markup if is_for_tag && ends_with_blank_potential_lookup
+        markup += "{% endfor %}" if is_for_tag
+
+        # tablerow statements
+        is_tablerow_tag = markup =~ tag_regex('tablerow')
+        return :empty_lookup_markup if is_tablerow_tag && ends_with_blank_potential_lookup
+        markup += "{% endtablerow %}" if is_tablerow_tag
+
+        markup
+      end
+
+      def variable_lookup_for_if_tag(if_tag)
+        condition = if_tag.blocks.last
+        variable_lookup_for_condition(condition)
+      end
+
+      def variable_lookup_for_condition(condition)
+        return variable_lookup_for_condition(condition.child_condition) if condition.child_condition
+        return condition.right if condition.right
+        condition.left
+      end
+
+      def variable_lookup_for_case_tag(case_tag)
+        return variable_lookup_for_case_block(case_tag.blocks.last) unless case_tag.blocks.empty?
+        case_tag.left
+      end
+
+      def variable_lookup_for_case_block(condition)
+        condition.right
+      end
+
+      def variable_lookup_for_cycle_tag(cycle_tag)
+        cycle_tag.variables.last
+      end
+
+      def variable_lookup_for_for_tag(for_tag)
+        for_tag.collection_name
+      end
+
+      def variable_lookup_for_tablerow_tag(tablerow_tag)
+        tablerow_tag.collection_name
+      end
+
+      def variable_lookup_for_render_tag(render_tag)
+        return empty_lookup if render_tag.raw =~ /:\s*$/
+        render_tag.attributes.values.last
+      end
+
+      def variable_lookup_for_assign_tag(assign_tag)
+        variable_lookup_for_liquid_variable(assign_tag.from)
+      end
+
+      def variable_lookup_for_echo_tag(echo_tag)
+        variable_lookup_for_liquid_variable(echo_tag.variable)
+      end
+
+      def variable_lookup_for_liquid_variable(variable)
+        has_filters = !variable.filters.empty?
+
+        # Can complete after trailing comma or :
+        if has_filters && variable.raw =~ /[:,]\s*$/
+          empty_lookup
+        elsif has_filters
+          last_filter_argument(variable.filters)
+        elsif variable.name.nil?
+          empty_lookup
+        else
+          variable.name
+        end
+      end
+
+      def empty_lookup
+        Liquid::VariableLookup.parse('')
+      end
+
+      # We want the last thing in variable.filters which is at most
+      # an array that looks like [name, positional_args, hash_arg]
+      def last_filter_argument(filters)
+        filter = filters.last
+        return filter[2].values.last if filter.size == 3
+        return filter[1].last if filter.size == 2
+        nil
+      end
+
+      def variable_from_markup(markup, parse_context = Liquid::ParseContext.new)
+        Liquid::Variable.new(markup, parse_context)
+      end
+
+      def tag_regex(tag)
+        ShopifyLiquid::Tag.tag_regex(tag)
+      end
+    end
+  end
+end