Make the severity of diagnostics configurable

It is useful to prevent false positives (temporarily)

Author: mame

lib/typeprof/diagnostic.rb

@@ -1,18 +1,17 @@
 module TypeProf
   class Diagnostic
-    def initialize(node, meth, msg, severity: :error, tags: nil)
+    def initialize(node, meth, msg, tags: nil)
       @node = node
       @meth = meth
       @msg = msg
-      @severity = severity
       @tags = tags
     end
 
     def reuse(new_node)
       @node = new_node
     end
 
-    attr_reader :msg, :severity, :tags
+    attr_reader :msg, :tags
 
     def code_range
       @node.send(@meth)
@@ -21,13 +20,13 @@ def code_range
     SEVERITY = { error: 1, warning: 2, info: 3, hint: 4 }
     TAG = { unnecessary: 1, deprecated: 2 }
 
-    def to_lsp
+    def to_lsp(severity: :error)
       json = {
         range: code_range.to_lsp,
         source: "TypeProf",
         message: @msg,
       }
-      json[:severity] = SEVERITY[@severity] if @severity
+      json[:severity] = SEVERITY[severity]
       json[:tags] = @tags.map {|tag| TAG[tag] } if @tags
       json
     end

lib/typeprof/lsp/server.rb

@@ -57,6 +57,7 @@ def initialize(core, reader, writer, url_schema: nil, publish_all_diagnostics: f
       @signature_enabled = true
       @url_schema = url_schema || (File::ALT_SEPARATOR != "\\" ? "file://" : "file:///")
       @publish_all_diagnostics = publish_all_diagnostics # TODO: implement more dedicated publish feature
+      @diagnostic_severity = :error
     end
 
     attr_reader :core, :open_texts
@@ -77,6 +78,15 @@ def add_workspaces(folders)
           conf = TypeProf::LSP.load_json_with_comments(conf_path, symbolize_names: true)
           if conf
             if conf[:typeprof_version] == "experimental"
+              if conf[:diagnostic_severity]
+                severity = conf[:diagnostic_severity].to_sym
+                case severity
+                when :error, :warning, :info, :hint
+                  @diagnostic_severity = severity
+                else
+                  puts "unknown severity: #{ severity }"
+                end
+              end
               if conf[:analysis_unit_dirs].size >= 2
                  puts "currently analysis_unit_dirs can have only one directory"
               end
@@ -152,7 +162,7 @@ def publish_diagnostics(uri)
         diags = []
         if text
           @core.diagnostics(text.path) do |diag|
-            diags << diag.to_lsp
+            diags << diag.to_lsp(severity: @diagnostic_severity)
           end
         end
         send_notification(

test/diagnostic_test.rb

@@ -8,26 +8,9 @@ def code_range
       end
     end
 
-    def test_diagnostic_with_default_values
+    def test_diagnostic
       diag = Diagnostic.new(DummyNode.new, :code_range, "test message")
-      assert_equal :error, diag.severity
       assert_nil diag.tags
     end
-
-    def test_diagnostic_with_custom_severity
-      diag = Diagnostic.new(DummyNode.new, :code_range, "test message", severity: :warning)
-      assert_equal :warning, diag.severity
-    end
-
-    def test_diagnostic_with_custom_tags
-      diag = Diagnostic.new(DummyNode.new, :code_range, "test message", tags: [:deprecated])
-      assert_equal [:deprecated], diag.tags
-    end
-
-    def test_diagnostic_with_custom_severity_and_tags
-      diag = Diagnostic.new(DummyNode.new, :code_range, "test message", severity: :info, tags: [:experimental])
-      assert_equal :info, diag.severity
-      assert_equal [:experimental], diag.tags
-    end
   end
 end

typeprof.conf.json

@@ -15,5 +15,9 @@
     "analysis_unit_dirs": [
         "lib/typeprof/core/",
         // "lib/typeprof/lsp",
-    ]
+    ],
+
+    // Severity of diagnosis, selectable from "error", "warning", "info", "hint", and "none".
+    // Currently, TypeProf reports many false positives, so it is recommended to use "hint" or "none".
+    "diagnostic_severity": "info"
 }