theme-check 1.2.0 → 1.5.1

data/lib/theme_check/language_server/document_link_provider.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class DocumentLinkProvider
+      include RegexHelpers
+      include PositionHelper
+      include URIHelper
+
+      class << self
+        attr_accessor :partial_regexp, :destination_directory, :destination_postfix
+
+        def all
+          @all ||= []
+        end
+
+        def inherited(subclass)
+          all << subclass
+        end
+      end
+
+      def initialize(storage = InMemoryStorage.new)
+        @storage = storage
+      end
+
+      def partial_regexp
+        self.class.partial_regexp
+      end
+
+      def destination_directory
+        self.class.destination_directory
+      end
+
+      def destination_postfix
+        self.class.destination_postfix
+      end
+
+      def document_links(buffer)
+        matches(buffer, partial_regexp).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: file_link(match[:partial]),
+            range: {
+              start: {
+                line: start_line,
+                character: start_character,
+              },
+              end: {
+                line: end_line,
+                character: end_character,
+              },
+            },
+          }
+        end
+      end
+
+      def file_link(partial)
+        file_uri(@storage.path(destination_directory + '/' + partial + destination_postfix))
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/asset_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class AssetDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = ASSET_INCLUDE
+      @destination_directory = "assets"
+      @destination_postfix = ""
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/include_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class IncludeDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = PARTIAL_INCLUDE
+      @destination_directory = "snippets"
+      @destination_postfix = ".liquid"
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/render_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class RenderDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = PARTIAL_RENDER
+      @destination_directory = "snippets"
+      @destination_postfix = ".liquid"
+    end
+  end
+end

data/lib/theme_check/language_server/document_link_providers/section_document_link_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class SectionDocumentLinkProvider < DocumentLinkProvider
+      @partial_regexp = PARTIAL_SECTION
+      @destination_directory = "sections"
+      @destination_postfix = ".liquid"
+    end
+  end
+end

data/lib/theme_check/language_server/handler.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
+
 require "benchmark"
 
 module ThemeCheck
   module LanguageServer
     class Handler
+      include URIHelper
+
       CAPABILITIES = {
         completionProvider: {
           triggerCharacters: ['.', '{{ ', '{% '],
@@ -24,7 +27,7 @@ module ThemeCheck
       end
 
       def on_initialize(id, params)
-        @root_path = path_from_uri(params["rootUri"]) || params["rootPath"]
+        @root_path = root_path_from_params(params)
 
         # Tell the client we don't support anything if there's no rootPath
         return send_response(id, { capabilities: {} }) if @root_path.nil?
@@ -53,10 +56,9 @@ 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))
+        analyze_and_send_offenses(text_document_uri(params)) if @diagnostics_tracker.first_run?
       end
 
       def on_text_document_did_save(_id, params)
@@ -95,17 +97,23 @@ module ThemeCheck
       end
 
       def text_document_uri(params)
-        path_from_uri(params.dig('textDocument', 'uri'))
-      end
-
-      def path_from_uri(uri)
-        uri&.sub('file://', '')&.sub('/c%3A', '')
+        file_path(params.dig('textDocument', 'uri'))
       end
 
       def relative_path_from_text_document_uri(params)
         @storage.relative_path(text_document_uri(params))
       end
 
+      def root_path_from_params(params)
+        root_uri = params["rootUri"]
+        root_path = params["rootPath"]
+        if root_uri
+          file_path(root_uri)
+        elsif root_path
+          root_path
+        end
+      end
+
       def text_document_text(params)
         params.dig('textDocument', 'text')
       end
@@ -171,7 +179,7 @@ module ThemeCheck
       def send_diagnostic(path, offenses)
         # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#notificationMessage
         send_notification('textDocument/publishDiagnostics', {
-          uri: "file://#{path}",
+          uri: file_uri(path),
           diagnostics: offenses.map { |offense| offense_to_diagnostic(offense) },
         })
       end

data/lib/theme_check/language_server/server.rb

@@ -25,6 +25,15 @@ module ThemeCheck
         @out = out_stream
         @err = err_stream
 
+        # Because programming is fun,
+        #
+        # Ruby on Windows turns \n into \r\n. Which means that \r\n
+        # gets turned into \r\r\n. Which means that the protocol
+        # breaks on windows unless we turn STDOUT into binary mode.
+        #
+        # Hours wasted: 9.
+        @out.binmode
+
         @out.sync = true # do not buffer
         @err.sync = true # do not buffer
 
@@ -52,19 +61,8 @@ module ThemeCheck
         response_body = JSON.dump(response)
         log(JSON.pretty_generate(response)) if $DEBUG
 
-        # Because programming is fun,
-        #
-        # Ruby on Windows turns \n into \r\n. Which means that \r\n
-        # gets turned into \r\r\n. Which means that the protocol
-        # breaks on windows unless we turn STDOUT into binary mode and
-        # set the encoding manually (yuk!) or we do this little hack
-        # here and put \n which gets transformed into \r\n on windows
-        # only...
-        #
-        # Hours wasted: 8.
-        eol = Gem.win_platform? ? "\n" : "\r\n"
-        @out.write("Content-Length: #{response_body.bytesize}#{eol}")
-        @out.write(eol)
+        @out.write("Content-Length: #{response_body.bytesize}\r\n")
+        @out.write("\r\n")
         @out.write(response_body)
         @out.flush
       end

data/lib/theme_check/language_server/uri_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "benchmark"
+require "uri"
+require "cgi"
+
+module ThemeCheck
+  module LanguageServer
+    module URIHelper
+      # Will URI.encode a string the same way VS Code would. There are two things
+      # to watch out for:
+      #
+      # 1. VS Code still uses the outdated '%20' for spaces
+      # 2. VS Code prefixes Windows paths with / (so /C:/Users/... is expected)
+      #
+      # Exists because of https://github.com/Shopify/theme-check/issues/360
+      def file_uri(absolute_path)
+        "file://" + absolute_path
+          .to_s
+          .split('/')
+          .map { |x| CGI.escape(x).gsub('+', '%20') }
+          .join('/')
+          .sub(%r{^/?}, '/') # Windows paths should be prefixed by /c:
+      end
+
+      def file_path(uri_string)
+        return if uri_string.nil?
+        uri = URI(uri_string)
+        path = CGI.unescape(uri.path)
+        # On Windows, VS Code sends the URLs as file:///C:/...
+        # /C:/1234 is not a valid path in ruby. So we strip the slash.
+        path = path.sub(%r{^/([a-z]:/)}i, '\1')
+        path
+      end
+    end
+  end
+end

data/lib/theme_check/language_server.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require_relative "language_server/protocol"
 require_relative "language_server/constants"
+require_relative "language_server/uri_helper"
 require_relative "language_server/handler"
 require_relative "language_server/server"
 require_relative "language_server/tokens"
@@ -8,6 +9,7 @@ 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_provider"
 require_relative "language_server/document_link_engine"
 require_relative "language_server/diagnostics_tracker"
 
@@ -15,6 +17,10 @@ Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
   require file
 end
 
+Dir[__dir__ + "/language_server/document_link_providers/*.rb"].each do |file|
+  require file
+end
+
 module ThemeCheck
   module LanguageServer
     def self.start

data/lib/theme_check/node.rb

@@ -22,9 +22,7 @@ module ThemeCheck
     end
 
     def markup=(markup)
-      if tag?
-        @value.raw = markup
-      elsif @value.instance_variable_defined?(:@markup)
+      if @value.instance_variable_defined?(:@markup)
         @value.instance_variable_set(:@markup, markup)
       end
     end
@@ -127,7 +125,11 @@ module ThemeCheck
     end
 
     def position
-      @position ||= Position.new(markup, template&.source, line_number)
+      @position ||= Position.new(
+        markup,
+        template&.source,
+        line_number_1_indexed: line_number
+      )
     end
 
     def start_index

data/lib/theme_check/offense.rb

@@ -1,11 +1,32 @@
 # frozen_string_literal: true
 module ThemeCheck
   class Offense
+    include PositionHelper
+
     MAX_SOURCE_EXCERPT_SIZE = 120
 
     attr_reader :check, :message, :template, :node, :markup, :line_number, :correction
 
-    def initialize(check:, message: nil, template: nil, node: nil, markup: nil, line_number: nil, correction: nil)
+    def initialize(
+      check:, # instance of a ThemeCheck::Check
+      message: nil, # error message for the offense
+      template: nil, # Template
+      node: nil, # Node or HtmlNode
+      markup: nil, # string
+      line_number: nil, # line number of the error (1-indexed)
+      # node_markup_offset is the index inside node.markup to start
+      # looking for markup :mindblow:.
+      # This is so we can accurately highlight node substrings.
+      # e.g. if we have the following scenario in which we
+      # want to highlight the middle comma
+      #   * node.markup == "replace ',',', '"
+      #   * markup == ","
+      # Then we need some way of telling our Position class to start
+      # looking for the second comma. This is done with node_markup_offset.
+      # More context can be found in #376.
+      node_markup_offset: 0,
+      correction: nil # block
+    )
       @check = check
       @correction = correction
 
@@ -39,7 +60,13 @@ module ThemeCheck
         @node.line_number
       end
 
-      @position = Position.new(@markup, @template&.source, @line_number)
+      @position = Position.new(
+        @markup,
+        @template&.source,
+        line_number_1_indexed: @line_number,
+        node_markup_offset: node_markup_offset,
+        node_markup: node&.markup
+      )
     end
 
     def source_excerpt
@@ -103,8 +130,13 @@ module ThemeCheck
       tokens.join(":") if tokens.any?
     end
 
+    def location_range
+      tokens = [template&.relative_path, start_index, end_index].compact
+      tokens.join(":") if tokens.any?
+    end
+
     def correctable?
-      line_number && correction
+      !!correction
     end
 
     def correct
@@ -139,5 +171,26 @@ module ThemeCheck
         message
       end
     end
+
+    def to_s_range
+      if template
+        "#{message} at #{location_range}"
+      else
+        message
+      end
+    end
+
+    def to_h
+      {
+        check: check.code_name,
+        path: template&.relative_path,
+        severity: check.severity_value,
+        start_line: start_line,
+        start_column: start_column,
+        end_line: end_line,
+        end_column: end_column,
+        message: message,
+      }
+    end
   end
 end

data/lib/theme_check/parsing_helpers.rb

@@ -5,15 +5,16 @@ module ThemeCheck
     def outside_of_strings(markup)
       scanner = StringScanner.new(markup)
 
-      while scanner.scan(/.*?("|')/)
-        yield scanner.matched[0..-2]
+      while scanner.scan(/.*?("|')/m)
+        chunk_start = scanner.pre_match.size
+        yield scanner.matched[0..-2], chunk_start
         quote = scanner.matched[-1] == "'" ? "'" : "\""
         # Skip to the end of the string
         # Check for empty string first, since follow regexp uses lookahead
         scanner.skip(/#{quote}/) || scanner.skip_until(/[^\\]#{quote}/)
       end
 
-      yield scanner.rest if scanner.rest?
+      yield scanner.rest, scanner.charpos if scanner.rest?
     end
   end
 end

data/lib/theme_check/position.rb

@@ -4,42 +4,64 @@ module ThemeCheck
   class Position
     include PositionHelper
 
-    def initialize(needle, contents, line_number_1_indexed)
-      @needle = needle
-      @contents = contents
+    def initialize(
+      needle_arg,
+      contents_arg,
+      line_number_1_indexed: nil,
+      node_markup: nil,
+      node_markup_offset: 0 # the index of markup inside the node_markup
+    )
+      @needle = needle_arg
+      @contents = contents_arg
       @line_number_1_indexed = line_number_1_indexed
-      @start_row_column = nil
-      @end_row_column = nil
+      @node_markup_offset = node_markup_offset
+      @node_markup = node_markup
+      @strict_position = StrictPosition.new(
+        needle,
+        contents,
+        start_index,
+      )
     end
 
-    def start_line_index
+    def start_line_offset
       from_row_column_to_index(contents, line_number, 0)
     end
 
+    def start_offset
+      return start_line_offset if @node_markup.nil?
+      node_markup_start = contents.index(@node_markup, start_line_offset)
+      return start_line_offset if node_markup_start.nil?
+      node_markup_start + @node_markup_offset
+    end
+
     # 0-indexed, inclusive
     def start_index
-      contents.index(needle, start_line_index) || start_line_index
+      contents.index(needle, start_offset)
     end
 
     # 0-indexed, exclusive
     def end_index
-      start_index + needle.size
+      @strict_position.end_index
     end
 
+    # 0-indexed, inclusive
     def start_row
-      start_row_column[0]
+      @strict_position.start_row
     end
 
+    # 0-indexed, inclusive
     def start_column
-      start_row_column[1]
+      @strict_position.start_column
     end
 
+    # 0-indexed, exclusive (both taken together are) therefore you
+    # might end up on a newline character or the next line
     def end_row
-      end_row_column[0]
+      @strict_position.end_row
     end
 
     def end_column
-      end_row_column[1]
+      @strict_position.end_column
     end
 
     private
@@ -55,15 +77,77 @@ module ThemeCheck
     end
 
     def needle
-      if @needle.nil? && !contents.empty? && !@line_number_1_indexed.nil?
-        contents.lines(chomp: true)[line_number] || ''
+      if has_content_and_line_number_but_no_needle?
+        entire_line_needle
       elsif contents.empty? || @needle.nil?
         ''
+      elsif !can_find_needle?
+        entire_line_needle
       else
         @needle
       end
     end
 
+    def has_content_and_line_number_but_no_needle?
+      @needle.nil? && !contents.empty? && @line_number_1_indexed.is_a?(Integer)
+    end
+
+    def can_find_needle?
+      !!contents.index(@needle)
+    end
+
+    def entire_line_needle
+      contents.lines(chomp: true)[line_number] || ''
+    end
+  end
+
+  # This method is stricter than Position in the sense that it doesn't
+  # accept invalid inputs. Makes for code that is easier to understand.
+  class StrictPosition
+    include PositionHelper
+
+    attr_reader :needle, :contents
+
+    def initialize(needle, contents, start_index)
+      raise ArgumentError, 'Bad start_index' unless start_index.is_a?(Integer)
+      raise ArgumentError, 'Bad contents' unless contents.is_a?(String)
+      raise ArgumentError, 'Bad needle' unless needle.is_a?(String) || !contents.index(needle, start_index)
+
+      @needle = needle
+      @contents = contents
+      @start_index = start_index
+      @start_row_column = nil
+      @end_row_column = nil
+    end
+
+    # 0-indexed, inclusive
+    def start_index
+      @contents.index(needle, @start_index)
+    end
+
+    # 0-indexed, exclusive
+    def end_index
+      start_index + needle.size
+    end
+
+    def start_row
+      start_row_column[0]
+    end
+
+    def start_column
+      start_row_column[1]
+    end
+
+    def end_row
+      end_row_column[0]
+    end
+
+    def end_column
+      end_row_column[1]
+    end
+
+    private
+
     def start_row_column
       return @start_row_column unless @start_row_column.nil?
       @start_row_column = from_index_to_row_column(contents, start_index)