klenod-lsp 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8177f2a77a4e5e7b60ae1c83dc1d5106ad639b1357291987260e1b7915e4bd6f
-  data.tar.gz: 3a84fbf499a587a1592188606bc6be5d354b85f64d8acb8b03fe4eabc77add25
+  metadata.gz: d759a6c56f2fae5f3fc2508aefc25cbb2c710728b6b25e9967b5f981931d26bc
+  data.tar.gz: eba78d09c5055a0a93b8daa7433b836e83c32d95832f7dca444285cbf683b9e1
 SHA512:
-  metadata.gz: 98dc6548b480686f3b577787663feac6a6a4d3e0315eb71a96962986bdb60de975e4078df05369d670a6455733d1028dc89098983e73a4264fcb6ad43089ba53
-  data.tar.gz: 1ae98c5232a88076529ed9828a0317dc35a532f65ce850abe88c7b2af016270c6f85c87ee9864b49fb0735065addcc6041de155fa485905794f19b2267333b5e
+  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
@@ -125,9 +125,17 @@ module Klenod
       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"
 
@@ -27,6 +28,8 @@ module Klenod
           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/version.rb

@@ -2,6 +2,6 @@
 
 module Klenod
   module LSP
-    VERSION = "0.0.17"
+    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.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Andrés Alin
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.17
+        version: 0.0.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.17
+        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