platformos-check 0.1.0 → 0.2.1

data/lib/platformos_check/checks/undefined_object.rb

@@ -16,7 +16,7 @@ module PlatformosCheck
         @app_file = app_file
       end
 
-      attr_reader :all_assigns, :all_captures, :all_forloops, :app_file
+      attr_reader :all_assigns, :all_captures, :all_forloops, :app_file, :all_renders
 
       def add_render(name:, node:)
         @all_renders[name] = node
@@ -58,39 +58,32 @@ module PlatformosCheck
       end
     end
 
-    def initialize(config_type: :default, exclude_partials: true)
+    def self.single_file(**_args)
+      true
+    end
+
+    def initialize(config_type: :default)
       @config_type = config_type
-      @exclude_partials = exclude_partials
       @files = {}
     end
 
     def on_document(node)
-      return if ignore?(node)
-
       @files[node.app_file.name] = TemplateInfo.new(app_file: node.app_file)
     end
 
     def on_assign(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_assigns[node.value.to] = node
     end
 
     def on_capture(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_captures[node.value.instance_variable_get(:@to)] = node
     end
 
     def on_parse_json(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_captures[node.value.to] = node
     end
 
     def on_for(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_forloops[node.value.variable_name] = node
     end
 
@@ -99,7 +92,6 @@ module PlatformosCheck
     end
 
     def on_render(node)
-      return if ignore?(node)
       return unless node.value.template_name_expr.is_a?(String)
 
       partial_name = node.value.template_name_expr
@@ -110,45 +102,52 @@ module PlatformosCheck
     end
 
     def on_function(node)
-      return if ignore?(node)
+      @files[node.app_file.name].all_assigns[node.value.to] = node
+
+      return unless node.value.from.is_a?(String)
 
-      name = node.value.from.is_a?(String) ? node.value.from : node.value.from.name
       @files[node.app_file.name].add_render(
-        name:,
+        name: node.value.from,
         node:
       )
-
-      @files[node.app_file.name].all_assigns[node.value.to] = node
     end
 
     def on_graphql(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].all_assigns[node.value.to] = node
     end
 
     def on_background(node)
-      return if ignore?(node)
       return unless node.value.partial_syntax
+
+      @files[node.app_file.name].all_assigns[node.value.to] = node
+
       return unless node.value.partial_name.is_a?(String)
 
       @files[node.app_file.name].add_render(
         name: node.value.partial_name,
         node:
       )
-
-      @files[node.app_file.name].all_assigns[node.value.to] = node
     end
 
     def on_variable_lookup(node)
-      return if ignore?(node)
-
       @files[node.app_file.name].add_variable_lookup(
         name: node.value.name,
         node:
       )
     end
 
+    def single_file_end_dependencies(app_file)
+      @files[app_file.name].all_renders.keys.map do |partial_name|
+        next if @files[partial_name]
+
+        partial_file = @platformos_app.partials.detect { |p| p.name == partial_name } # NOTE: undefined partial
+
+        next unless partial_file
+
+        partial_file
+      end.compact
+    end
+
     def on_end
       all_global_objects = PlatformosCheck::PlatformosLiquid::Object.labels
       all_global_objects.freeze
@@ -170,31 +169,28 @@ module PlatformosCheck
 
     attr_reader :config_type
 
-    def ignore?(node)
-      @exclude_partials && node.app_file.partial?
-    end
-
     def each_template
       @files.each do |(name, info)|
-        next if info.app_file.partial?
-
         yield [name, info]
       end
     end
 
-    def check_object(info, all_global_objects, render_node = nil, visited_partials = Set.new)
-      check_undefined(info, all_global_objects, render_node)
+    def check_object(info, all_global_objects, render_node = nil, visited_partials = Set.new, level = 0)
+      return if level > 1
+
+      check_undefined(info, all_global_objects, render_node) unless info.app_file.partial? && render_node.nil? # ||
 
       info.each_partial do |(partial_name, node)|
+        next if visited_partials.include?(partial_name)
+
         partial_info = @files[partial_name]
+
         next unless partial_info # NOTE: undefined partial
 
         partial_variables = node.value.attributes.keys +
                             [node.value.instance_variable_get(:@alias_name)]
-        unless visited_partials.include?(partial_name)
-          visited_partials << partial_name
-          check_object(partial_info, all_global_objects + partial_variables, node, visited_partials)
-        end
+        visited_partials << partial_name
+        check_object(partial_info, all_global_objects + partial_variables, node, visited_partials, level + 1)
       end
     end
 
@@ -213,7 +209,7 @@ module PlatformosCheck
 
         if render_node
           add_offense("Missing argument `#{name}`", node: render_node)
-        else
+        elsif !info.app_file.partial?
           add_offense("Undefined object `#{name}`", node:, line_number:)
         end
       end

data/lib/platformos_check/checks/unused_assign.rb

@@ -21,6 +21,10 @@ module PlatformosCheck
       end
     end
 
+    def self.single_file(**_args)
+      true
+    end
+
     def initialize
       @templates = {}
     end

data/lib/platformos_check/checks.rb

@@ -25,6 +25,12 @@ module PlatformosCheck
       @single_file ||= self.class.new(select(&:single_file?))
     end
 
+    def single_file_end_dependencies(app_file)
+      map do |check|
+        check.respond_to?(:single_file_end_dependencies) ? check.single_file_end_dependencies(app_file) : []
+      end.flatten.compact.uniq
+    end
+
     private
 
     def call_check_method(check, method, *args)

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

@@ -13,6 +13,7 @@ module PlatformosCheck
 
         PlatformosLiquid::SourceIndex
           .objects
+          .select(&:global?)
           .select { |object| object.name.start_with?(partial(variable_lookup)) }
           .map { |object| object_to_completion(object) }
       end

data/lib/platformos_check/language_server/completion_providers/tag_completion_provider.rb

@@ -5,34 +5,29 @@ module PlatformosCheck
     class TagCompletionProvider < CompletionProvider
       def completions(context)
         content = context.content
-        cursor = context.cursor
 
         return [] if content.nil?
-        return [] unless can_complete?(content, cursor)
+        return [] unless can_complete?(context)
 
-        partial = first_word(content) || ''
-        labels = PlatformosLiquid::Tag.labels
-        labels += PlatformosLiquid::Tag.end_labels
-        labels
-          .select { |w| w.start_with?(partial) }
-          .map { |tag| tag_to_completion(tag) }
+        partial = first_word(context.buffer.lines[context.line]) || ''
+        PlatformosLiquid::SourceIndex.tags.select { |tag| tag.name.start_with?(partial) }
+                                     .map { |tag| tag_to_completion(tag) }
       end
 
-      def can_complete?(content, cursor)
-        content.start_with?(Liquid::TagStart) && (
-          cursor_on_first_word?(content, cursor) ||
-          cursor_on_start_content?(content, cursor, Liquid::TagStart)
-        )
+      def can_complete?(context)
+        context.content.start_with?(Liquid::TagStart) && (cursor_on_first_word?(context.buffer.lines[context.line], context.col) || cursor_on_start_content?(context.buffer.lines[context.line], context.col, Liquid::TagStart))
       end
 
       private
 
       def tag_to_completion(tag)
-        content = PlatformosLiquid::Documentation.tag_doc(tag)
+        content = PlatformosLiquid::Documentation.tag_doc(tag.name)
 
         {
-          label: tag,
+          contents: content,
+          label: tag.name,
           kind: CompletionItemKinds::KEYWORD,
+          **format_hash(tag),
           **doc_hash(content)
         }
       end

data/lib/platformos_check/language_server/handler.rb

@@ -24,7 +24,7 @@ module PlatformosCheck
 
       CAPABILITIES = {
         completionProvider: {
-          triggerCharacters: ['.', '{{ ', '{% '],
+          triggerCharacters: ['.', '{{ ', '{% ', '/'],
           context: true
         },
         codeActionProvider: {

data/lib/platformos_check/language_server/hover_providers/tag_hover_provider.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PlatformosCheck
+  module LanguageServer
+    class TagHoverProvider < HoverProvider
+      def completions(context)
+        content = context.content
+
+        return [] if content.nil?
+        return [] unless can_complete?(context)
+
+        partial = first_word(context.buffer.lines[context.line]) || ''
+        PlatformosLiquid::SourceIndex.tags.select { |tag| tag.name.start_with?(partial) }
+                                     .map { |tag| tag_to_completion(tag) }.first
+      end
+
+      def can_complete?(context)
+        context.content.start_with?(Liquid::TagStart) && (cursor_on_first_word?(context.buffer.lines[context.line], context.col) || cursor_on_start_content?(context.buffer.lines[context.line], context.col, Liquid::TagStart))
+      end
+
+      private
+
+      def tag_to_completion(tag)
+        content = PlatformosLiquid::Documentation.tag_doc(tag.name)
+
+        {
+          contents: content,
+          label: tag.name,
+          kind: CompletionItemKinds::KEYWORD,
+          **format_hash(tag),
+          **doc_hash(content)
+        }
+      end
+    end
+  end
+end

data/lib/platformos_check/language_server/partial_completion_provider.rb

@@ -13,18 +13,18 @@ module PlatformosCheck
 
         files
           .select { |x| x.name.start_with?(@file_name) }
-          .map { |x| file_to_completion(x) }
+          .map { |x| file_to_completion(x, context) }
       end
 
       private
 
       def cursor_on_quoted_argument?(content, cursor)
-        match = content.match(regexp)
-        return false if match.nil?
+        @match = content.match(regexp)
+        return false if @match.nil?
 
-        return false unless match.begin(:partial) <= cursor && cursor <= match.end(:partial)
+        return false unless @match.begin(:partial) <= cursor && cursor <= @match.end(:partial)
 
-        @file_name = match[:partial]
+        @file_name = @match[:partial][0, cursor - @match.begin(:partial)]
         true
       end
 
@@ -36,11 +36,34 @@ module PlatformosCheck
         raise NotImplementedError
       end
 
-      def file_to_completion(file)
+      def file_to_completion(file, context)
         {
           label: file.name,
-          kind: CompletionItemKinds::SNIPPET,
-          detail: file.source
+          kind: CompletionItemKinds::TEXT,
+          detail: file.source,
+          textEdit: {
+            newText: file.name,
+            insert: {
+              start: {
+                line: context.line,
+                character: @match.begin(:partial)
+              },
+              end: {
+                line: context.line,
+                character: @match.end(:partial)
+              }
+            },
+            replace: {
+              start: {
+                line: context.line,
+                character: @match.begin(:partial)
+              },
+              end: {
+                line: context.line,
+                character: @match.end(:partial)
+              }
+            }
+          }
         }
       end
     end

data/lib/platformos_check/liquid_visitor.rb

@@ -4,13 +4,20 @@ module PlatformosCheck
   class LiquidVisitor
     attr_reader :checks
 
-    def initialize(checks, disabled_checks)
+    def initialize(checks, disabled_checks, only_single_file: false)
       @checks = checks
       @disabled_checks = disabled_checks
+      @only_single_file = only_single_file
     end
 
     def visit_liquid_file(liquid_file)
       visit(LiquidNode.new(liquid_file.root, nil, liquid_file))
+
+      if @only_single_file
+        checks.single_file_end_dependencies(liquid_file).each do |file|
+          visit(LiquidNode.new(file.root, nil, file))
+        end
+      end
     rescue Liquid::Error => e
       e.template_name = liquid_file.relative_path
       call_checks(:on_error, e)

data/lib/platformos_check/platformos_liquid/source_index/object_entry.rb

@@ -14,6 +14,10 @@ module PlatformosCheck
         def platformos_documentation_url
           "#{PLATFORMOS_DOCUMENTATION_URL}/developer-guide/variables/context-variable##{hash['name']}"
         end
+
+        def global?
+          hash.dig('access', 'global')
+        end
       end
     end
   end

data/lib/platformos_check/platformos_liquid/source_index/tag_entry.rb

@@ -15,6 +15,34 @@ module PlatformosCheck
           }
         end
 
+        def description
+          @descritpion = begin
+            desc = hash['description']&.strip || ''
+            desc = '' if desc == 'returns'
+            if parameters.any?
+              desc += "\n\n---\n\nParameters:"
+              parameters.each { |p| desc += "\n- #{p.full_summary}" }
+            end
+            if hash['return_type']&.any?
+              rt = hash['return_type'].first
+              rt['description'] = nil if rt['description']&.strip == ''
+              desc += "\n\nReturns:"
+              desc += "\n- #{[rt['type'], rt['description']].compact.join(': ')}\n"
+            end
+            if hash['examples']
+              desc += "\n\n---\n\n"
+              hash['examples'].each_with_index do |e, i|
+                example = e['raw_liquid'].gsub(/[\n]+/, "\n").strip.split('=>')
+                input = example[0]&.strip
+                output = example[1]&.strip
+                desc += "\n  - Example #{i}:\n\n```liquid\n#{input}\n```"
+                desc += "\n##\nOutput: #{output}" if output
+              end
+            end
+          end
+          desc
+        end
+
         def platformos_documentation_url
           "#{PLATFORMOS_DOCUMENTATION_URL}/api-reference/liquid/tags/#{hash['name']}"
         end

data/lib/platformos_check/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlatformosCheck
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: platformos-check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Piotr Bliszczyk
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -237,6 +237,7 @@ files:
 - lib/platformos_check/language_server/hover_engine.rb
 - lib/platformos_check/language_server/hover_provider.rb
 - lib/platformos_check/language_server/hover_providers/filter_hover_provider.rb
+- lib/platformos_check/language_server/hover_providers/tag_hover_provider.rb
 - lib/platformos_check/language_server/io_messenger.rb
 - lib/platformos_check/language_server/messenger.rb
 - lib/platformos_check/language_server/partial_completion_provider.rb