yard_to_rbs_inline 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -4
- data/examples/example-converted.rb +28 -0
- data/exe/yard_to_rbs_inline +6 -0
- data/lib/yard_to_rbs_inline/version.rb +1 -1
- metadata +4 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8eda8d5f227b1e1ecacaeba2d22f44e181eb3aa13f7dcd7c51ddec960a62db61
|
|
4
|
+
data.tar.gz: ffffb3b3acb9dd46a24dbab9dae4318052db497ce4d8bf6fab097e248d42319f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8a18d283ec8a67a3690bb87fc4db11c219e4769a8dbf4172e5baf341b6fd5be8e7283947772d1bc5aacba6ed2c8f91f2b76983369adb0f8068fca93d0279be5a
|
|
7
|
+
data.tar.gz: b6b4f3a71e6b1ee5a04d8a6314d7cd53b5b1ba62a070fe05d293c9883357be7382ddde9c54483c1588eb678ab0263e9da208c6435705504f05d12ac3c0fb30be
|
data/README.md
CHANGED
|
@@ -1,15 +1,21 @@
|
|
|
1
1
|
# yard → rbs-inline
|
|
2
2
|
|
|
3
|
-
Rewrite YARD type annotations in
|
|
3
|
+
Rewrite [YARD type annotations](https://yardoc.org/types.html) in your codes to [rbs-inline](https://github.com/soutaro/rbs-inline).
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
7
|
+
Install this gem with the following command.
|
|
8
|
+
|
|
7
9
|
```console
|
|
8
|
-
|
|
10
|
+
gem install yard_to_rbs_inline
|
|
11
|
+
```
|
|
9
12
|
|
|
13
|
+
Then, run the following command to insert rbs-inline comments to your codes.
|
|
14
|
+
|
|
15
|
+
```console
|
|
10
16
|
# Print rewrited code to stdout.
|
|
11
|
-
|
|
17
|
+
yard_to_rbs_inline --dry-run your-file.rb
|
|
12
18
|
|
|
13
19
|
# Overwrite files.
|
|
14
|
-
|
|
20
|
+
yard_to_rbs_inline your-file.rb
|
|
15
21
|
```
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# rbs_inline: enabled
|
|
2
|
+
|
|
3
|
+
class Code
|
|
4
|
+
# @return [String]
|
|
5
|
+
attr_reader :source #:: String
|
|
6
|
+
|
|
7
|
+
# @param source [String]
|
|
8
|
+
#:: (String source) -> untyped
|
|
9
|
+
def initialize(source)
|
|
10
|
+
@source = source
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
# @param new_source [String]
|
|
14
|
+
# @return [Code]
|
|
15
|
+
#:: (String new_source) -> Code
|
|
16
|
+
def rewrite(new_source)
|
|
17
|
+
@source = new_source
|
|
18
|
+
|
|
19
|
+
self
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# @param recover [Boolean].
|
|
23
|
+
# @return [Array<Token>]
|
|
24
|
+
#:: (?recover: bool) -> Array[Token]
|
|
25
|
+
def tokenize(recover: false)
|
|
26
|
+
parser.tokenize(source, recover: recover)
|
|
27
|
+
end
|
|
28
|
+
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yard_to_rbs_inline
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Tomoya Chiba
|
|
@@ -43,6 +43,7 @@ email:
|
|
|
43
43
|
- tomo.asleep@gmail.com
|
|
44
44
|
executables:
|
|
45
45
|
- yard-to-rbs-inline
|
|
46
|
+
- yard_to_rbs_inline
|
|
46
47
|
extensions: []
|
|
47
48
|
extra_rdoc_files: []
|
|
48
49
|
files:
|
|
@@ -53,8 +54,10 @@ files:
|
|
|
53
54
|
- LICENSE
|
|
54
55
|
- README.md
|
|
55
56
|
- Rakefile
|
|
57
|
+
- examples/example-converted.rb
|
|
56
58
|
- examples/example.rb
|
|
57
59
|
- exe/yard-to-rbs-inline
|
|
60
|
+
- exe/yard_to_rbs_inline
|
|
58
61
|
- lib/yard_to_rbs_inline.rb
|
|
59
62
|
- lib/yard_to_rbs_inline/cli.rb
|
|
60
63
|
- lib/yard_to_rbs_inline/converter.rb
|