theme-check 1.10.1 → 1.11.0

data/lib/theme_check/language_server/handler.rb

@@ -12,6 +12,16 @@ module ThemeCheck
         version: ThemeCheck::VERSION,
       }
 
+      # https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#fileOperationFilter
+      FILE_OPERATION_FILTER = {
+        filters: [{
+          scheme: 'file',
+          pattern: {
+            glob: '**/*',
+          },
+        }],
+      }
+
       CAPABILITIES = {
         completionProvider: {
           triggerCharacters: ['.', '{{ ', '{% '],
@@ -33,6 +43,13 @@ module ThemeCheck
           willSave: false,
           save: true,
         },
+        workspace: {
+          fileOperations: {
+            didCreate: FILE_OPERATION_FILTER,
+            didDelete: FILE_OPERATION_FILTER,
+            willRename: FILE_OPERATION_FILTER,
+          },
+        },
       }
 
       def initialize(bridge)
@@ -55,7 +72,12 @@ module ThemeCheck
         @diagnostics_engine = DiagnosticsEngine.new(@storage, @bridge, @diagnostics_manager)
         @execute_command_engine = ExecuteCommandEngine.new
         @execute_command_engine << CorrectionExecuteCommandProvider.new(@storage, @bridge, @diagnostics_manager)
-        @execute_command_engine << RunChecksExecuteCommandProvider.new(@diagnostics_engine, @root_path, config_for_path(@root_path))
+        @execute_command_engine << RunChecksExecuteCommandProvider.new(
+          @diagnostics_engine,
+          @storage,
+          config_for_path(@root_path),
+          @configuration,
+        )
         @code_action_engine = CodeActionEngine.new(@storage, @diagnostics_manager)
         @bridge.send_response(id, {
           capabilities: CAPABILITIES,
@@ -65,6 +87,7 @@ module ThemeCheck
 
       def on_initialized(_id, _params)
         return unless @configuration
+
         @configuration.fetch
         @configuration.register_did_change_capability
       end
@@ -91,9 +114,17 @@ module ThemeCheck
 
       def on_text_document_did_close(_id, params)
         relative_path = relative_path_from_text_document_uri(params)
-        file_system_content = Pathname.new(text_document_uri(params)).read(mode: 'rb', encoding: 'UTF-8')
-        # On close, the file system becomes the source of truth
-        @storage.write(relative_path, file_system_content, nil)
+        begin
+          file_system_content = Pathname.new(text_document_uri(params)).read(mode: 'rb', encoding: 'UTF-8')
+          # On close, the file system becomes the source of truth
+          @storage.write(relative_path, file_system_content, nil)
+
+        # the file no longer exists because either the user deleted it, or the user renamed it.
+        rescue Errno::ENOENT
+          @storage.remove(relative_path)
+        ensure
+          @diagnostics_engine.clear_diagnostics(relative_path) if @configuration.only_single_file?
+        end
       end
 
       def on_text_document_did_save(_id, params)
@@ -125,6 +156,52 @@ module ThemeCheck
         ))
       end
 
+      def on_workspace_did_create_files(_id, params)
+        paths = params[:files]
+          &.map { |file| file[:uri] }
+          &.map { |uri| file_path(uri) }
+        return unless paths
+
+        paths.each do |path|
+          relative_path = @storage.relative_path(path)
+          file_system_content = Pathname.new(path).read(mode: 'rb', encoding: 'UTF-8')
+          @storage.write(relative_path, file_system_content, nil)
+        end
+      end
+
+      def on_workspace_did_delete_files(_id, params)
+        absolute_paths = params[:files]
+          &.map { |file| file[:uri] }
+          &.map { |uri| file_path(uri) }
+        return unless absolute_paths
+
+        absolute_paths.each do |path|
+          relative_path = @storage.relative_path(path)
+          @storage.remove(relative_path)
+        end
+
+        analyze_and_send_offenses(absolute_paths)
+      end
+
+      # We're using workspace/willRenameFiles here because we want this to run
+      # before textDocument/didOpen and textDocumetn/didClose of the files
+      # (which might trigger another theme analysis).
+      def on_workspace_will_rename_files(id, params)
+        relative_paths = params[:files]
+          &.map { |file| [file[:oldUri], file[:newUri]] }
+          &.map { |(old_uri, new_uri)| [relative_path_from_uri(old_uri), relative_path_from_uri(new_uri)] }
+        return @bridge.send_response(id, nil) unless relative_paths
+
+        relative_paths.each do |(old_path, new_path)|
+          @storage.write(new_path, @storage.read(old_path), nil)
+          @storage.remove(old_path)
+        end
+        @bridge.send_response(id, nil)
+
+        absolute_paths = relative_paths.flatten(2).map { |p| @storage.path(p) }
+        analyze_and_send_offenses(absolute_paths)
+      end
+
       def on_workspace_execute_command(id, params)
         @bridge.send_response(id, @execute_command_engine.execute(
           params[:command],
@@ -159,6 +236,10 @@ module ThemeCheck
         file_path(params.dig(:textDocument, :uri))
       end
 
+      def relative_path_from_uri(uri)
+        @storage.relative_path(file_path(uri))
+      end
+
       def relative_path_from_text_document_uri(params)
         @storage.relative_path(text_document_uri(params))
       end
@@ -185,15 +266,16 @@ module ThemeCheck
         params.dig(:contentChanges, 0, :text)
       end
 
-      def config_for_path(path)
+      def config_for_path(path_or_paths)
+        path = path_or_paths.is_a?(Array) ? path_or_paths[0] : path_or_paths
         root = ThemeCheck::Config.find(path) || @root_path
         ThemeCheck::Config.from_path(root)
       end
 
-      def analyze_and_send_offenses(absolute_path, only_single_file: nil)
+      def analyze_and_send_offenses(absolute_path_or_paths, only_single_file: nil)
         @diagnostics_engine.analyze_and_send_offenses(
-          absolute_path,
-          config_for_path(absolute_path),
+          absolute_path_or_paths,
+          config_for_path(absolute_path_or_paths),
           only_single_file: only_single_file.nil? ? @configuration.only_single_file? : only_single_file
         )
       end

data/lib/theme_check/language_server/server.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 require 'json'
 require 'stringio'
+require 'timeout'
 
 module ThemeCheck
   module LanguageServer
@@ -45,10 +47,29 @@ module ThemeCheck
       def listen
         start_handler_threads
         start_json_rpc_thread
-        status_code = status_code_from_error(@error.pop)
+        err = @error.pop
+        status_code = status_code_from_error(err)
+
+        if status_code > 0
+          # For a reason I can't comprehend, this hangs but prints
+          # anyway. So it's wrapped in this ugly timeout...
+          Timeout.timeout(1) do
+            $stderr.puts err.full_message
+          end
+
+          # Warn user of error, otherwise server might restart
+          # without telling you.
+          @bridge.send_notification("window/showMessage", {
+            type: 1,
+            message: "A theme-check-language-server error has occurred, search OUTPUT logs for details.",
+          })
+        end
+
         cleanup(status_code)
       rescue SignalException
         0
+      rescue StandardError
+        2
       end
 
       def start_json_rpc_thread
@@ -65,36 +86,43 @@ module ThemeCheck
             else
               @queue << message
             end
-          rescue Exception => e # rubocop:disable Lint/RescueException
-            break @error << e
           end
+        rescue Exception => e # rubocop:disable Lint/RescueException
+          @bridge.log("rescuing #{e.class} in jsonrpc thread")
+          @error << e
         end
       end
 
       def start_handler_threads
         @number_of_threads.times do
           @handlers << Thread.new do
-            loop do
-              message = @queue.pop
-              break if @queue.closed? && @queue.empty?
-              handle_message(message)
-            rescue Exception => e # rubocop:disable Lint/RescueException
-              break @error << e
-            end
+            handle_messages
           end
         end
       end
 
+      def handle_messages
+        loop do
+          message = @queue.pop
+          return if @queue.closed? && @queue.empty?
+
+          handle_message(message)
+        end
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        @bridge.log("rescuing #{e.class} in handler thread")
+        @error << e
+      end
+
       def status_code_from_error(e)
         raise e
 
       # support ctrl+c and stuff
       rescue SignalException, DoneStreaming
         0
-
       rescue Exception => e # rubocop:disable Lint/RescueException
         raise e if should_raise_errors
-        @bridge.log("#{e.class}: #{e.message}\n#{e.backtrace.join("\n")}")
+
+        @bridge.log("Fatal #{e.class}")
         2
       end
 
@@ -109,15 +137,14 @@ module ThemeCheck
         if @handler.respond_to?(method_name)
           @handler.send(method_name, id, params)
         end
-
       rescue DoneStreaming => e
         raise e
       rescue StandardError => e
         is_request = id
         raise e unless is_request
+
         # Errors obtained in request handlers should be sent
         # back as internal errors instead of closing the program.
-        @bridge.log("#{e.class}: #{e.message}\n#{e.backtrace.join("\n")}")
         @bridge.send_internal_error(id, e)
       end
 
@@ -132,6 +159,7 @@ module ThemeCheck
       end
 
       def cleanup(status_code)
+        @bridge.log("Closing server... status code = #{status_code}")
         # Stop listenting to RPC calls
         @messenger.close_input
         # Wait for rpc loop to close

data/lib/theme_check/language_server/versioned_in_memory_storage.rb

@@ -8,7 +8,7 @@ module ThemeCheck
 
     def initialize(files, root = "/dev/null")
       super(files, root)
-      @versions = {}
+      @versions = {} # Hash<relative_path, number>
       @mutex = Mutex.new
     end
 
@@ -49,7 +49,11 @@ module ThemeCheck
     #   - Only offer fixes on "clean" files (or offer the change but specify the version so the editor knows what to do with it)
     def write(relative_path, content, version)
       @mutex.synchronize do
-        @versions[relative_path] = version
+        if version.nil?
+          @versions.delete(relative_path)
+        else
+          @versions[relative_path] = version
+        end
         super(relative_path, content)
       end
     end
@@ -58,6 +62,13 @@ module ThemeCheck
       @mutex.synchronize { [read(relative_path), version(relative_path)] }
     end
 
+    def remove(relative_path)
+      @mutex.synchronize do
+        @versions.delete(relative_path)
+        super(relative_path)
+      end
+    end
+
     def versioned?
       true
     end
@@ -65,5 +76,9 @@ module ThemeCheck
     def version(relative_path)
       @versions[relative_path.to_s]
     end
+
+    def opened_files
+      @versions.keys
+    end
   end
 end

data/lib/theme_check/liquid_file.rb

@@ -33,7 +33,22 @@ module ThemeCheck
 
     def source_excerpt(line)
       original_lines = source.split("\n")
-      original_lines[line - 1].strip
+      original_lines[bounded(0, line - 1, original_lines.size - 1)].strip
+    rescue => e
+      ThemeCheck.bug(<<~EOS)
+        Exception while running `source_excerpt(#{line})`:
+        ```
+        #{e.class}: #{e.message}
+          #{e.backtrace.join("\n  ")}
+        ```
+
+        path: #{path}
+
+        source:
+        ```
+        #{source}
+        ```
+      EOS
     end
 
     def parse
@@ -57,5 +72,11 @@ module ThemeCheck
         disable_liquid_c_nodes: true,
       )
     end
+
+    private
+
+    def bounded(lower, x, upper)
+      [lower, [x, upper].min].max
+    end
   end
 end

data/lib/theme_check/liquid_node.rb

@@ -7,6 +7,7 @@ module ThemeCheck
 
     def initialize(value, parent, theme_file)
       raise ArgumentError, "Expected a Liquid AST Node" if value.is_a?(LiquidNode)
+
       @value = value
       @parent = parent
       @theme_file = theme_file
@@ -37,7 +38,9 @@ module ThemeCheck
             node
           end
         end
-        nodes.map { |node| LiquidNode.new(node, self, @theme_file) }
+        nodes
+          .reject(&:nil?) # We don't want nil nodes, and they can happen
+          .map { |node| LiquidNode.new(node, self, @theme_file) }
       end
     end
 
@@ -75,11 +78,13 @@ module ThemeCheck
 
     def inner_markup
       return '' unless block?
+
       @inner_markup ||= source[block_start_end_index...block_end_start_index]
     end
 
     def inner_json
       return nil unless schema?
+
       @inner_json ||= JSON.parse(inner_markup)
     rescue JSON::ParserError
       # Handled by ValidSchema
@@ -153,6 +158,11 @@ module ThemeCheck
       @value.is_a?(Liquid::Comment)
     end
 
+    # {% # comment %}
+    def inline_comment?
+      @value.is_a?(Liquid::InlineComment)
+    end
+
     # Top level node of every liquid_file.
     def document?
       @value.is_a?(Liquid::Document)
@@ -186,6 +196,7 @@ module ThemeCheck
 
     def filters
       raise TypeError, "Attempting to lookup filters of #{type_name}. Only variables have filters." unless variable?
+
       @value.filters
     end
 
@@ -193,6 +204,25 @@ module ThemeCheck
       theme_file&.source
     end
 
+    # For debugging purposes, this might be easier for the eyes.
+    def to_h
+      if literal?
+        return @value
+      elsif variable_lookup?
+        return {
+          type_name: type_name,
+          name: value.name.to_s,
+          lookups: children.map(&:to_h),
+        }
+      end
+
+      {
+        type_name: type_name,
+        markup: outer_markup,
+        children: children.map(&:to_h),
+      }
+    end
+
     def block_start_markup
       source[block_start_start_index...block_start_end_index]
     end
@@ -217,11 +247,13 @@ module ThemeCheck
 
     def block_end_start_index
       return block_start_end_index unless tag? && block?
+
       @block_end_start_index ||= block_end_match&.begin(0) || block_start_end_index
     end
 
     def block_end_end_index
       return block_end_start_index unless tag? && block?
+
       @block_end_end_index ||= block_end_match&.end(0) || block_start_end_index
     end
 

data/lib/theme_check/liquid_visitor.rb

@@ -28,7 +28,7 @@ module ThemeCheck
         call_checks(:after_node, node)
       end
 
-      @disabled_checks.update(node) if node.comment?
+      @disabled_checks.update(node) if node.comment? || node.inline_comment?
     end
 
     def call_checks(method, *args)

data/lib/theme_check/schema_helper.rb

@@ -8,7 +8,7 @@ module ThemeCheck
       path.each_with_index.reduce(hash) do |pointer, (token, index)|
         if index == path.size - 1
           pointer[token] = value
-        elsif !pointer.key?(token)
+        elsif !pointer.key?(token) || !pointer[token].is_a?(Hash)
           pointer[token] = {}
         end
         pointer[token]

data/lib/theme_check/shopify_liquid/object.rb

@@ -13,6 +13,10 @@ module ThemeCheck
       def plus_labels
         @plus_labels ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/plus_objects.yml"))
       end
+
+      def theme_app_extension_labels
+        @theme_app_extension_labels ||= YAML.load(File.read("#{__dir__}/../../../data/shopify_liquid/theme_app_extension_objects.yml"))
+      end
     end
   end
 end

data/lib/theme_check/tags.rb

@@ -125,16 +125,32 @@ module ThemeCheck
     end
 
     class Render < Liquid::Tag
-      SYNTAX = /((?:#{Liquid::QuotedString}|#{Liquid::VariableSegment})+)(\s+(with|#{Liquid::Render::FOR})\s+(#{Liquid::QuotedFragment}+))?(\s+(?:as)\s+(#{Liquid::VariableSegment}+))?/o
+      SYNTAX = %r{
+        (
+          ## for {% render "snippet" %}
+          #{Liquid::QuotedString}+ |
+          ## for {% render block %}
+          ## We require the variable # segment to be at the beginning of the
+          ## string (with \A). This is to prevent code like {% render !foo! %}
+          ## from parsing
+          \A#{Liquid::VariableSegment}+
+        )
+        ## for {% render "snippet" with product as p %}
+        ## or {% render "snippet" for products p %}
+        (\s+(with|#{Liquid::Render::FOR})\s+(#{Liquid::QuotedFragment}+))?
+        (\s+(?:as)\s+(#{Liquid::VariableSegment}+))?
+        ## variables passed into the tag (e.g. {% render "snippet", var1: value1, var2: value2 %}
+        ## are not matched by this regex and are handled by Liquid::Render.initialize
+      }xo
 
       disable_tags "include"
 
-      attr_reader :template_name_expr, :attributes
+      attr_reader :template_name_expr, :variable_name_expr, :attributes
 
       def initialize(tag_name, markup, options)
         super
 
-        raise SyntaxError, options[:locale].t("errors.syntax.render") unless markup =~ SYNTAX
+        raise Liquid::SyntaxError, options[:locale].t("errors.syntax.render") unless markup =~ SYNTAX
 
         template_name = Regexp.last_match(1)
         with_or_for = Regexp.last_match(3)
@@ -155,6 +171,7 @@ module ThemeCheck
         def children
           [
             @node.template_name_expr,
+            @node.variable_name_expr,
           ] + @node.attributes.values
         end
       end

data/lib/theme_check/version.rb

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

data/theme-check.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/Shopify/theme-check"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = ">= 2.6"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency('liquid', '>= 5.1.0')
+  spec.add_dependency('liquid', '>= 5.4.0')
   spec.add_dependency('nokogiri', '>= 1.12')
   spec.add_dependency('parser', '~> 3')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theme-check
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Marc-André Cournoyer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.4.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +61,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/probots.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/cla.yml"
 - ".github/workflows/theme-check.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -84,6 +86,7 @@ files:
 - data/shopify_liquid/objects.yml
 - data/shopify_liquid/plus_objects.yml
 - data/shopify_liquid/tags.yml
+- data/shopify_liquid/theme_app_extension_objects.yml
 - data/shopify_translation_keys.yml
 - dev.yml
 - docs/api/check.md
@@ -92,6 +95,7 @@ files:
 - docs/api/liquid_check.md
 - docs/checks/TEMPLATE.md.erb
 - docs/checks/app_block_valid_tags.md
+- docs/checks/asset_preload.md
 - docs/checks/asset_size_app_block_css.md
 - docs/checks/asset_size_app_block_javascript.md
 - docs/checks/asset_size_css.md
@@ -152,6 +156,7 @@ files:
 - lib/theme_check/checks.rb
 - lib/theme_check/checks/TEMPLATE.rb.erb
 - lib/theme_check/checks/app_block_valid_tags.rb
+- lib/theme_check/checks/asset_preload.rb
 - lib/theme_check/checks/asset_size_app_block_css.rb
 - lib/theme_check/checks/asset_size_app_block_javascript.rb
 - lib/theme_check/checks/asset_size_css.rb
@@ -293,14 +298,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: A Shopify Theme Linter

data/.github/probots.yml

@@ -1,3 +0,0 @@
-# .github/probots.yml
-enabled:
-  - cla