yard_to_rbs_inline 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75ff275975592a47d67427039bdbb4eb3a617b4dd5b0b08f64529a51a71aac9a
-  data.tar.gz: c15d5a93607172ed4a3753b3bcef47ffa9429c657a470423bdbc9d135398b6ab
+  metadata.gz: 8eda8d5f227b1e1ecacaeba2d22f44e181eb3aa13f7dcd7c51ddec960a62db61
+  data.tar.gz: ffffb3b3acb9dd46a24dbab9dae4318052db497ce4d8bf6fab097e248d42319f
 SHA512:
-  metadata.gz: 1809ffd8bfa11fef92442a8450be27c12c11fbe178d62c896308f3bb5bf7024626cbd95e73a760053462625b025117e14a03547d97d5491328a6ece252fdc8b5
-  data.tar.gz: 9974e192dd12b4d49f25ebf3284b32f19aa9b86be7c34a9afeb1d30a3c5a4be7e694922a256021daa6ec07f37329f8dd998c18e04fd23ed8241151c18ea2689f
+  metadata.gz: 8a18d283ec8a67a3690bb87fc4db11c219e4769a8dbf4172e5baf341b6fd5be8e7283947772d1bc5aacba6ed2c8f91f2b76983369adb0f8068fca93d0279be5a
+  data.tar.gz: b6b4f3a71e6b1ee5a04d8a6314d7cd53b5b1ba62a070fe05d293c9883357be7382ddde9c54483c1588eb678ab0263e9da208c6435705504f05d12ac3c0fb30be

data/README.md

@@ -1,15 +1,21 @@
 # yard → rbs-inline
 
-Rewrite YARD type annotations in Your codes to rbs-inline.
+Rewrite [YARD type annotations](https://yardoc.org/types.html) in your codes to [rbs-inline](https://github.com/soutaro/rbs-inline).
 
 ## Usage
 
+Install this gem with the following command.
+
 ```console
-bundle
+gem install yard_to_rbs_inline
+```
 
+Then, run the following command to insert rbs-inline comments to your codes.
+
+```console
 # Print rewrited code to stdout.
-./exe/yard-rbs-inline --dry-run your-file.rb
+yard_to_rbs_inline --dry-run your-file.rb
 
 # Overwrite files.
-./exe/yard-rbs-inline your-file.rb
+yard_to_rbs_inline your-file.rb
 ```

data/Rakefile

@@ -6,6 +6,7 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"
+require "bump/tasks"
 
 RuboCop::RakeTask.new
 

data/examples/example-converted.rb

@@ -0,0 +1,28 @@
+# rbs_inline: enabled
+
+class Code
+  # @return [String]
+  attr_reader :source #:: String
+
+  # @param source [String]
+  #:: (String source) -> untyped
+  def initialize(source)
+    @source = source
+  end
+
+  # @param new_source [String]
+  # @return [Code]
+  #:: (String new_source) -> Code
+  def rewrite(new_source)
+    @source = new_source
+
+    self
+  end
+
+  # @param recover [Boolean].
+  # @return [Array<Token>]
+  #:: (?recover: bool) -> Array[Token]
+  def tokenize(recover: false)
+    parser.tokenize(source, recover: recover)
+  end
+end

data/exe/yard-to-rbs-inline

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 
-if Dir.exist?(File.join(__dir__, "..", ".git"))
-  $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
-end
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__)) if Dir.exist?(File.join(__dir__, "..", ".git"))
 
-require 'yard_to_rbs_inline'
-YardToRbsInline::Cli.start(ARGV)
+require "yard_to_rbs_inline"
+exit(YardToRbsInline::Cli.start(ARGV))

data/exe/yard_to_rbs_inline

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__)) if Dir.exist?(File.join(__dir__, "..", ".git"))
+
+require "yard_to_rbs_inline"
+exit(YardToRbsInline::Cli.start(ARGV))

data/lib/yard_to_rbs_inline/cli.rb

@@ -1,6 +1,6 @@
 # rbs_inline: enabled
 
-require 'optparse'
+require "optparse"
 
 module YardToRbsInline
   class Cli
@@ -8,12 +8,24 @@ module YardToRbsInline
       opt = OptionParser.new
       dry_run = false
 
-      opt.on('-n', '--dry-run', 'Dry run') { dry_run = true }
+      opt.banner = <<~STRING
+        Usage: yard-to-rbs-inline [options] <files ...>
+
+      STRING
+
+      opt.on("-n", "--dry-run", "Dry run") { dry_run = true }
       opt.parse!(argv)
 
+      if argv.empty?
+        warn opt.help
+        return 1
+      end
+
       argv.each do |file|
         Converter.convert(file, dry_run: dry_run)
       end
+
+      0
     end
   end
 end

data/lib/yard_to_rbs_inline/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YardToRbsInline
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard_to_rbs_inline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomoya Chiba
@@ -24,11 +24,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Converter of yard to rbs-inline
 email:
 - tomo.asleep@gmail.com
 executables:
 - yard-to-rbs-inline
+- yard_to_rbs_inline
 extensions: []
 extra_rdoc_files: []
 files:
@@ -39,8 +54,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/example-converted.rb
 - examples/example.rb
 - exe/yard-to-rbs-inline
+- exe/yard_to_rbs_inline
 - lib/yard_to_rbs_inline.rb
 - lib/yard_to_rbs_inline/cli.rb
 - lib/yard_to_rbs_inline/converter.rb