yard_to_rbs_inline 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecc73716bfcc2a940e6d360e85a334ce640d97cfcf47c8d9f9ef64f182e8a8a3
-  data.tar.gz: 992af7e460bd7456a16e718d79d7a993b6396a1b09a81a0aa64d20992e9959cf
+  metadata.gz: 8eda8d5f227b1e1ecacaeba2d22f44e181eb3aa13f7dcd7c51ddec960a62db61
+  data.tar.gz: ffffb3b3acb9dd46a24dbab9dae4318052db497ce4d8bf6fab097e248d42319f
 SHA512:
-  metadata.gz: 02a11e36ce83ada391d9fcc937d2eb54e3c1cb292d2107a9c350f801b23892e65da5f1c027a9207cd480b36ad4e2770967b02f736d722b573e62cb4f7422acb9
-  data.tar.gz: 73a525cd918cf110c1e23a9b7b11cc8d1b58cb33849e6d80473727fd9d42600332a843a01cd1c06415a14876170d79d912c5fb9f266afdf62dd9d82bd10e183b
+  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/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

@@ -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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YardToRbsInline
-  VERSION = "0.1.1"
+  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.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomoya Chiba
@@ -43,6 +43,7 @@ email:
 - tomo.asleep@gmail.com
 executables:
 - yard-to-rbs-inline
+- yard_to_rbs_inline
 extensions: []
 extra_rdoc_files: []
 files:
@@ -53,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