docscribe 1.4.2 → 1.5.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.
Files changed (60) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +465 -130
  3. data/lib/docscribe/cli/check_for_comments.rb +183 -0
  4. data/lib/docscribe/cli/config_builder.rb +107 -53
  5. data/lib/docscribe/cli/formatters/json.rb +294 -0
  6. data/lib/docscribe/cli/formatters/sarif.rb +235 -0
  7. data/lib/docscribe/cli/formatters/text.rb +208 -0
  8. data/lib/docscribe/cli/formatters.rb +26 -0
  9. data/lib/docscribe/cli/generate.rb +45 -45
  10. data/lib/docscribe/cli/init.rb +14 -6
  11. data/lib/docscribe/cli/options.rb +190 -88
  12. data/lib/docscribe/cli/rbs_gen.rb +529 -0
  13. data/lib/docscribe/cli/run.rb +210 -152
  14. data/lib/docscribe/cli/sigs.rb +366 -0
  15. data/lib/docscribe/cli/update_types.rb +103 -0
  16. data/lib/docscribe/cli.rb +21 -13
  17. data/lib/docscribe/config/defaults.rb +5 -1
  18. data/lib/docscribe/config/emit.rb +17 -0
  19. data/lib/docscribe/config/filtering.rb +18 -25
  20. data/lib/docscribe/config/loader.rb +15 -11
  21. data/lib/docscribe/config/plugin.rb +1 -1
  22. data/lib/docscribe/config/rbs.rb +41 -9
  23. data/lib/docscribe/config/sorbet.rb +9 -12
  24. data/lib/docscribe/config/sorting.rb +1 -1
  25. data/lib/docscribe/config/template.rb +9 -1
  26. data/lib/docscribe/config/utils.rb +11 -9
  27. data/lib/docscribe/config.rb +2 -4
  28. data/lib/docscribe/infer/ast_walk.rb +1 -1
  29. data/lib/docscribe/infer/literals.rb +6 -11
  30. data/lib/docscribe/infer/names.rb +2 -3
  31. data/lib/docscribe/infer/params.rb +15 -17
  32. data/lib/docscribe/infer/raises.rb +3 -5
  33. data/lib/docscribe/infer/returns.rb +542 -140
  34. data/lib/docscribe/infer.rb +22 -23
  35. data/lib/docscribe/inline_rewriter/collector.rb +159 -164
  36. data/lib/docscribe/inline_rewriter/doc_block.rb +145 -115
  37. data/lib/docscribe/inline_rewriter/doc_builder.rb +1026 -723
  38. data/lib/docscribe/inline_rewriter/source_helpers.rb +49 -49
  39. data/lib/docscribe/inline_rewriter/tag_sorter.rb +82 -85
  40. data/lib/docscribe/inline_rewriter.rb +495 -492
  41. data/lib/docscribe/parsing.rb +29 -10
  42. data/lib/docscribe/plugin/base/collector_plugin.rb +2 -1
  43. data/lib/docscribe/plugin/base/tag_plugin.rb +0 -1
  44. data/lib/docscribe/plugin/context.rb +28 -18
  45. data/lib/docscribe/plugin/registry.rb +26 -27
  46. data/lib/docscribe/plugin/tag.rb +9 -14
  47. data/lib/docscribe/plugin.rb +17 -16
  48. data/lib/docscribe/types/provider_chain.rb +4 -2
  49. data/lib/docscribe/types/rbs/collection_loader.rb +2 -2
  50. data/lib/docscribe/types/rbs/provider.rb +60 -44
  51. data/lib/docscribe/types/rbs/type_formatter.rb +224 -83
  52. data/lib/docscribe/types/signature.rb +22 -42
  53. data/lib/docscribe/types/sorbet/base_provider.rb +24 -19
  54. data/lib/docscribe/types/sorbet/rbi_provider.rb +3 -3
  55. data/lib/docscribe/types/sorbet/source_provider.rb +3 -2
  56. data/lib/docscribe/types/yard/formatter.rb +100 -0
  57. data/lib/docscribe/types/yard/parser.rb +240 -0
  58. data/lib/docscribe/types/yard/types.rb +52 -0
  59. data/lib/docscribe/version.rb +1 -1
  60. metadata +33 -1
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: docscribe
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.2
4
+ version: 1.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - unurgunite
@@ -37,6 +37,20 @@ dependencies:
37
37
  - - "~>"
38
38
  - !ruby/object:Gem::Version
39
39
  version: '1.8'
40
+ - !ruby/object:Gem::Dependency
41
+ name: irb-autosuggestions
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: '0'
47
+ type: :development
48
+ prerelease: false
49
+ version_requirements: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
40
54
  - !ruby/object:Gem::Dependency
41
55
  name: rake
42
56
  requirement: !ruby/object:Gem::Requirement
@@ -145,11 +159,19 @@ files:
145
159
  - exe/docscribe
146
160
  - lib/docscribe.rb
147
161
  - lib/docscribe/cli.rb
162
+ - lib/docscribe/cli/check_for_comments.rb
148
163
  - lib/docscribe/cli/config_builder.rb
164
+ - lib/docscribe/cli/formatters.rb
165
+ - lib/docscribe/cli/formatters/json.rb
166
+ - lib/docscribe/cli/formatters/sarif.rb
167
+ - lib/docscribe/cli/formatters/text.rb
149
168
  - lib/docscribe/cli/generate.rb
150
169
  - lib/docscribe/cli/init.rb
151
170
  - lib/docscribe/cli/options.rb
171
+ - lib/docscribe/cli/rbs_gen.rb
152
172
  - lib/docscribe/cli/run.rb
173
+ - lib/docscribe/cli/sigs.rb
174
+ - lib/docscribe/cli/update_types.rb
153
175
  - lib/docscribe/config.rb
154
176
  - lib/docscribe/config/defaults.rb
155
177
  - lib/docscribe/config/emit.rb
@@ -190,6 +212,9 @@ files:
190
212
  - lib/docscribe/types/sorbet/base_provider.rb
191
213
  - lib/docscribe/types/sorbet/rbi_provider.rb
192
214
  - lib/docscribe/types/sorbet/source_provider.rb
215
+ - lib/docscribe/types/yard/formatter.rb
216
+ - lib/docscribe/types/yard/parser.rb
217
+ - lib/docscribe/types/yard/types.rb
193
218
  - lib/docscribe/version.rb
194
219
  homepage: https://github.com/unurgunite/docscribe
195
220
  licenses:
@@ -199,6 +224,13 @@ metadata:
199
224
  source_code_uri: https://github.com/unurgunite/docscribe
200
225
  changelog_uri: https://github.com/unurgunite/docscribe/blob/master/CHANGELOG.md
201
226
  rubygems_mfa_required: 'true'
227
+ post_install_message: |
228
+ You installed docscribe 1.5.0. Your future self (and your team) thank you.
229
+
230
+ $ docscribe --help
231
+
232
+ Happy documenting!
233
+ https://github.com/unurgunite/docscribe
202
234
  rdoc_options: []
203
235
  require_paths:
204
236
  - lib