feat: Add rbs-trace command

Implement a CLI tool with the following functions:

- inline: Insert RBS inline comments from RBS files
- merge: Merge multiple RBS files into one

Author: sinsoku

exe/rbs-trace

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "rbs-trace"
+RBS::Trace::CLI.new.run

lib/rbs/trace.rb

@@ -2,11 +2,15 @@
 
 require "bundler"
 require "logger"
+require "optparse"
 require "prism"
 require "rbs"
 
 require_relative "trace/helpers"
 require_relative "trace/builder"
+require_relative "trace/cli"
+require_relative "trace/cli/inline"
+require_relative "trace/cli/merge"
 require_relative "trace/file"
 require_relative "trace/inline_comment_visitor"
 require_relative "trace/method_tracing"

lib/rbs/trace/cli.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RBS
+  module Trace
+    class CLI
+      BANNER = <<~USAGE
+        Usage: rbs-trace <command> [<args>]
+
+        Available commands: inline, merge
+      USAGE
+
+      # @rbs (Array[String]) -> void
+      def run(args = ARGV)
+        opts = OptionParser.new(BANNER)
+        opts.version = RBS::Trace::VERSION
+        opts.order!(args)
+        command = args.shift&.to_sym
+
+        klass = command_class(command)
+        if klass
+          klass.new.run(args)
+        else
+          puts opts.help
+        end
+      end
+
+      private
+
+      # @rbs (Symbol?) -> (singleton(Inline) | singleton(Merge))?
+      def command_class(command)
+        case command
+        when :inline
+          Inline
+        when :merge
+          Merge
+        end
+      end
+    end
+  end
+end

lib/rbs/trace/cli/inline.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RBS
+  module Trace
+    class CLI
+      class Inline
+        BANNER = <<~USAGE
+          Usage: rbs-trace inline --sig-dir=DIR --rb-dir=DIR
+
+          Insert RBS inline comments from RBS files.
+
+          Examples:
+            # Insert inline comments to `app/**/*.rb`.
+            $ rbs-trace inline --sig-dir=sig --rb-dir=app
+
+            # Generate RBS files with rbs-inline.
+            $ rbs-inline --output --opt-out app
+
+            # Remove method definitions that have been migrated to inline comments.
+            $ rbs subtract --write sig sig/generated/
+
+          Options:
+        USAGE
+
+        # @rbs (Array[String]) -> void
+        def run(args) # rubocop:disable Metrics
+          sig_dir = nil
+          rb_dir = nil
+
+          opts = OptionParser.new(BANNER)
+          opts.on("--sig-dir DIR") { |dir| sig_dir = dir }
+          opts.on("--rb-dir DIR") { |dir| rb_dir = dir }
+          opts.parse!(args)
+
+          if sig_dir && rb_dir
+            env = load_env(sig_dir) # steep:ignore ArgumentTypeMismatch
+            decls = env.class_decls.transform_values { |v| v.primary.decl }
+
+            Dir.glob("#{rb_dir}/**/*.rb").each do |path|
+              file = File.new(path, decls)
+              file.rewrite
+            end
+          else
+            puts opts.help
+          end
+        end
+
+        private
+
+        # @rbs (String) -> Environment
+        def load_env(dir)
+          Environment.new.tap do |env|
+            loader = EnvironmentLoader.new(core_root: nil)
+            loader.add(path: Pathname(dir))
+            loader.load(env:)
+          end
+        end
+      end
+    end
+  end
+end

lib/rbs/trace/cli/merge.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RBS
+  module Trace
+    class CLI
+      class Merge
+        BANNER = <<~USAGE
+          Usage: rbs-trace merge --sig-dir=DIR
+
+          Merge multiple RBS files into one.
+
+          Examples:
+            # Merge RBS files in `tmp/sig-1/` and `tmp/sig-2/`.
+            $ rbs-trace merge --sig-dir=tmp/sig-1 --sig-dir=tmp/sig-2
+
+          Options:
+        USAGE
+
+        # @rbs (Array[String]) -> void
+        def run(args) # rubocop:disable Metrics
+          sig_dirs = [] #: Array[String]
+
+          opts = OptionParser.new(BANNER)
+          opts.on("--sig-dir DIR") { |dir| sig_dirs << dir }
+          opts.parse!(args)
+
+          if sig_dirs.empty?
+            puts opts.help
+          else
+            envs = sig_dirs.map { |dir| load_env(dir) }
+            env = merge_envs(envs)
+
+            out = StringIO.new
+            writer = Writer.new(out:)
+            writer.write(env.declarations)
+
+            puts out.string
+          end
+        end
+
+        private
+
+        # @rbs (String) -> Environment
+        def load_env(dir)
+          Environment.new.tap do |env|
+            loader = EnvironmentLoader.new(core_root: nil)
+            loader.add(path: Pathname(dir))
+            loader.load(env:)
+          end
+        end
+
+        # @rbs (Array[Environment]) -> Environment
+        def merge_envs(others)
+          Environment.new.tap do |env|
+            others.each do |other|
+              other.declarations.each do |decl|
+                env << decl
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/rbs/trace/file.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "stringio"
+
 module RBS
   module Trace
     class File

sig/generated/rbs/trace/cli.rbs

@@ -0,0 +1,17 @@
+# Generated from lib/rbs/trace/cli.rb with RBS::Inline
+
+module RBS
+  module Trace
+    class CLI
+      BANNER: ::String
+
+      # @rbs (Array[String]) -> void
+      def run: (Array[String]) -> void
+
+      private
+
+      # @rbs (Symbol?) -> (singleton(Inline) | singleton(Merge))?
+      def command_class: (Symbol?) -> (singleton(Inline) | singleton(Merge))?
+    end
+  end
+end

sig/generated/rbs/trace/cli/inline.rbs

@@ -0,0 +1,19 @@
+# Generated from lib/rbs/trace/cli/inline.rb with RBS::Inline
+
+module RBS
+  module Trace
+    class CLI
+      class Inline
+        BANNER: ::String
+
+        # @rbs (Array[String]) -> void
+        def run: (Array[String]) -> void
+
+        private
+
+        # @rbs (String) -> Environment
+        def load_env: (String) -> Environment
+      end
+    end
+  end
+end

sig/generated/rbs/trace/cli/merge.rbs

@@ -0,0 +1,22 @@
+# Generated from lib/rbs/trace/cli/merge.rb with RBS::Inline
+
+module RBS
+  module Trace
+    class CLI
+      class Merge
+        BANNER: ::String
+
+        # @rbs (Array[String]) -> void
+        def run: (Array[String]) -> void
+
+        private
+
+        # @rbs (String) -> Environment
+        def load_env: (String) -> Environment
+
+        # @rbs (Array[Environment]) -> Environment
+        def merge_envs: (Array[Environment]) -> Environment
+      end
+    end
+  end
+end