theme-check 0.5.0 → 0.6.0

data/lib/theme_check/config.rb

@@ -10,6 +10,8 @@ module ThemeCheck
     attr_accessor :only_categories, :exclude_categories, :auto_correct
 
     class << self
+      attr_reader :last_loaded_config
+
       def from_path(path)
         if (filename = find(path))
           new(root: filename.dirname, configuration: load_file(filename))
@@ -36,6 +38,7 @@ module ThemeCheck
       end
 
       def load_file(absolute_path)
+        @last_loaded_config = absolute_path
         YAML.load_file(absolute_path)
       end
 

data/lib/theme_check/in_memory_storage.rb

@@ -6,20 +6,28 @@
 # as a big hash already, leave it like that and save yourself some IO.
 module ThemeCheck
   class InMemoryStorage < Storage
-    def initialize(files = {})
+    def initialize(files = {}, root = nil)
       @files = files
+      @root = root
     end
 
     def path(name)
+      return File.join(@root, name) unless @root.nil?
+      name
+    end
+
+    def relative_path(name)
+      path = Pathname.new(name)
+      return path.relative_path_from(@root).to_s unless path.relative? || @root.nil?
       name
     end
 
     def read(name)
-      @files[name]
+      @files[relative_path(name)]
     end
 
     def write(name, content)
-      @files[name] = content
+      @files[relative_path(name)] = content
     end
 
     def files

data/lib/theme_check/language_server.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_relative "language_server/protocol"
+require_relative "language_server/constants"
 require_relative "language_server/handler"
 require_relative "language_server/server"
 require_relative "language_server/tokens"
@@ -7,6 +8,7 @@ require_relative "language_server/position_helper"
 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"
 
 Dir[__dir__ + "/language_server/completion_providers/*.rb"].each do |file|
   require file

data/lib/theme_check/language_server/completion_engine.rb

@@ -7,7 +7,7 @@ module ThemeCheck
 
       def initialize(storage)
         @storage = storage
-        @providers = CompletionProvider.all.map(&:new)
+        @providers = CompletionProvider.all.map { |x| x.new(storage) }
       end
 
       def completions(name, line, col)

data/lib/theme_check/language_server/completion_provider.rb

@@ -16,6 +16,10 @@ module ThemeCheck
         end
       end
 
+      def initialize(storage = InMemoryStorage.new)
+        @storage = storage
+      end
+
       def completions(content, cursor)
         raise NotImplementedError
       end

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

@@ -7,7 +7,7 @@ module ThemeCheck
 
       def completions(content, cursor)
         return [] unless can_complete?(content, cursor)
-        ShopifyLiquid::Filter.labels
+        available_labels
           .select { |w| w.starts_with?(partial(content, cursor)) }
           .map { |filter| filter_to_completion(filter) }
       end
@@ -21,6 +21,10 @@ module ThemeCheck
 
       private
 
+      def available_labels
+        @labels ||= ShopifyLiquid::Filter.labels - ShopifyLiquid::DeprecatedFilter.labels
+      end
+
       def cursor_on_filter?(content, cursor)
         return false unless content.match?(NAMED_FILTER)
         matches(content, NAMED_FILTER).any? do |match|

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class RenderSnippetCompletionProvider < CompletionProvider
+      def completions(content, cursor)
+        return [] unless cursor_on_quoted_argument?(content, cursor)
+        partial = snippet(content) || ''
+        snippets
+          .select { |x| x.starts_with?(partial) }
+          .map { |x| snippet_to_completion(x) }
+      end
+
+      private
+
+      def cursor_on_quoted_argument?(content, cursor)
+        match = content.match(PARTIAL_RENDER)
+        return false if match.nil?
+        match.begin(:partial) <= cursor && cursor <= match.end(:partial)
+      end
+
+      def snippet(content)
+        match = content.match(PARTIAL_RENDER)
+        return if match.nil?
+        match[:partial]
+      end
+
+      def snippets
+        @storage
+          .files
+          .select { |x| x.include?('snippets/') }
+      end
+
+      def snippet_to_completion(file)
+        {
+          label: File.basename(file, '.liquid'),
+          kind: CompletionItemKinds::SNIPPET,
+          detail: file,
+        }
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/constants.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    PARTIAL_RENDER = %r{
+      \{\%\s*render\s+'(?<partial>[^']*)'|
+      \{\%\s*render\s+"(?<partial>[^"]*)"
+    }mix
+  end
+end

data/lib/theme_check/language_server/document_link_engine.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ThemeCheck
+  module LanguageServer
+    class DocumentLinkEngine
+      include PositionHelper
+      include RegexHelpers
+
+      def initialize(storage)
+        @storage = storage
+      end
+
+      def document_links(uri)
+        buffer = @storage.read(uri)
+        matches(buffer, PARTIAL_RENDER).map do |match|
+          start_line, start_character = from_index_to_line_column(
+            buffer,
+            match.begin(:partial),
+          )
+
+          end_line, end_character = from_index_to_line_column(
+            buffer,
+            match.end(:partial)
+          )
+
+          {
+            target: link(match[:partial]),
+            range: {
+              start: {
+                line: start_line,
+                character: start_character,
+              },
+              end: {
+                line: end_line,
+                character: end_character,
+              },
+            },
+          }
+        end
+      end
+
+      def link(partial)
+        'file://' + @storage.path('snippets/' + partial + '.liquid')
+      end
+    end
+  end
+end

data/lib/theme_check/language_server/handler.rb

@@ -8,6 +8,7 @@ module ThemeCheck
           triggerCharacters: ['.', '{{ ', '{% '],
           context: true,
         },
+        documentLinkProvider: true,
         textDocumentSync: {
           openClose: true,
           change: TextDocumentSyncKind::FULL,
@@ -19,12 +20,13 @@ module ThemeCheck
       def initialize(server)
         @server = server
         @previously_reported_files = Set.new
-        @storage = InMemoryStorage.new
-        @completion_engine = CompletionEngine.new(@storage)
       end
 
       def on_initialize(id, params)
         @root_path = params["rootPath"]
+        @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,
@@ -59,6 +61,14 @@ module ThemeCheck
         analyze_and_send_offenses(text_document_uri(params))
       end
 
+      def on_text_document_document_link(id, params)
+        uri = text_document_uri(params)
+        send_response(
+          id: id,
+          result: document_links(uri)
+        )
+      end
+
       def on_text_document_completion(id, params)
         uri = text_document_uri(params)
         line = params.dig('position', 'line')
@@ -71,6 +81,23 @@ module ThemeCheck
 
       private
 
+      def in_memory_storage(root)
+        config = ThemeCheck::Config.from_path(root)
+
+        # Make a real FS to get the files from the snippets folder
+        fs = ThemeCheck::FileSystemStorage.new(
+          config.root,
+          ignored_patterns: config.ignored_patterns
+        )
+
+        # Turn that into a hash of empty buffers
+        files = fs.files
+          .map { |fn| [fn, ""] }
+          .to_h
+
+        InMemoryStorage.new(files, root)
+      end
+
       def text_document_uri(params)
         params.dig('textDocument', 'uri').sub('file://', '')
       end
@@ -108,6 +135,10 @@ module ThemeCheck
         @completion_engine.completions(uri, line, col)
       end
 
+      def document_links(uri)
+        @document_link_engine.document_links(uri)
+      end
+
       def send_diagnostics(offenses)
         reported_files = Set.new
 

data/lib/theme_check/language_server/server.rb

@@ -6,6 +6,7 @@ require 'active_support/core_ext/string/inflections'
 module ThemeCheck
   module LanguageServer
     class DoneStreaming < StandardError; end
+
     class IncompatibleStream < StandardError; end
 
     class Server
@@ -15,7 +16,7 @@ module ThemeCheck
       def initialize(
         in_stream: STDIN,
         out_stream: STDOUT,
-        err_stream: $DEBUG ? File.open('/tmp/lsp.log', 'a') : STDERR,
+        err_stream: STDERR,
         should_raise_errors: false
       )
         validate!([in_stream, out_stream, err_stream])
@@ -50,7 +51,7 @@ module ThemeCheck
 
       def send_response(response)
         response_body = JSON.dump(response)
-        log(response_body) if $DEBUG
+        log(JSON.pretty_generate(response)) if $DEBUG
 
         @out.write("Content-Length: #{response_body.size}\r\n")
         @out.write("\r\n")

data/lib/theme_check/liquid_check.rb

@@ -6,6 +6,17 @@ module ThemeCheck
     extend ChecksTracking
     include ParsingHelpers
 
+    TAG = /#{Liquid::TagStart}.*?#{Liquid::TagEnd}/om
+    VARIABLE = /#{Liquid::VariableStart}.*?#{Liquid::VariableEnd}/om
+    START_OR_END_QUOTE = /(^['"])|(['"]$)/
+    QUOTED_LIQUID_ATTRIBUTE = %r{
+      '(?:#{TAG}|#{VARIABLE}|[^'])*'| # any combination of tag/variable or non straight quote inside straight quotes
+      "(?:#{TAG}|#{VARIABLE}|[^"])*"  # any combination of tag/variable or non double quotes inside double quotes
+    }omix
+    ATTR = /[a-z0-9-]+/i
+    HTML_ATTRIBUTE = /#{ATTR}(?:=#{QUOTED_LIQUID_ATTRIBUTE})?/omix
+    HTML_ATTRIBUTES = /(?:#{HTML_ATTRIBUTE}|\s)*/omix
+
     def add_offense(message, node: nil, template: node&.template, markup: nil, line_number: nil, &block)
       offenses << Offense.new(check: self, message: message, template: template, node: node, markup: markup, line_number: line_number, correction: block)
     end

data/lib/theme_check/remote_asset_file.rb

@@ -38,7 +38,7 @@ module ThemeCheck
     end
 
     def gzipped_size
-      @gzipped_size ||= @content.bytesize
+      @gzipped_size ||= content.bytesize
     end
   end
 end

data/lib/theme_check/shopify_liquid/deprecated_filter.rb

@@ -10,6 +10,10 @@ module ThemeCheck
         all.fetch(filter, nil)
       end
 
+      def labels
+        @labels ||= all.keys
+      end
+
       private
 
       def all

data/lib/theme_check/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ThemeCheck
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -81,12 +81,15 @@ files:
 - data/shopify_liquid/objects.yml
 - data/shopify_liquid/plus_objects.yml
 - data/shopify_liquid/tags.yml
+- data/shopify_translation_keys.yml
 - dev.yml
 - docs/checks/CHECK_DOCS_TEMPLATE.md
+- docs/checks/asset_size_css.md
 - docs/checks/asset_size_javascript.md
 - docs/checks/convert_include_to_render.md
 - docs/checks/default_locale.md
 - docs/checks/deprecated_filter.md
+- docs/checks/img_width_and_height.md
 - docs/checks/liquid_tag.md
 - docs/checks/matching_schema_translations.md
 - docs/checks/matching_translations.md
@@ -116,10 +119,12 @@ files:
 - lib/theme_check/asset_file.rb
 - lib/theme_check/check.rb
 - lib/theme_check/checks.rb
+- lib/theme_check/checks/asset_size_css.rb
 - lib/theme_check/checks/asset_size_javascript.rb
 - lib/theme_check/checks/convert_include_to_render.rb
 - lib/theme_check/checks/default_locale.rb
 - lib/theme_check/checks/deprecated_filter.rb
+- lib/theme_check/checks/img_width_and_height.rb
 - lib/theme_check/checks/liquid_tag.rb
 - lib/theme_check/checks/matching_schema_translations.rb
 - lib/theme_check/checks/matching_translations.rb
@@ -157,7 +162,10 @@ files:
 - lib/theme_check/language_server/completion_provider.rb
 - lib/theme_check/language_server/completion_providers/filter_completion_provider.rb
 - lib/theme_check/language_server/completion_providers/object_completion_provider.rb
+- lib/theme_check/language_server/completion_providers/render_snippet_completion_provider.rb
 - lib/theme_check/language_server/completion_providers/tag_completion_provider.rb
+- lib/theme_check/language_server/constants.rb
+- lib/theme_check/language_server/document_link_engine.rb
 - lib/theme_check/language_server/handler.rb
 - lib/theme_check/language_server/position_helper.rb
 - lib/theme_check/language_server/protocol.rb