rbs-inline-annotator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b957db6fbd29cfa5e3b4b5613386beeeb3aebf40f7a576e01a95e31fa88267b3
+  data.tar.gz: 7d6a684f4c95daec4926e3f2500d55b294d33b423cda307c1af0276db2400390
+SHA512:
+  metadata.gz: 6bd9cabe241ca29a157fc3bf91cbe962fe182d629d9417c571a98db6117f61f331327bd4d713340272a63d0d228aa467596da3d9a5478c2e24ad09910d46d1ed
+  data.tar.gz: 0a432b269bb9d2ce12618bfa5eb766db14ea987b68135115f7c636c6d4cba2390b04707c1edbac6df96ad2f270e979d9b21c831e2965ac8208d419d46036c0f1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-29
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 ksss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# RBS::Inline::Annotator
+
+Add rbs-inline annotation to ruby code by rbs code.
+
+```rb
+# lib/foo.rb
+class Foo
+  def foo(a)
+    a.to_s
+  end
+end
+```
+
+\+
+
+```rbs
+# sig/foo.rbs
+class Foo
+  def foo: (Integer) -> String
+end
+```
+
+=
+
+```rb
+# lib/foo.rb
+class Foo
+  # @rbs a: Integer
+  # @rbs return: String
+  def foo(a)
+    a.to_s
+  end
+end
+```
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+### Add rbs-inline annotation to ruby file
+
+```shell
+$ bundle exec rbs-inline-annotator -I sig target_dir_or_file
+```
+
+### Print result code to stdout only
+
+```shell
+$ bundle exec rbs-inline-annotator -I sig --mode print-only target_dir_or_file
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ksss/rbs-inline-annotator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ksss/rbs-inline-annotator/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rbs::Inline::Annotator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ksss/rbs-inline-annotator/blob/main/CODE_OF_CONDUCT.md).

data/exe/rbs-inline-annotator

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rbs/inline/annotator"
+
+exit RBS::Inline::Annotator::CLI.new(ARGV).run

data/lib/rbs/inline/annotator/cli.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module RBS::Inline::Annotator
+  class CLI
+    class Spinner
+      DOTS = %w[⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏]
+
+      def initialize
+        @index = 0
+      end
+
+      def tick
+        @index = (@index + 1) % DOTS.size
+        DOTS[@index]
+      end
+    end
+
+    Options = Struct.new(:mode)
+
+    def initialize(argv)
+      @loader = RBS::EnvironmentLoader.new(core_root: nil)
+      @argv = argv
+      @options = Options.new(
+        mode: 'write'
+      )
+      OptionParser.new do |opt|
+        opt.on("-I DIR", "Load RBS files from the directory") do |dir|
+          @loader.add(path: Pathname(dir))
+        end
+        opt.on("-m", "--mode MODE", "Mode [quiet, print-only, write] (default: write)") do |mode|
+          @options.mode = mode
+        end
+      end.parse!(@argv)
+    end
+
+    def run
+      env = RBS::Environment.from_loader(@loader)
+      targets = @argv.flat_map { Pathname.glob(_1) }.flat_map do |path|
+        if path.directory?
+          pattern = path / "**/*.rb"
+          Pathname.glob(pattern.to_s)
+        else
+          path
+        end
+      end
+
+      targets.sort!
+      targets.uniq!
+
+      Spinner.new.tap do |spinner|
+        print "\e[?25l" if @options.mode == 'write'
+        targets.each do |target|
+          annotated_code = Processor.new(target:, env:).process
+          case @options.mode
+          when 'write'
+            File.write(target, annotated_code)
+          when 'print-only'
+            puts annotated_code
+          when 'quiet'
+            # do nothing
+          else
+            raise "invalid mode: #{@options.mode}"
+          end
+          print "\r#{spinner.tick}" if @options.mode == 'write'
+        end
+      ensure
+        print "\e[?25h" if @options.mode == 'write'
+      end
+
+      puts "\rDone!" if @options.mode == 'write'
+
+      0 # exit code
+    end
+  end
+end

data/lib/rbs/inline/annotator/processor.rb

@@ -0,0 +1,31 @@
+module RBS::Inline::Annotator
+  class Processor
+    class Result
+      attr_reader :writer, :prism_result, :actions, :diagnostics
+
+      def initialize(writer:, prism_result:)
+        @writer = writer
+        @prism_result = prism_result
+        @diagnostics = []
+      end
+    end
+
+    attr_reader :target, :env
+
+    def initialize(target:, env:)
+      @target = target
+      @env = env
+    end
+
+    def process
+      absolute_path = Pathname.pwd + target
+      source = absolute_path.read
+      writer = Writer.new(source)
+      result = Result.new(writer:, prism_result: Prism.parse_file(absolute_path.to_s))
+      result.prism_result.value.accept(Visitor.new(env:, result:))
+      return if result.writer.actions.empty?
+
+      writer.process
+    end
+  end
+end

data/lib/rbs/inline/annotator/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RBS
+  module Inline
+    module Annotator
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/rbs/inline/annotator/visitor.rb

@@ -0,0 +1,439 @@
+module RBS::Inline::Annotator
+  class Visitor < Prism::Visitor
+    def initialize(env:, result:)
+      @env = env
+      @result = result
+      @stack = []
+      @kind = :instance
+      super()
+    end
+
+    def insert_before(range, text)
+      @result.writer.insert_before(range:, text:)
+    end
+
+    def insert_after(range, text)
+      @result.writer.insert_after(range:, text:)
+    end
+
+    def replace(range, text)
+      @result.writer.replace(range:, text:)
+    end
+
+    def remove(range)
+      replace(range, "")
+    end
+
+    def node_range(node)
+      Range.new(
+        node.location.start_offset,
+        node.location.end_offset,
+      )
+    end
+
+    def visit_singleton_class_node(node)
+      if @kind == :singleton
+        warn "nested singleton class detected"
+        return
+      end
+
+      @kind = :singleton
+      visit_child_nodes(node)
+    ensure
+      @kind = :instance
+    end
+
+    def module_class_entry
+      @env.module_class_entry(type_name)
+    end
+
+    def visit_class_node(node)
+      push_type_name(node) do
+        with_superclass(node.superclass)
+        # TODO: Which file should we write to?
+        # with_embedding_rbs(header_node(node), node)
+        # with_variables(header_node(node), node)
+        visit_child_nodes(node)
+      end
+    end
+
+    def visit_module_node(node)
+      push_type_name(node) do
+        with_module_self(node)
+        # TODO: Which file should we write to?
+        # with_embedding_rbs(header_node(node), node)
+        # with_variables(header_node(node), node)
+        visit_child_nodes(node)
+      end
+    end
+
+    def header_node(node)
+      case node
+      when Prism::ClassNode
+        node.superclass ? node.superclass : node.constant_path
+      when Prism::ModuleNode
+        node.constant_path
+      end
+    end
+
+    def with_embedding_rbs(header_node, node)
+      entry = module_class_entry or return
+      indent = " " * (node.body ? node.body.location.start_column : node.location.start_column + 2)
+      embedding_rbs = []
+      entry.each_decl do |decl|
+        decl.members.each do |member|
+          case member
+          when RBS::AST::Declarations::Interface, RBS::AST::Declarations::TypeAlias
+            embedding_rbs << member
+          end
+        end
+      end
+
+      if embedding_rbs.any?
+        header_range = node_range(header_node)
+        insert_after(header_range, "\n#{indent}# @rbs!\n")
+        embedding_rbs.each do |member|
+          case member
+          when RBS::AST::Declarations::Interface
+            insert_after(header_range, "#{indent}#   interface #{member.name}\n")
+            member.members.each do |m|
+              insert_after(header_range, "#{indent}#     #{m.location.source.strip}\n")
+            end
+            insert_after(header_range, "#{indent}#   end\n")
+          when RBS::AST::Declarations::TypeAlias
+            insert_after(header_range, "#{indent}#   type #{member.name} = #{member.type}\n")
+          end
+        end
+      end
+    end
+
+    def with_superclass(node)
+      node or return
+      entry = module_class_entry or return
+      super_class_decl = entry.primary_decl.super_class or return
+      return unless super_class_decl.args.any?
+
+      args = super_class_decl.args.join(", ")
+      insert_after(node_range(node), " #[#{args}]")
+    end
+
+    def with_variables(header_node, node)
+      indent = " " * (node.body ? node.body.location.start_column : node.location.start_column + 2)
+      entry = module_class_entry or return
+      added = false
+      entry.each_decl do |decl|
+        decl.members.each do |member|
+          case member
+          when RBS::AST::Members::InstanceVariable
+            insert_after(node_range(header_node), "\n#{indent}# @rbs #{member.name}: #{member.type}")
+            added = true
+          when RBS::AST::Members::ClassVariable
+            insert_after(node_range(header_node), "\n#{indent}# @rbs #{member.name}: #{member.type}")
+            added = true
+          when RBS::AST::Members::ClassInstanceVariable
+            insert_after(node_range(header_node), "\n#{indent}# @rbs #{member.name}: #{member.type}")
+            added = true
+          end
+        end
+      end
+      if added && node.body&.body&.first
+        insert_before(node_range(node.body.body.first), "\n#{indent}")
+      end
+    end
+
+    def with_module_self(node)
+      entry = module_class_entry or return
+      self_types = entry.primary_decl.self_types
+      if self_types.any?
+        indent = " " * node.location.start_column
+        insert_before(node_range(node), "# @rbs module-self #{self_types.join(", ")}\n#{indent}")
+      end
+    end
+
+    def visit_def_node(node)
+      module_class_entry&.each_decl do |decl|
+        decl.members.each do |member|
+          case member
+          when RBS::AST::Members::MethodDefinition
+            next unless node.name == member.name
+
+            if node.receiver.nil? && @kind == :instance
+              # def foo
+              next unless member.instance?
+            elsif node.receiver.is_a?(Prism::SelfNode) || @kind == :singleton
+              # def self.foo
+              next unless member.singleton?
+            else
+              next
+            end
+
+            add_rbs_inline_annotation_for_def_node(node:, method_definition: member)
+          end
+        end
+      end
+    end
+
+    def add_rbs_inline_annotation_for_def_node(node:, method_definition:)
+      indent = " " * node.location.start_column
+
+      if method_definition.annotations.any?
+        method_definition.annotations.each do |a|
+          insert_before(node_range(node), "# @rbs %a{#{a.string}}\n#{indent}")
+        end
+      end
+
+      if method_definition.overloading
+        insert_before(node_range(node), "# @rbs overload\n#{indent}")
+        return
+      end
+
+      if method_definition.overloads.length > 1
+        # multiple overloads
+        method_definition.overloads.each_with_index do |overload, index|
+          text = if index == 0
+                   "# @rbs #{overload.method_type}\n#{indent}"
+                 else
+                   "#    | #{overload.method_type}\n#{indent}"
+                 end
+
+          insert_before(node_range(node), text)
+        end
+      else
+        overload = method_definition.overloads.first
+        method_type = overload.method_type
+        func = method_type.type
+        indent = " " * node.location.start_column
+        new_annotation = lambda { |name, type|
+          insert_before(node_range(node), "# @rbs #{name}: #{type}\n#{indent}")
+        }
+        for_positional_params = lambda { |orig_sig, orig_ruby|
+          sig = orig_sig.dup or break
+          ruby = orig_ruby.dup or break
+          sig.each do |rbs|
+            rb = ruby.shift
+            if rbs.name
+              name = rbs.name
+            else
+              if rb.nil?
+                s = (node.receiver.is_a?(Prism::SelfNode) || @kind == :singleton) ? "." : "#"
+                warn "Parameter mismatch #{type_name}#{s}#{node.name}"
+                break
+              end
+              name = rb.name
+            end
+
+            type = rbs.type.to_s
+            next if type == "untyped"
+
+            new_annotation.call(name, type)
+          end
+        }
+        for_keyword_params = lambda { |orig_sig, _orig_ruby|
+          sig = orig_sig.dup or break
+          # ruby = orig_ruby.dup or break
+          sig.each do |name, param|
+            type = param.type.to_s
+            next if type == "untyped"
+
+            new_annotation.call(name, type)
+          end
+        }
+        for_rest_param = lambda { |prefix, sig, ruby|
+          name = sig.name || ruby.name
+          type = sig.type.to_s
+          next if type == "untyped"
+
+          new_annotation.call("#{prefix}#{name}", type)
+        }
+        for_return_param = lambda { |return_type|
+          return_type = return_type.to_s
+          break if return_type == "untyped"
+
+          new_annotation.call("return", return_type)
+        }
+        if node.parameters
+          for_positional_params.call(func.required_positionals, node.parameters.requireds)
+          for_positional_params.call(func.optional_positionals, node.parameters.optionals)
+          for_rest_param.call("*", func.rest_positionals, node.parameters.rest) if func.rest_positionals
+          for_positional_params.call(func.trailing_positionals, node.parameters.posts) if func.trailing_positionals
+          for_keyword_params.call(func.required_keywords, node.parameters.keywords.grep(Prism::RequiredKeywordParameterNode))
+          for_keyword_params.call(func.optional_keywords, node.parameters.keywords.grep(Prism::OptionalKeywordParameterNode))
+          for_rest_param.call("**", func.rest_keywords, node.parameters.keyword_rest) if func.rest_keywords
+        end
+        if method_type.block
+          name = node.parameters&.block&.name
+          block_source = method_type.block.location.source
+          # "?{ (Integer) -> Integer } -> void"
+          # -> "? (Integer) -> Integer"
+          block_source = block_source.gsub(/[{}]/, "").strip
+          new_annotation.call("&#{name}", block_source)
+        end
+        for_return_param.call(func.return_type)
+      end
+    end
+
+    def visit_call_node(node)
+      return if @stack.empty?
+
+      case node.name
+      when :attr_reader, :attr_writer, :attr_accessor
+        when_attribute_node(node)
+      when :include, :extend, :prepend
+        when_mixin_node(node)
+      end
+    end
+
+    def when_attribute_node(node)
+      case node.receiver
+      when nil, Prism::SelfNode
+        if node.arguments.arguments.length == 1
+          first_arg_node = node.arguments.arguments.first
+          return unless first_arg_node.is_a?(Prism::SymbolNode)
+
+          value = first_arg_node.value
+          module_class_entry&.each_decl do |decl|
+            decl.members.each do |member|
+              next unless (node.name == :attr_reader && member.is_a?(RBS::AST::Members::AttrReader)) ||
+                          (node.name == :attr_writer && member.is_a?(RBS::AST::Members::AttrWriter)) ||
+                          (node.name == :attr_accessor && member.is_a?(RBS::AST::Members::AttrAccessor))
+              next unless member.name == value.to_sym
+
+              type = member.type.to_s
+              next if type == "untyped"
+
+              insert_after(node_range(node), " #: #{type}")
+            end
+          end
+        else
+          replaced_count = 0
+          node.arguments.arguments.each do |arg|
+            next unless arg.is_a?(Prism::SymbolNode)
+
+            value = arg.value
+            module_class_entry&.each_decl do |decl|
+              decl.members.each do |member|
+                next unless (node.name == :attr_reader && member.is_a?(RBS::AST::Members::AttrReader)) ||
+                            (node.name == :attr_writer && member.is_a?(RBS::AST::Members::AttrWriter)) ||
+                            (node.name == :attr_accessor && member.is_a?(RBS::AST::Members::AttrAccessor))
+                next unless member.name == value.to_sym
+
+                indent = replaced_count == 0 ? "" : " " * node.location.start_column
+                insert_before(node_range(node), "#{indent}#{node.name} :#{value} #: #{member.type}\n")
+                replaced_count += 1
+              end
+            end
+          end
+
+          if replaced_count == node.arguments.arguments.length
+            range = node_range(node)
+            # Remove attr_*
+            remove(range)
+            # Remove the last newline
+            remove(Range.new(range.end, range.end + 1))
+          end
+        end
+      end
+    end
+
+    def when_mixin_node(node)
+      case node.receiver
+      when nil, Prism::SelfNode
+        if node.arguments.arguments.length == 1
+          first_arg_node = node.arguments.arguments.first
+          return unless first_arg_node.is_a?(Prism::ConstantReadNode)
+
+          name = first_arg_node.name
+          module_class_entry&.each_decl do |decl|
+            decl.members.each do |member|
+              next unless (node.name == :include && member.is_a?(RBS::AST::Members::Include)) ||
+                          (node.name == :extend && member.is_a?(RBS::AST::Members::Extend)) ||
+                          (node.name == :prepend && member.is_a?(RBS::AST::Members::Prepend))
+              next unless member.name.to_s == name.to_s
+              next unless member.args.any?
+
+              type = member.args.join(", ")
+              insert_after(node_range(node), " #[#{type}]")
+            end
+          end
+        else
+          replaced_count = 0
+          node.arguments.arguments.each do |arg|
+            next unless arg.is_a?(Prism::ConstantReadNode)
+
+            name = arg.name
+            module_class_entry&.each_decl do |decl|
+              decl.members.each do |member|
+                next unless (node.name == :include && member.is_a?(RBS::AST::Members::Include)) ||
+                            (node.name == :extend && member.is_a?(RBS::AST::Members::Extend)) ||
+                            (node.name == :prepend && member.is_a?(RBS::AST::Members::Prepend))
+                next unless member.name.to_s == name.to_s
+                next unless member.args.any?
+
+                indent = replaced_count == 0 ? "" : " " * node.location.start_column
+                insert_before(node_range(node), "#{indent}#{node.name} #{name} #[#{member.args.join(", ")}]\n")
+                replaced_count += 1
+              end
+            end
+          end
+
+          if replaced_count > 0 && replaced_count == node.arguments.arguments.length
+            range = node_range(node)
+            # Remove include *
+            remove(range)
+            # Remove the last newline
+            remove(Range.new(range.end, range.end + 1))
+          end
+        end
+      end
+    end
+
+    def visit_constant_write_node(node)
+      constant_type_name = RBS::TypeName.new(
+        name: node.name,
+        namespace: type_name.to_namespace
+      )
+      entry = @env.constant_decls[constant_type_name] or return
+      type = entry.decl.type.to_s
+      return if type == "untyped"
+
+      add_rbs_inline_annotation_for_trailing(node:, type:)
+    end
+
+    def add_rbs_inline_annotation_for_trailing(node:, type:)
+      return if type == "untyped"
+
+      insert_after(node_range(node), " #: #{type}")
+    end
+
+    def push_type_name(node)
+      parts = node.constant_path.full_name_parts.dup
+      @stack.push(parts)
+
+      yield
+    ensure
+      @stack.pop
+    end
+
+    def type_name
+      if @stack.empty?
+        nil
+      else
+        absolute = false
+        names = []
+        @stack.reverse_each do |parts|
+          names.unshift(*parts)
+          if names.first == :""
+            absolute = true
+            names.shift
+            break
+          end
+        end
+        *path, name = names.map(&:to_sym)
+        RBS::TypeName.new(
+          name: name,
+          namespace: RBS::Namespace.new(path:, absolute:)
+        ).absolute!
+      end
+    end
+  end
+end

data/lib/rbs/inline/annotator/writer.rb

@@ -0,0 +1,97 @@
+module RBS::Inline::Annotator
+  # action:
+  #   insert_before(range, "# @rbs foo: Integer")
+  #   insert_before(range, "# @rbs bar: Integer")
+  # expect:
+  #   # @rbs foo: Integer
+  #   # @rbs bar: Integer
+  #   def foo(foo, bar)
+  class Writer
+    class Action
+      attr_reader :range, :text
+
+      def initialize(range:, text:)
+        @range = range
+        @text = text
+      end
+    end
+
+    class InsertBefore < Action
+      def process(writer)
+        if writer.before_pos < range.begin
+          writer.slice << writer.source[writer.before_pos...range.begin]
+          writer.before_pos = range.begin
+        elsif writer.before_pos == range.begin
+          # do nothing
+        else
+          raise "invalid range: #{range}, before_pos: #{writer.before_pos}"
+        end
+        writer.slice << text
+      end
+    end
+
+    class InsertAfter < Action
+      def process(writer)
+        if writer.before_pos < range.end
+          writer.slice << writer.source[writer.before_pos...range.end]
+          writer.before_pos = range.end
+        elsif writer.before_pos == range.end - 1
+          # do nothing
+        else
+          raise "invalid range: #{range}, before_pos: #{writer.before_pos}"
+        end
+        writer.slice << text
+      end
+    end
+
+    class Replace < Action
+      def process(writer)
+        if writer.before_pos < range.begin
+          writer.slice << writer.source[writer.before_pos...range.begin]
+          writer.before_pos = range.end
+        elsif writer.before_pos == range.begin
+          writer.before_pos = range.end
+        else
+          raise "invalid range: #{range}, before_pos: #{writer.before_pos}"
+        end
+        writer.slice << text
+      end
+    end
+
+    attr_reader :source, :actions, :slice
+    attr_accessor :before_pos
+
+    def initialize(source)
+      @source = source
+      @actions = []
+      @slice = []
+      @before_pos = 0
+    end
+
+    def insert_before(range:, text:)
+      actions << InsertBefore.new(range:, text:)
+    end
+
+    def insert_after(range:, text:)
+      actions << InsertAfter.new(range:, text:)
+    end
+
+    def replace(range:, text:)
+      actions << Replace.new(range:, text:)
+    end
+
+    def process
+      actions.sort_by { |action|
+        action.range.begin
+      }.each do |action|
+        action.process(self)
+      end
+
+      if before_pos < source.length
+        slice << source[before_pos..]
+      end
+
+      slice.join
+    end
+  end
+end

data/lib/rbs/inline/annotator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "prism"
+require "rbs"
+require "parser"
+
+require_relative "annotator/version"
+require_relative "annotator/cli"
+require_relative "annotator/processor"
+require_relative "annotator/visitor"
+require_relative "annotator/writer"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rbs-inline-annotator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ksss
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.dev.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.dev.4
+description: RBS inline annotator from RBS
+email:
+- co000ri@gmail.com
+executables:
+- rbs-inline-annotator
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- exe/rbs-inline-annotator
+- lib/rbs/inline/annotator.rb
+- lib/rbs/inline/annotator/cli.rb
+- lib/rbs/inline/annotator/processor.rb
+- lib/rbs/inline/annotator/version.rb
+- lib/rbs/inline/annotator/visitor.rb
+- lib/rbs/inline/annotator/writer.rb
+homepage: https://github.com/ksss/rbs-inline-annotator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ksss/rbs-inline-annotator
+  source_code_uri: https://github.com/ksss/rbs-inline-annotator
+  changelog_uri: https://github.com/ksss/rbs-inline-annotator
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: RBS inline annotator from RBS
+test_files: []