Represent CLI warnings and aborts as diagnostics

Route remaining user-facing command aborts and optional dependency warnings through Lrama::Diagnostic objects while preserving their existing stderr text. This closes the gap where some warning and error output bypassed the diagnostic model.

Author: ydah

lib/lrama/command.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "diagnostic"
+
 module Lrama
   class Command
     LRAMA_LIB = File.realpath(File.join(File.dirname(__FILE__)))
@@ -12,7 +14,7 @@ def initialize(argv)
       @reporter = Reporter.new(**@options.report_opts)
       @warnings = Warnings.new(@logger, @options.warnings)
     rescue => e
-      abort format_error_message(e.message)
+      abort_with_diagnostic("command.option_error", e)
     end
 
     def run
@@ -52,7 +54,7 @@ def build_grammar(text)
       grammar
     rescue => e
       raise e if @options.debug
-      abort format_error_message(e.message)
+      abort_with_diagnostic("command.grammar_error", e)
     end
 
     def format_error_message(message)
@@ -61,6 +63,17 @@ def format_error_message(message)
       message.gsub(/.+/, "\e[1m\\&\e[m")
     end
 
+    def abort_with_diagnostic(id, exception)
+      diagnostic = Lrama::Diagnostic.new(
+        id: id,
+        severity: :error,
+        message: exception.message,
+        details: { "exception_class" => exception.class.name }
+      )
+
+      abort format_error_message(diagnostic.message)
+    end
+
     def merge_stdlib(grammar)
       return if grammar.no_stdlib
 

lib/lrama/diagram.rb

@@ -1,6 +1,8 @@
 # rbs_inline: enabled
 # frozen_string_literal: true
 
+require_relative "diagnostic"
+
 module Lrama
   class Diagram
     class << self
@@ -15,7 +17,14 @@ def require_railroad_diagrams
         require "railroad_diagrams"
         true
       rescue LoadError
-        warn "railroad_diagrams is not installed. Please run `bundle install`."
+        diagnostic = Lrama::Diagnostic.new(
+          id: "dependency.railroad_diagrams.missing",
+          severity: :warning,
+          message: "railroad_diagrams is not installed. Please run `bundle install`.",
+          details: { "gem" => "railroad_diagrams" },
+          suggestion: "Run `bundle install`."
+        )
+        $stderr.puts(diagnostic.message)
         false
       end
     end

lib/lrama/option_parser.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'optparse'
+require_relative 'diagnostic'
 
 module Lrama
   # Handle option parsing for the command line interface.
@@ -35,11 +36,11 @@ def parse(argv)
       @options.grammar_file = argv.shift
 
       unless @options.grammar_file
-        abort "File should be specified\n"
+        abort_with_diagnostic("command.missing_grammar_file", "File should be specified")
       end
 
       if @options.grammar_file == '-'
-        @options.grammar_file = argv.shift or abort "File name for STDIN should be specified\n"
+        @options.grammar_file = argv.shift or abort_with_diagnostic("command.missing_stdin_filename", "File name for STDIN should be specified")
       else
         @options.y = File.open(@options.grammar_file, 'r')
       end
@@ -62,6 +63,17 @@ def parse(argv)
 
     private
 
+    # @rbs (String id, String message) -> bot
+    def abort_with_diagnostic(id, message)
+      diagnostic = Lrama::Diagnostic.new(
+        id: id,
+        severity: :error,
+        message: message
+      )
+
+      abort diagnostic.message
+    end
+
     # @rbs (Array[String]) -> void
     def parse_by_option_parser(argv)
       ::OptionParser.new do |o|

lib/lrama/reporter/profile/call_stack.rb

@@ -1,6 +1,8 @@
 # rbs_inline: enabled
 # frozen_string_literal: true
 
+require_relative "../../diagnostic"
+
 module Lrama
   class Reporter
     module Profile
@@ -36,7 +38,14 @@ def self.require_stackprof
           require "stackprof"
           true
         rescue LoadError
-          warn "stackprof is not installed. Please run `bundle install`."
+          diagnostic = Lrama::Diagnostic.new(
+            id: "dependency.stackprof.missing",
+            severity: :warning,
+            message: "stackprof is not installed. Please run `bundle install`.",
+            details: { "gem" => "stackprof" },
+            suggestion: "Run `bundle install`."
+          )
+          $stderr.puts(diagnostic.message)
           false
         end
       end

lib/lrama/reporter/profile/memory.rb

@@ -1,6 +1,8 @@
 # rbs_inline: enabled
 # frozen_string_literal: true
 
+require_relative "../../diagnostic"
+
 module Lrama
   class Reporter
     module Profile
@@ -35,7 +37,14 @@ def self.require_memory_profiler
           require "memory_profiler"
           true
         rescue LoadError
-          warn "memory_profiler is not installed. Please run `bundle install`."
+          diagnostic = Lrama::Diagnostic.new(
+            id: "dependency.memory_profiler.missing",
+            severity: :warning,
+            message: "memory_profiler is not installed. Please run `bundle install`.",
+            details: { "gem" => "memory_profiler" },
+            suggestion: "Run `bundle install`."
+          )
+          $stderr.puts(diagnostic.message)
           false
         end
       end