klenod-lsp 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c19da186ca2391c2bec38dfa3aa24e17458b7925d9dbb92b3f444e5782297a3
-  data.tar.gz: dfda5e93c14feb280fb601d1f0234e5f9c25718e9f30eb644845911e3ebfda6e
+  metadata.gz: d759a6c56f2fae5f3fc2508aefc25cbb2c710728b6b25e9967b5f981931d26bc
+  data.tar.gz: eba78d09c5055a0a93b8daa7433b836e83c32d95832f7dca444285cbf683b9e1
 SHA512:
-  metadata.gz: 427d0cc60eaaafcc8418d3456e23f610806ad12327a56e9ae1f8ab0999c016c6bacc2c22c15cd6ff905e0e18895826218b109c6b851e0b581f5ea232e117f239
-  data.tar.gz: b0b4fac3a4632a9db230f2089b6395a650971cfef7de75b7b7773ac828ad5c3640c571fb924e5dd191c3f0f43ed732f9ce5be36c254f4c2d9651b5382f913a5f
+  metadata.gz: 987861aafeb188197a09e899ab5258c75a6655b65a0cf14da361217dd6dabec5c64cc1baf92df64e9562ef71dbf5d5598d13474928596d271d3c501b78d542c9
+  data.tar.gz: cf9bfad79548f6ce194490cd26c4524918fe25033c381d0e80078d24918315e5a439415849b8a44e0f0e62648c856b454cd40b23b7b7be2f30c7fdb91e604af9

data/lib/klenod/lsp/diagnostics.rb

@@ -8,7 +8,7 @@ require_relative "text"
 module Klenod
   module LSP
     # Turns the errors in an Analysis into LSP diagnostics on the original
-    # document. Every diagnostic is an error: Klenod has no warnings yet.
+    # document.
     module Diagnostics
       Interface = LanguageServer::Protocol::Interface
       Constant = LanguageServer::Protocol::Constant
@@ -58,6 +58,29 @@ module Klenod
         }.uniq { |diagnostic| [diagnostic.range.start.line, diagnostic.message] }
       end
 
+      # A failure the graph index recorded while collecting this module that
+      # analysis alone cannot see, such as a named import of a constant the
+      # target does not define: analysis only transforms and resolves, it never
+      # collects the target's record. The index refreshes on save, so the
+      # diagnostic is only shown while the document still contains the import
+      # it refers to.
+      def index_failure(analysis, index, syntax: Languages::Syntax::Ruby)
+        error = index&.failed&.[](analysis.module_id.to_s)
+        return [] unless error.is_a?(Klenod::Build::MissingExportError)
+        return [] unless error.module_id.to_s == analysis.module_id.to_s
+
+        lines = analysis.lines
+        report = error.cause
+        span = literal_spans(report.dependency.specifier.to_s, lines, syntax: syntax).find do |candidate|
+          named_import_span?(candidate, report.name, lines)
+        end
+        return [] unless span
+
+        message = "#{error.kind}: #{error.detail}"
+        message = "#{message}\n#{error.hints.join("\n")}" unless error.hints.empty?
+        [diagnostic(span, message)]
+      end
+
       def resolve_errors(analysis, lines, syntax)
         analysis.resolve_errors.map do |error|
           diagnostic(resolve_error_span(error, lines, syntax), error.message)
@@ -93,10 +116,26 @@ module Klenod
         spans
       end
 
+      # The same module can be imported more than once with different names.
+      # Match the name immediately following this literal rather than selecting
+      # the first matching specifier and inspecting its whole line.
+      def named_import_span?(span, name, lines)
+        suffix = lines[span.start.line].to_s[span.end.character..]
+        suffix&.match?(%r{\A["']\s*,\s*:#{Regexp.escape(name.to_s)}(?=\s*\))})
+      end
+
       def diagnostic(span, message)
+        diagnostic_with_severity(span, message, Constant::DiagnosticSeverity::ERROR)
+      end
+
+      def warning(span, message)
+        diagnostic_with_severity(span, message, Constant::DiagnosticSeverity::WARNING)
+      end
+
+      def diagnostic_with_severity(span, message, severity)
         Interface::Diagnostic.new(
           range: span.to_range,
-          severity: Constant::DiagnosticSeverity::ERROR,
+          severity: severity,
           source: SOURCE,
           message: message
         )

data/lib/klenod/lsp/languages/haml/iteration.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Klenod
+  module LSP
+    module Languages
+      class Haml
+        # Detects scripts whose nested Haml will not produce output. Haml's
+        # parser retains the body as children of the script node, which avoids
+        # guessing from indentation or warning about ordinary Ruby source in
+        # a filter.
+        module Iteration
+          module_function
+
+          ITERATOR = /\.(?<method>each|map)\b(?:\s*\([^\n]*\))?\s+do\b/
+
+          def diagnostics(analysis)
+            root = Klenod::Build::Plugins::HamlPlugin.parse_haml(analysis.source, module_id: analysis.module_id)
+            nodes = root.children.dup
+            diagnostics = []
+
+            until nodes.empty?
+              node = nodes.shift
+              nodes.concat(node.children)
+              case node.type
+              when :script
+                match = ITERATOR.match(node.value.fetch(:text))
+                diagnostics << each_diagnostic(node, match, analysis.lines) if match&.[](:method) == "each" && rendered_content?(node)
+              when :silent_script
+                diagnostics << silent_script_diagnostic(node, analysis.lines) if rendered_content?(node)
+              end
+            end
+
+            diagnostics
+          rescue Klenod::Build::Plugins::HamlPlugin::ParseError
+            []
+          end
+
+          def rendered_content?(node)
+            node.children.any? do |child|
+              [:plain, :script, :tag].include?(child.type) || (child.type == :filter && child.value.fetch(:name) != "ruby") || rendered_content?(child)
+            end
+          end
+
+          def each_diagnostic(node, match, lines)
+            line = node.line - 1
+            line_text = lines.fetch(line, "")
+            method_start = line_text.index(".#{match[:method]}") || 0
+            span = Text::Span.new(line, method_start, method_start + match[:method].length + 1)
+
+            Diagnostics.warning(span, "`= ...each do` returns the original collection, not the rendered Haml children; use `map` instead")
+          end
+
+          def silent_script_diagnostic(node, lines)
+            line = node.line - 1
+            line_text = lines.fetch(line, "")
+            start_character = line_text.index("-") || 0
+            span = Text::Span.new(line, start_character, start_character + 1)
+
+            Diagnostics.warning(span, "A silent `-` script discards its nested Haml content; use `=` when it should render")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/klenod/lsp/languages/haml.rb

@@ -6,6 +6,7 @@ require_relative "../text"
 require_relative "imports"
 require_relative "haml/classes"
 require_relative "haml/completion"
+require_relative "haml/iteration"
 require_relative "haml/props"
 require_relative "haml/rename"
 
@@ -23,9 +24,12 @@ module Klenod
 
         def diagnostics(analysis, workspace = nil, index = nil)
           diagnostics = Diagnostics.for_analysis(analysis)
+          diagnostics.concat(Diagnostics.index_failure(analysis, index))
           diagnostics.concat(Classes.diagnostics(analysis, workspace, index)) if workspace && index
           diagnostics.concat(Props.diagnostics(analysis, workspace, index)) if workspace && index
           diagnostics.concat(unused_binding_diagnostics(analysis))
+          diagnostics.concat(Iteration.diagnostics(analysis)) unless analysis.build_error
+          diagnostics
         end
 
         def completion(analysis, position, workspace, index = nil)

data/lib/klenod/lsp/languages/ruby.rb

@@ -15,8 +15,8 @@ module Klenod
 
         Interface = LanguageServer::Protocol::Interface
 
-        def diagnostics(analysis, _workspace = nil, _index = nil)
-          Diagnostics.for_analysis(analysis) + unused_binding_diagnostics(analysis)
+        def diagnostics(analysis, _workspace = nil, index = nil)
+          Diagnostics.for_analysis(analysis) + Diagnostics.index_failure(analysis, index) + unused_binding_diagnostics(analysis)
         end
 
         def document_symbols(analysis)

data/lib/klenod/lsp/server.rb

@@ -371,11 +371,11 @@ module Klenod
 
         @pending_collections.delete(document.uri)&.stop
         @pending_collections[document.uri] =
-          @task.async do |task|
-            task.sleep(DIAGNOSTICS_DEBOUNCE)
+          @task.async do
+            Kernel.sleep(DIAGNOSTICS_DEBOUNCE)
             publish_diagnostics(document)
             overlay(document)
-            task.sleep(COLLECTION_DEBOUNCE - DIAGNOSTICS_DEBOUNCE)
+            Kernel.sleep(COLLECTION_DEBOUNCE - DIAGNOSTICS_DEBOUNCE)
             @pending_collections.delete(document.uri)
             @index.ensure_collected(document.module_id, force: true)
           end

data/lib/klenod/lsp/version.rb

@@ -2,6 +2,6 @@
 
 module Klenod
   module LSP
-    VERSION = "0.0.16"
+    VERSION = "0.0.18"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klenod-lsp
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - Andrés Alin
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.16
+        version: 0.0.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.16
+        version: 0.0.18
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
   requirement: !ruby/object:Gem::Requirement
@@ -57,6 +57,7 @@ files:
 - lib/klenod/lsp/languages/haml.rb
 - lib/klenod/lsp/languages/haml/classes.rb
 - lib/klenod/lsp/languages/haml/completion.rb
+- lib/klenod/lsp/languages/haml/iteration.rb
 - lib/klenod/lsp/languages/haml/props.rb
 - lib/klenod/lsp/languages/haml/rename.rb
 - lib/klenod/lsp/languages/haml/ruby_regions.rb