checkoff 0.223.0 → 0.226.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/checkoff.gemspec +10 -5
- data/lib/checkoff/attachments.rb +1 -1
- data/lib/checkoff/cli.rb +1 -1
- data/lib/checkoff/clients.rb +1 -1
- data/lib/checkoff/custom_fields.rb +1 -1
- data/lib/checkoff/events.rb +1 -1
- data/lib/checkoff/internal/config_loader.rb +2 -3
- data/lib/checkoff/internal/selector_classes/section/function_evaluator.rb +3 -2
- data/lib/checkoff/my_tasks.rb +1 -1
- data/lib/checkoff/portfolios.rb +11 -9
- data/lib/checkoff/projects.rb +1 -1
- data/lib/checkoff/sections.rb +4 -5
- data/lib/checkoff/tags.rb +66 -17
- data/lib/checkoff/tasks.rb +1 -1
- data/lib/checkoff/version.rb +1 -1
- data/lib/checkoff/workspaces.rb +1 -1
- data/rbi/checkoff.rbi +4529 -0
- data/sig/checkoff.rbs +3749 -0
- metadata +5 -211
- data/.circleci/config.yml +0 -291
- data/.envrc +0 -9
- data/.git-hooks/pre_commit/circle_ci.rb +0 -26
- data/.git-hooks/pre_commit/punchlist.rb +0 -52
- data/.git-hooks/pre_commit/solargraph_typecheck.rb +0 -77
- data/.gitattributes +0 -6
- data/.gitignore +0 -65
- data/.markdownlint_style.rb +0 -4
- data/.mdlrc +0 -1
- data/.overcommit.yml +0 -115
- data/.rubocop.yml +0 -143
- data/.rubocop_todo.yml +0 -90
- data/.solargraph.yml +0 -35
- data/.yamllint.yml +0 -8
- data/.yardopts +0 -2
- data/CODE_OF_CONDUCT.md +0 -133
- data/CONTRIBUTING.rst +0 -75
- data/DEVELOPMENT.md +0 -69
- data/GLOSSARY.md +0 -16
- data/Gemfile +0 -67
- data/Gemfile.lock +0 -351
- data/LICENSE +0 -21
- data/Makefile +0 -139
- data/bin/brakeman +0 -27
- data/bin/bump +0 -29
- data/bin/checkoff +0 -29
- data/bin/console +0 -15
- data/bin/overcommit +0 -29
- data/bin/overcommit_branch +0 -114
- data/bin/rake +0 -29
- data/bin/rubocop +0 -27
- data/bin/setup +0 -8
- data/bin/solargraph +0 -27
- data/bin/sord +0 -27
- data/bin/spoom +0 -27
- data/bin/srb +0 -27
- data/bin/srb-rbi +0 -27
- data/bin/tapioca +0 -27
- data/bin/yard +0 -27
- data/config/annotations_asana.rb +0 -253
- data/config/annotations_misc.rb +0 -68
- data/config/env.1p +0 -2
- data/docs/.gitignore +0 -3
- data/docs/cookiecutter_input.json +0 -17
- data/docs/example_project.png +0 -0
- data/fix.sh +0 -534
- data/metrics/bigfiles_high_water_mark +0 -1
- data/metrics/brakeman_high_water_mark +0 -1
- data/metrics/bundle-audit_high_water_mark +0 -1
- data/metrics/cane_high_water_mark +0 -1
- data/metrics/eslint_high_water_mark +0 -1
- data/metrics/flake8_high_water_mark +0 -1
- data/metrics/flay_high_water_mark +0 -1
- data/metrics/flog_high_water_mark +0 -1
- data/metrics/jscs_high_water_mark +0 -1
- data/metrics/mdl_high_water_mark +0 -1
- data/metrics/pep8_high_water_mark +0 -1
- data/metrics/punchlist_high_water_mark +0 -1
- data/metrics/pycodestyle_high_water_mark +0 -1
- data/metrics/rails_best_practices_high_water_mark +0 -1
- data/metrics/rubocop_high_water_mark +0 -1
- data/metrics/scalastyle_high_water_mark +0 -1
- data/metrics/shellcheck_high_water_mark +0 -1
- data/package.json +0 -9
- data/rakelib/citest.rake +0 -4
- data/rakelib/clear_metrics.rake +0 -9
- data/rakelib/console.rake +0 -15
- data/rakelib/default.rake +0 -4
- data/rakelib/doc.rake +0 -6
- data/rakelib/gem_tasks.rake +0 -3
- data/rakelib/localtest.rake +0 -4
- data/rakelib/overcommit.rake +0 -6
- data/rakelib/quality.rake +0 -4
- data/rakelib/repl.rake +0 -4
- data/rakelib/test.rake +0 -10
- data/rakelib/trigger_next_builds.rake +0 -7
- data/rakelib/undercover.rake +0 -8
- data/requirements_dev.txt +0 -2
- data/sorbet/config +0 -4
- data/sorbet/rbi/annotations/.gitattributes +0 -1
- data/sorbet/rbi/annotations/activesupport.rbi +0 -453
- data/sorbet/rbi/annotations/faraday.rbi +0 -17
- data/sorbet/rbi/annotations/minitest.rbi +0 -119
- data/sorbet/rbi/annotations/mocha.rbi +0 -34
- data/sorbet/rbi/annotations/rainbow.rbi +0 -269
- data/sorbet/rbi/annotations/webmock.rbi +0 -9
- data/sorbet/rbi/dsl/.gitattributes +0 -1
- data/sorbet/rbi/dsl/active_support/callbacks.rbi +0 -23
- data/sorbet/rbi/gems/.gitattributes +0 -1
- data/sorbet/rbi/gems/activesupport@7.1.5.rbi +0 -18746
- data/sorbet/rbi/gems/addressable@2.8.6.rbi +0 -1994
- data/sorbet/rbi/gems/ansi@1.5.0.rbi +0 -688
- data/sorbet/rbi/gems/asana@0.10.6-ab9393136d9ca59b75e42a661fdddc1c65c8f7c3.rbi +0 -6142
- data/sorbet/rbi/gems/ast@2.4.2.rbi +0 -585
- data/sorbet/rbi/gems/backport@1.2.0.rbi +0 -523
- data/sorbet/rbi/gems/base64@0.2.0.rbi +0 -509
- data/sorbet/rbi/gems/benchmark@0.4.0.rbi +0 -618
- data/sorbet/rbi/gems/bigdecimal@3.1.5.rbi +0 -78
- data/sorbet/rbi/gems/brakeman@6.2.2.rbi +0 -222
- data/sorbet/rbi/gems/builder@3.2.4.rbi +0 -505
- data/sorbet/rbi/gems/bump@0.10.0.rbi +0 -169
- data/sorbet/rbi/gems/cache@0.4.1.rbi +0 -211
- data/sorbet/rbi/gems/cache_method@0.2.7.rbi +0 -293
- data/sorbet/rbi/gems/chef-utils@18.3.0.rbi +0 -9
- data/sorbet/rbi/gems/childprocess@5.1.0.rbi +0 -383
- data/sorbet/rbi/gems/coderay@1.1.3.rbi +0 -3427
- data/sorbet/rbi/gems/commander@4.6.0.rbi +0 -9
- data/sorbet/rbi/gems/concurrent-ruby@1.2.3.rbi +0 -11591
- data/sorbet/rbi/gems/connection_pool@2.4.1.rbi +0 -9
- data/sorbet/rbi/gems/crack@0.4.5.rbi +0 -145
- data/sorbet/rbi/gems/diff-lcs@1.5.1.rbi +0 -969
- data/sorbet/rbi/gems/docile@1.4.0.rbi +0 -377
- data/sorbet/rbi/gems/drb@2.2.1.rbi +0 -1347
- data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +0 -9
- data/sorbet/rbi/gems/erubi@1.13.0.rbi +0 -152
- data/sorbet/rbi/gems/faraday-em_http@1.0.0.rbi +0 -222
- data/sorbet/rbi/gems/faraday-em_synchrony@1.0.0.rbi +0 -126
- data/sorbet/rbi/gems/faraday-excon@1.1.0.rbi +0 -136
- data/sorbet/rbi/gems/faraday-httpclient@1.0.1.rbi +0 -145
- data/sorbet/rbi/gems/faraday-multipart@1.0.4.rbi +0 -259
- data/sorbet/rbi/gems/faraday-net_http@1.0.1.rbi +0 -142
- data/sorbet/rbi/gems/faraday-net_http_persistent@1.2.0.rbi +0 -118
- data/sorbet/rbi/gems/faraday-patron@1.0.0.rbi +0 -125
- data/sorbet/rbi/gems/faraday-rack@1.0.0.rbi +0 -133
- data/sorbet/rbi/gems/faraday-retry@1.0.3.rbi +0 -198
- data/sorbet/rbi/gems/faraday@1.10.3.rbi +0 -2729
- data/sorbet/rbi/gems/faraday_middleware-multi_json@0.0.6.rbi +0 -29
- data/sorbet/rbi/gems/faraday_middleware@1.2.0.rbi +0 -1004
- data/sorbet/rbi/gems/gli@2.22.0.rbi +0 -9
- data/sorbet/rbi/gems/hashdiff@1.0.1.rbi +0 -351
- data/sorbet/rbi/gems/highline@2.0.3.rbi +0 -9
- data/sorbet/rbi/gems/i18n@1.14.6.rbi +0 -2359
- data/sorbet/rbi/gems/imagen@0.1.8.rbi +0 -340
- data/sorbet/rbi/gems/iniparse@1.5.0.rbi +0 -899
- data/sorbet/rbi/gems/jaro_winkler@1.6.0.rbi +0 -22
- data/sorbet/rbi/gems/json@2.7.1.rbi +0 -1562
- data/sorbet/rbi/gems/jwt@2.7.1.rbi +0 -1405
- data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +0 -128
- data/sorbet/rbi/gems/kramdown@2.4.0.rbi +0 -3272
- data/sorbet/rbi/gems/language_server-protocol@3.17.0.3.rbi +0 -14238
- data/sorbet/rbi/gems/logger@1.6.2.rbi +0 -923
- data/sorbet/rbi/gems/mdl@0.13.0.rbi +0 -445
- data/sorbet/rbi/gems/method_source@1.0.0.rbi +0 -273
- data/sorbet/rbi/gems/mime-types-data@3.2023.1205.rbi +0 -127
- data/sorbet/rbi/gems/mime-types@3.5.1.rbi +0 -1252
- data/sorbet/rbi/gems/minitest-profile@0.0.2.rbi +0 -136
- data/sorbet/rbi/gems/minitest-reporters@1.6.1.rbi +0 -1014
- data/sorbet/rbi/gems/minitest@5.21.1.rbi +0 -1539
- data/sorbet/rbi/gems/mixlib-cli@2.1.8.rbi +0 -314
- data/sorbet/rbi/gems/mixlib-config@3.0.27.rbi +0 -581
- data/sorbet/rbi/gems/mixlib-shellout@3.2.7.rbi +0 -629
- data/sorbet/rbi/gems/mocha@2.1.0.rbi +0 -12
- data/sorbet/rbi/gems/multi_json@1.15.0.rbi +0 -268
- data/sorbet/rbi/gems/multi_xml@0.6.0.rbi +0 -102
- data/sorbet/rbi/gems/multipart-post@2.3.0.rbi +0 -234
- data/sorbet/rbi/gems/mutex_m@0.3.0.rbi +0 -97
- data/sorbet/rbi/gems/netrc@0.11.0.rbi +0 -159
- data/sorbet/rbi/gems/nokogiri@1.17.0.rbi +0 -8201
- data/sorbet/rbi/gems/oauth2@1.4.11.rbi +0 -833
- data/sorbet/rbi/gems/overcommit@0.64.1.rbi +0 -2400
- data/sorbet/rbi/gems/parallel@1.23.0.rbi +0 -274
- data/sorbet/rbi/gems/parlour@5.0.0.rbi +0 -3007
- data/sorbet/rbi/gems/parser@3.2.2.4.rbi +0 -7253
- data/sorbet/rbi/gems/prism@1.2.0.rbi +0 -39085
- data/sorbet/rbi/gems/pry@0.14.2.rbi +0 -10070
- data/sorbet/rbi/gems/public_suffix@5.0.4.rbi +0 -936
- data/sorbet/rbi/gems/punchlist@1.3.2.rbi +0 -173
- data/sorbet/rbi/gems/racc@1.8.1.rbi +0 -162
- data/sorbet/rbi/gems/rack@3.1.8.rbi +0 -4896
- data/sorbet/rbi/gems/rainbow@3.1.1.rbi +0 -403
- data/sorbet/rbi/gems/rake@13.1.0.rbi +0 -3022
- data/sorbet/rbi/gems/rbi@0.2.1.rbi +0 -4535
- data/sorbet/rbi/gems/rbs@2.8.4.rbi +0 -5613
- data/sorbet/rbi/gems/regexp_parser@2.8.3.rbi +0 -3750
- data/sorbet/rbi/gems/reverse_markdown@2.1.1.rbi +0 -390
- data/sorbet/rbi/gems/rexml@3.3.9.rbi +0 -4964
- data/sorbet/rbi/gems/rubocop-ast@1.30.0.rbi +0 -7127
- data/sorbet/rbi/gems/rubocop-minitest@0.34.5.rbi +0 -2577
- data/sorbet/rbi/gems/rubocop-performance@1.20.2.rbi +0 -3262
- data/sorbet/rbi/gems/rubocop-rake@0.6.0.rbi +0 -329
- data/sorbet/rbi/gems/rubocop-rspec@3.0.0.rbi +0 -7546
- data/sorbet/rbi/gems/rubocop@1.59.0.rbi +0 -57238
- data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +0 -1318
- data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +0 -9
- data/sorbet/rbi/gems/rugged@1.6.3.rbi +0 -1577
- data/sorbet/rbi/gems/securerandom@0.4.0.rbi +0 -75
- data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +0 -217
- data/sorbet/rbi/gems/simplecov-lcov@0.8.0.rbi +0 -256
- data/sorbet/rbi/gems/simplecov@0.22.0.rbi +0 -2149
- data/sorbet/rbi/gems/simplecov_json_formatter@0.1.4.rbi +0 -9
- data/sorbet/rbi/gems/solargraph-rails@1.1.0-9dc37915bd4f3b169046e34db6fb32193ab347d8.rbi +0 -320
- data/sorbet/rbi/gems/solargraph@0.50.1-904b9304770a59fac393c5cc3cad481e5bdf0fd8.rbi +0 -9396
- data/sorbet/rbi/gems/sord@5.1.0.rbi +0 -820
- data/sorbet/rbi/gems/source_finder@3.2.1.rbi +0 -317
- data/sorbet/rbi/gems/spoom@1.5.0.rbi +0 -4932
- data/sorbet/rbi/gems/tapioca@0.16.5.rbi +0 -3617
- data/sorbet/rbi/gems/thor@1.3.2.rbi +0 -4378
- data/sorbet/rbi/gems/tilt@2.4.0.rbi +0 -933
- data/sorbet/rbi/gems/tomlrb@2.0.3.rbi +0 -9
- data/sorbet/rbi/gems/tzinfo@2.0.6.rbi +0 -5918
- data/sorbet/rbi/gems/undercover@0.5.0.rbi +0 -433
- data/sorbet/rbi/gems/unicode-display_width@2.5.0.rbi +0 -66
- data/sorbet/rbi/gems/webmock@3.19.1.rbi +0 -1769
- data/sorbet/rbi/gems/yard-sorbet@0.9.0.rbi +0 -435
- data/sorbet/rbi/gems/yard@0.9.37.rbi +0 -18406
- data/sorbet/rbi/todo.rbi +0 -11
- data/sorbet/tapioca/config.yml +0 -13
- data/sorbet/tapioca/require.rb +0 -4
@@ -1,820 +0,0 @@
|
|
1
|
-
# typed: true
|
2
|
-
|
3
|
-
# DO NOT EDIT MANUALLY
|
4
|
-
# This is an autogenerated file for types exported from the `sord` gem.
|
5
|
-
# Please instead update this file by running `bin/tapioca gem sord`.
|
6
|
-
|
7
|
-
|
8
|
-
# Concrete
|
9
|
-
|
10
|
-
# Generic - these will be put in a `Types::Raw`, so writing RBS syntax is a little devious,
|
11
|
-
# but by their nature we know they'll only be used in an RBS file, so it's probably fine
|
12
|
-
|
13
|
-
# source://sord//lib/sord/version.rb#2
|
14
|
-
# typed: strong
|
15
|
-
module Sord; end
|
16
|
-
|
17
|
-
# Converts the current working directory's YARD registry into an type
|
18
|
-
# signature file.
|
19
|
-
#
|
20
|
-
# source://sord//lib/sord/generator.rb#11
|
21
|
-
# Converts the current working directory's YARD registry into an type
|
22
|
-
class Sord::Generator
|
23
|
-
# Create a new generator.
|
24
|
-
#
|
25
|
-
# @option options
|
26
|
-
# @option options
|
27
|
-
# @option options
|
28
|
-
# @option options
|
29
|
-
# @option options
|
30
|
-
# @option options
|
31
|
-
# @option options
|
32
|
-
# @option options
|
33
|
-
# @param options [Hash]
|
34
|
-
# @return [void]
|
35
|
-
#
|
36
|
-
# source://sord//lib/sord/generator.rb#36
|
37
|
-
# _@param_ `options`
|
38
|
-
sig { params(options: T::Hash[T.untyped, T.untyped]).void }
|
39
|
-
def initialize(options); end
|
40
|
-
|
41
|
-
# Given a YARD NamespaceObject, add lines defining either its class
|
42
|
-
# and instance attributes and their signatures to the current file.
|
43
|
-
#
|
44
|
-
# @param item [YARD::CodeObjects::NamespaceObject]
|
45
|
-
# @return [void]
|
46
|
-
#
|
47
|
-
# source://sord//lib/sord/generator.rb#473
|
48
|
-
# sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
|
49
|
-
# Given a YARD NamespaceObject, add lines defining either its class
|
50
|
-
# _@param_ `item`
|
51
|
-
sig { params(item: YARD::CodeObjects::NamespaceObject).void }
|
52
|
-
def add_attributes(item); end
|
53
|
-
|
54
|
-
# Adds comments to an object based on a docstring.
|
55
|
-
#
|
56
|
-
# @param item [YARD::CodeObjects::NamespaceObject]
|
57
|
-
# @param typed_object [Parlour::TypedObject]
|
58
|
-
# @return [void]
|
59
|
-
#
|
60
|
-
# source://sord//lib/sord/generator.rb#170
|
61
|
-
# sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
|
62
|
-
# _@param_ `item`
|
63
|
-
# _@param_ `typed_object`
|
64
|
-
sig { params(item: YARD::CodeObjects::NamespaceObject, typed_object: Parlour::TypedObject).void }
|
65
|
-
def add_comments(item, typed_object); end
|
66
|
-
|
67
|
-
# Given a YARD NamespaceObject, add lines defining constants.
|
68
|
-
#
|
69
|
-
# @param item [YARD::CodeObjects::NamespaceObject]
|
70
|
-
# @return [void]
|
71
|
-
#
|
72
|
-
# source://sord//lib/sord/generator.rb#127
|
73
|
-
# sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
|
74
|
-
# _@param_ `item`
|
75
|
-
sig { params(item: YARD::CodeObjects::NamespaceObject).void }
|
76
|
-
def add_constants(item); end
|
77
|
-
|
78
|
-
# Given a YARD NamespaceObject, add lines defining its methods and their
|
79
|
-
# signatures to the current file.
|
80
|
-
#
|
81
|
-
# @param item [YARD::CodeObjects::NamespaceObject]
|
82
|
-
# @return [void]
|
83
|
-
#
|
84
|
-
# source://sord//lib/sord/generator.rb#281
|
85
|
-
# sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
|
86
|
-
# Given a YARD NamespaceObject, add lines defining its methods and their
|
87
|
-
# _@param_ `item`
|
88
|
-
sig { params(item: YARD::CodeObjects::NamespaceObject).void }
|
89
|
-
def add_methods(item); end
|
90
|
-
|
91
|
-
# Given a YARD CodeObject, add lines defining its mixins (that is, extends
|
92
|
-
# and includes) to the current file. Returns the number of mixins.
|
93
|
-
#
|
94
|
-
# @param item [YARD::CodeObjects::Base]
|
95
|
-
# @return [Integer]
|
96
|
-
#
|
97
|
-
# source://sord//lib/sord/generator.rb#104
|
98
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
99
|
-
# Given a YARD CodeObject, add lines defining its mixins (that is, extends
|
100
|
-
# _@param_ `item`
|
101
|
-
sig { params(item: YARD::CodeObjects::Base).returns(Integer) }
|
102
|
-
def add_mixins(item); end
|
103
|
-
|
104
|
-
# Given a YARD NamespaceObject, add lines defining its mixins, methods
|
105
|
-
# and children to the file.
|
106
|
-
#
|
107
|
-
# @param item [YARD::CodeObjects::NamespaceObject]
|
108
|
-
# @return [void]
|
109
|
-
#
|
110
|
-
# source://sord//lib/sord/generator.rb#581
|
111
|
-
# sord warn - YARD::CodeObjects::NamespaceObject wasn't able to be resolved to a constant in this project
|
112
|
-
# Given a YARD NamespaceObject, add lines defining its mixins, methods
|
113
|
-
# _@param_ `item`
|
114
|
-
sig { params(item: YARD::CodeObjects::NamespaceObject).void }
|
115
|
-
def add_namespace(item); end
|
116
|
-
|
117
|
-
# Increment the method counter.
|
118
|
-
#
|
119
|
-
# @return [void]
|
120
|
-
#
|
121
|
-
# source://sord//lib/sord/generator.rb#96
|
122
|
-
sig { void }
|
123
|
-
def count_method; end
|
124
|
-
|
125
|
-
# Increment the namespace counter.
|
126
|
-
#
|
127
|
-
# @return [void]
|
128
|
-
#
|
129
|
-
# source://sord//lib/sord/generator.rb#90
|
130
|
-
sig { void }
|
131
|
-
def count_namespace; end
|
132
|
-
|
133
|
-
# Removes the last character of a default parameter value if it begins with
|
134
|
-
# '-', working around a bug in YARD. (See lsegal/yard #894)
|
135
|
-
#
|
136
|
-
# @param default [String]
|
137
|
-
# @return [String, nil]
|
138
|
-
#
|
139
|
-
# source://sord//lib/sord/generator.rb#709
|
140
|
-
# Removes the last character of a default parameter value if it begins with
|
141
|
-
# _@param_ `default`
|
142
|
-
sig { params(default: String).returns(T.nilable(String)) }
|
143
|
-
def fix_default_if_unary_minus(default); end
|
144
|
-
|
145
|
-
# Populates the generator with the contents of the YARD registry, then
|
146
|
-
# uses the loaded Parlour::Generator to generate the file. You must
|
147
|
-
# load the YARD registry first!
|
148
|
-
#
|
149
|
-
# @return [void]
|
150
|
-
#
|
151
|
-
# source://sord//lib/sord/generator.rb#619
|
152
|
-
# Populates the generator with the contents of the YARD registry, then
|
153
|
-
# uses the loaded Parlour::Generator to generate the file. You must
|
154
|
-
sig { void }
|
155
|
-
def generate; end
|
156
|
-
|
157
|
-
# @param method [YARD::CodeObjects::MethodObject]
|
158
|
-
# @param tag_name [String]
|
159
|
-
# @return [YARD::Tags::Tag, nil]
|
160
|
-
#
|
161
|
-
# source://sord//lib/sord/generator.rb#270
|
162
|
-
# sord warn - YARD::CodeObjects::MethodObject wasn't able to be resolved to a constant in this project
|
163
|
-
# sord warn - YARD::Tags::Tag wasn't able to be resolved to a constant in this project
|
164
|
-
# _@param_ `method`
|
165
|
-
# _@param_ `tag_name`
|
166
|
-
sig { params(method: YARD::CodeObjects::MethodObject, tag_name: String).returns(T.nilable(YARD::Tags::Tag)) }
|
167
|
-
def method_tag(method, tag_name); end
|
168
|
-
|
169
|
-
# @param method [YARD::CodeObjects::MethodObject]
|
170
|
-
# @param tag_name [String]
|
171
|
-
# @return [Array<YARD::Tags::Tag>]
|
172
|
-
#
|
173
|
-
# source://sord//lib/sord/generator.rb#260
|
174
|
-
# sord warn - YARD::CodeObjects::MethodObject wasn't able to be resolved to a constant in this project
|
175
|
-
# sord warn - YARD::Tags::Tag wasn't able to be resolved to a constant in this project
|
176
|
-
# _@param_ `method`
|
177
|
-
# _@param_ `tag_name`
|
178
|
-
sig { params(method: YARD::CodeObjects::MethodObject, tag_name: String).returns(T::Array[YARD::Tags::Tag]) }
|
179
|
-
def method_tags(method, tag_name); end
|
180
|
-
|
181
|
-
# @return [Integer] The number of objects this generator has processed so
|
182
|
-
# far.
|
183
|
-
#
|
184
|
-
# source://sord//lib/sord/generator.rb#16
|
185
|
-
# _@return_ — The number of objects this generator has processed so
|
186
|
-
# far.
|
187
|
-
sig { returns(Integer) }
|
188
|
-
def object_count; end
|
189
|
-
|
190
|
-
# Populates the generator with the contents of the YARD registry. You
|
191
|
-
# must load the YARD registry first!
|
192
|
-
#
|
193
|
-
# @return [void]
|
194
|
-
#
|
195
|
-
# source://sord//lib/sord/generator.rb#608
|
196
|
-
# Populates the generator with the contents of the YARD registry. You
|
197
|
-
sig { void }
|
198
|
-
def populate; end
|
199
|
-
|
200
|
-
# Loads the YARD registry, populates the file, and prints any relevant
|
201
|
-
# final logs.
|
202
|
-
#
|
203
|
-
# @return [void]
|
204
|
-
#
|
205
|
-
# source://sord//lib/sord/generator.rb#627
|
206
|
-
# Loads the YARD registry, populates the file, and prints any relevant
|
207
|
-
sig { void }
|
208
|
-
def run; end
|
209
|
-
|
210
|
-
# Given two pairs of arrays representing method parameters, in the form
|
211
|
-
# of ["variable_name", "default_value"], sort the parameters so they're
|
212
|
-
# valid for Sorbet. Sorbet requires that, e.g. required kwargs go before
|
213
|
-
# optional kwargs.
|
214
|
-
#
|
215
|
-
# @param pair1 [Array]
|
216
|
-
# @param pair2 [Array]
|
217
|
-
# @return Integer
|
218
|
-
#
|
219
|
-
# source://sord//lib/sord/generator.rb#672
|
220
|
-
# Given two pairs of arrays representing method parameters, in the form
|
221
|
-
# of ["variable_name", "default_value"], sort the parameters so they're
|
222
|
-
# valid for Sorbet. Sorbet requires that, e.g. required kwargs go before
|
223
|
-
# _@param_ `pair1`
|
224
|
-
# _@param_ `pair2`
|
225
|
-
# _@return_ — Integer
|
226
|
-
sig { params(pair1: T::Array[T.untyped], pair2: T::Array[T.untyped]).returns(T.untyped) }
|
227
|
-
def sort_params(pair1, pair2); end
|
228
|
-
|
229
|
-
# @return [Array<Array(String, YARD::CodeObjects::Base, Integer)>] The
|
230
|
-
# errors encountered by by the generator. Each element is of the form
|
231
|
-
# [message, item, line].
|
232
|
-
#
|
233
|
-
# source://sord//lib/sord/generator.rb#23
|
234
|
-
def warnings; end
|
235
|
-
end
|
236
|
-
|
237
|
-
# source://sord//lib/sord/generator.rb#12
|
238
|
-
Sord::Generator::VALID_MODES = T.let(T.unsafe(nil), Array)
|
239
|
-
|
240
|
-
# Handles writing logs to stdout and any other classes which request them.
|
241
|
-
#
|
242
|
-
# source://sord//lib/sord/logging.rb#6
|
243
|
-
module Sord::Logging
|
244
|
-
class << self
|
245
|
-
# Adds a hook to the logger.
|
246
|
-
#
|
247
|
-
# @return [void]
|
248
|
-
# @yieldparam kind [Symbol] The kind of log message this is.
|
249
|
-
# @yieldparam msg [String] The log message to write.
|
250
|
-
# @yieldparam item [YARD::CodeObjects::Base] The CodeObject which this log
|
251
|
-
# is associated with, if any. This is shown before the log message if it is
|
252
|
-
# specified.
|
253
|
-
# @yieldreturn [void]
|
254
|
-
#
|
255
|
-
# source://sord//lib/sord/logging.rb#187
|
256
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
257
|
-
sig { params(blk: T.proc.params(kind: Symbol, msg: String, item: YARD::CodeObjects::Base).void).void }
|
258
|
-
def add_hook(&blk); end
|
259
|
-
|
260
|
-
# Print a done message. This should be used when a process completes
|
261
|
-
# successfully.
|
262
|
-
#
|
263
|
-
# @param msg [String] The log message to write.
|
264
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which this log
|
265
|
-
# is associated with, if any. This is shown before the log message if it is
|
266
|
-
# specified.
|
267
|
-
# @return [void]
|
268
|
-
#
|
269
|
-
# source://sord//lib/sord/logging.rb#162
|
270
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
271
|
-
# sord omit - no YARD type given for "**opts", using untyped
|
272
|
-
# Print a done message. This should be used when a process completes
|
273
|
-
# _@param_ `msg` — The log message to write.
|
274
|
-
# _@param_ `item` — The CodeObject which this log is associated with, if any. This is shown before the log message if it is specified.
|
275
|
-
sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base), opts: T.untyped).void }
|
276
|
-
def done(msg, item = T.unsafe(nil), **opts); end
|
277
|
-
|
278
|
-
# Print a duck-typing message. This should be used when the YARD
|
279
|
-
# documentation contains duck typing, which isn't supported by Sorbet, so
|
280
|
-
# it is substituted for something different.
|
281
|
-
#
|
282
|
-
# @param msg [String] The log message to write.
|
283
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which this log
|
284
|
-
# is associated with, if any. This is shown before the log message if it is
|
285
|
-
# specified.
|
286
|
-
# @return [void]
|
287
|
-
#
|
288
|
-
# source://sord//lib/sord/logging.rb#116
|
289
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
290
|
-
# sord omit - no YARD type given for "**opts", using untyped
|
291
|
-
# Print a duck-typing message. This should be used when the YARD
|
292
|
-
# documentation contains duck typing, which isn't supported by Sorbet, so
|
293
|
-
# _@param_ `msg` — The log message to write.
|
294
|
-
# _@param_ `item` — The CodeObject which this log is associated with, if any. This is shown before the log message if it is specified.
|
295
|
-
sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base), opts: T.untyped).void }
|
296
|
-
def duck(msg, item = T.unsafe(nil), **opts); end
|
297
|
-
|
298
|
-
# Gets the array of log messages types which should be processed. Any not on
|
299
|
-
# this list will be discarded.
|
300
|
-
#
|
301
|
-
# @return [Array<Symbol>]
|
302
|
-
# @return [void]
|
303
|
-
#
|
304
|
-
# source://sord//lib/sord/logging.rb#50
|
305
|
-
# Gets the array of log messages types which should be processed. Any not on
|
306
|
-
sig { returns(T::Array[Symbol]) }
|
307
|
-
def enabled_types; end
|
308
|
-
|
309
|
-
# Sets the array of log messages types which should be processed. Any not on
|
310
|
-
# this list will be discarded. This should be a subset of AVAILABLE_TYPES.
|
311
|
-
#
|
312
|
-
# @param value [Array<Symbol>]
|
313
|
-
# @return [void]
|
314
|
-
#
|
315
|
-
# source://sord//lib/sord/logging.rb#41
|
316
|
-
# Sets the array of log messages types which should be processed. Any not on
|
317
|
-
# _@param_ `value`
|
318
|
-
sig { params(value: T::Array[Symbol]).void }
|
319
|
-
def enabled_types=(value); end
|
320
|
-
|
321
|
-
# Print an error message. This should be used for things which require the
|
322
|
-
# current process to stop.
|
323
|
-
#
|
324
|
-
# @param msg [String] The log message to write.
|
325
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which this log
|
326
|
-
# is associated with, if any. This is shown before the log message if it is
|
327
|
-
# specified.
|
328
|
-
# @return [void]
|
329
|
-
#
|
330
|
-
# source://sord//lib/sord/logging.rb#127
|
331
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
332
|
-
# sord omit - no YARD type given for "**opts", using untyped
|
333
|
-
# Print an error message. This should be used for things which require the
|
334
|
-
# _@param_ `msg` — The log message to write.
|
335
|
-
# _@param_ `item` — The CodeObject which this log is associated with, if any. This is shown before the log message if it is specified.
|
336
|
-
sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base), opts: T.untyped).void }
|
337
|
-
def error(msg, item = T.unsafe(nil), **opts); end
|
338
|
-
|
339
|
-
# A generic log message writer which is called by all other specific logging
|
340
|
-
# methods. This shouldn't be called outside of the Logging class itself.
|
341
|
-
#
|
342
|
-
# @param kind [Symbol] The kind of log message this is.
|
343
|
-
# @param header [String] The prefix for this log message. For consistency,
|
344
|
-
# it should be up to five uppercase characters wrapped in square brackets,
|
345
|
-
# with some unique colour applied.
|
346
|
-
# @param msg [String] The log message to write.
|
347
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which this log
|
348
|
-
# is associated with, if any. This is shown before the log message if it is
|
349
|
-
# specified.
|
350
|
-
# @return [void]
|
351
|
-
#
|
352
|
-
# source://sord//lib/sord/logging.rb#73
|
353
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
354
|
-
# sord omit - no YARD type given for "**opts", using untyped
|
355
|
-
# A generic log message writer which is called by all other specific logging
|
356
|
-
# _@param_ `kind` — The kind of log message this is.
|
357
|
-
# _@param_ `header` — The prefix for this log message. For consistency, it should be up to five uppercase characters wrapped in square brackets, with some unique colour applied.
|
358
|
-
# _@param_ `msg` — The log message to write.
|
359
|
-
# _@param_ `item` — The CodeObject which this log is associated with, if any. This is shown before the log message if it is specified.
|
360
|
-
sig { params(kind: Symbol, header: String, msg: String, item: YARD::CodeObjects::Base, opts: T.untyped).void }
|
361
|
-
def generic(kind, header, msg, item, **opts); end
|
362
|
-
|
363
|
-
# @return [Array<Proc>] The hooks registered on the logger.
|
364
|
-
#
|
365
|
-
# source://sord//lib/sord/logging.rb#12
|
366
|
-
# _@return_ — The hooks registered on the logger.
|
367
|
-
sig { returns(T::Array[Proc]) }
|
368
|
-
def hooks; end
|
369
|
-
|
370
|
-
# Print an infer message. This should be used when the user should be told
|
371
|
-
# that some information has been filled in or guessed for them, and that
|
372
|
-
# information is likely correct.
|
373
|
-
#
|
374
|
-
# @param msg [String] The log message to write.
|
375
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which this log
|
376
|
-
# is associated with, if any. This is shown before the log message if it is
|
377
|
-
# specified.
|
378
|
-
# @return [void]
|
379
|
-
#
|
380
|
-
# source://sord//lib/sord/logging.rb#139
|
381
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
382
|
-
# sord omit - no YARD type given for "**opts", using untyped
|
383
|
-
# Print an infer message. This should be used when the user should be told
|
384
|
-
# that some information has been filled in or guessed for them, and that
|
385
|
-
# _@param_ `msg` — The log message to write.
|
386
|
-
# _@param_ `item` — The CodeObject which this log is associated with, if any. This is shown before the log message if it is specified.
|
387
|
-
sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base), opts: T.untyped).void }
|
388
|
-
def infer(msg, item = T.unsafe(nil), **opts); end
|
389
|
-
|
390
|
-
# Print an info message. This should be used for generic informational
|
391
|
-
# messages which the user doesn't need to act on.
|
392
|
-
#
|
393
|
-
# @param msg [String] The log message to write.
|
394
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which this log
|
395
|
-
# is associated with, if any. This is shown before the log message if it is
|
396
|
-
# specified.
|
397
|
-
# @return [void]
|
398
|
-
#
|
399
|
-
# source://sord//lib/sord/logging.rb#104
|
400
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
401
|
-
# sord omit - no YARD type given for "**opts", using untyped
|
402
|
-
# Print an info message. This should be used for generic informational
|
403
|
-
# _@param_ `msg` — The log message to write.
|
404
|
-
# _@param_ `item` — The CodeObject which this log is associated with, if any. This is shown before the log message if it is specified.
|
405
|
-
sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base), opts: T.untyped).void }
|
406
|
-
def info(msg, item = T.unsafe(nil), **opts); end
|
407
|
-
|
408
|
-
# Invokes all registered hooks on the logger.
|
409
|
-
#
|
410
|
-
# @param kind [Symbol] The kind of log message this is.
|
411
|
-
# @param msg [String] The log message to write.
|
412
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which this log
|
413
|
-
# is associated with, if any. This is shown before the log message if it is
|
414
|
-
# specified.
|
415
|
-
# @return [void]
|
416
|
-
#
|
417
|
-
# source://sord//lib/sord/logging.rb#173
|
418
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
419
|
-
# sord omit - no YARD type given for "**opts", using untyped
|
420
|
-
# _@param_ `kind` — The kind of log message this is.
|
421
|
-
# _@param_ `msg` — The log message to write.
|
422
|
-
# _@param_ `item` — The CodeObject which this log is associated with, if any. This is shown before the log message if it is specified.
|
423
|
-
sig { params(kind: Symbol, msg: String, item: YARD::CodeObjects::Base, opts: T.untyped).void }
|
424
|
-
def invoke_hooks(kind, msg, item, **opts); end
|
425
|
-
|
426
|
-
# Print an omit message. This should be used as a special type of warning
|
427
|
-
# to alert the user that there is some information missing, but this
|
428
|
-
# information is not critical to the completion of the process.
|
429
|
-
#
|
430
|
-
# @param msg [String] The log message to write.
|
431
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which this log
|
432
|
-
# is associated with, if any. This is shown before the log message if it is
|
433
|
-
# specified.
|
434
|
-
# @return [void]
|
435
|
-
#
|
436
|
-
# source://sord//lib/sord/logging.rb#151
|
437
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
438
|
-
# sord omit - no YARD type given for "**opts", using untyped
|
439
|
-
# Print an omit message. This should be used as a special type of warning
|
440
|
-
# to alert the user that there is some information missing, but this
|
441
|
-
# _@param_ `msg` — The log message to write.
|
442
|
-
# _@param_ `item` — The CodeObject which this log is associated with, if any. This is shown before the log message if it is specified.
|
443
|
-
sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base), opts: T.untyped).void }
|
444
|
-
def omit(msg, item = T.unsafe(nil), **opts); end
|
445
|
-
|
446
|
-
# Sets whether log messages should be printed or not.
|
447
|
-
#
|
448
|
-
# @param value [Boolean]
|
449
|
-
# @return [void]
|
450
|
-
#
|
451
|
-
# source://sord//lib/sord/logging.rb#28
|
452
|
-
# _@param_ `value`
|
453
|
-
sig { params(value: T::Boolean).void }
|
454
|
-
def silent=(value); end
|
455
|
-
|
456
|
-
# @return [Boolean] Whether log messages should be printed or not. This is
|
457
|
-
# used for testing.
|
458
|
-
#
|
459
|
-
# source://sord//lib/sord/logging.rb#21
|
460
|
-
# _@return_ — Whether log messages should be printed or not. This is
|
461
|
-
# used for testing.
|
462
|
-
sig { returns(T::Boolean) }
|
463
|
-
def silent?; end
|
464
|
-
|
465
|
-
# Returns a boolean indicating whether a given array is a valid value for
|
466
|
-
# #enabled_types.
|
467
|
-
#
|
468
|
-
# @param value [Array<Symbol>]
|
469
|
-
# @return [void]
|
470
|
-
#
|
471
|
-
# source://sord//lib/sord/logging.rb#58
|
472
|
-
# Returns a boolean indicating whether a given array is a valid value for
|
473
|
-
# _@param_ `value`
|
474
|
-
sig { params(value: T::Array[Symbol]).void }
|
475
|
-
def valid_types?(value); end
|
476
|
-
|
477
|
-
# Print a warning message. This should be used for things which require the
|
478
|
-
# user's attention but do not prevent the process from stopping.
|
479
|
-
#
|
480
|
-
# @param msg [String] The log message to write.
|
481
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which this log
|
482
|
-
# is associated with, if any. This is shown before the log message if it is
|
483
|
-
# specified.
|
484
|
-
# @return [void]
|
485
|
-
#
|
486
|
-
# source://sord//lib/sord/logging.rb#93
|
487
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
488
|
-
# sord omit - no YARD type given for "**opts", using untyped
|
489
|
-
# Print a warning message. This should be used for things which require the
|
490
|
-
# _@param_ `msg` — The log message to write.
|
491
|
-
# _@param_ `item` — The CodeObject which this log is associated with, if any. This is shown before the log message if it is specified.
|
492
|
-
sig { params(msg: String, item: T.nilable(YARD::CodeObjects::Base), opts: T.untyped).void }
|
493
|
-
def warn(msg, item = T.unsafe(nil), **opts); end
|
494
|
-
end
|
495
|
-
end
|
496
|
-
|
497
|
-
# An array of all available logging types.
|
498
|
-
#
|
499
|
-
# source://sord//lib/sord/logging.rb#33
|
500
|
-
Sord::Logging::AVAILABLE_TYPES = T.let(T.unsafe(nil), Array)
|
501
|
-
|
502
|
-
# source://sord//lib/sord/parlour_plugin.rb#6
|
503
|
-
class Sord::ParlourPlugin < ::Parlour::Plugin
|
504
|
-
# @return [ParlourPlugin] a new instance of ParlourPlugin
|
505
|
-
#
|
506
|
-
# source://sord//lib/sord/parlour_plugin.rb#10
|
507
|
-
# sord omit - no YARD type given for "options", using untyped
|
508
|
-
sig { params(options: T.untyped).void }
|
509
|
-
def initialize(options); end
|
510
|
-
|
511
|
-
# source://sord//lib/sord/parlour_plugin.rb#82
|
512
|
-
# sord omit - no YARD return type given, using untyped
|
513
|
-
sig { returns(T.untyped) }
|
514
|
-
def add_custom_tags; end
|
515
|
-
|
516
|
-
# source://sord//lib/sord/parlour_plugin.rb#20
|
517
|
-
# sord omit - no YARD type given for "root", using untyped
|
518
|
-
# sord omit - no YARD return type given, using untyped
|
519
|
-
sig { params(root: T.untyped).returns(T.untyped) }
|
520
|
-
def generate(root); end
|
521
|
-
|
522
|
-
# Returns the value of attribute options.
|
523
|
-
#
|
524
|
-
# source://sord//lib/sord/parlour_plugin.rb#7
|
525
|
-
def options; end
|
526
|
-
|
527
|
-
# Returns the value of attribute parlour.
|
528
|
-
#
|
529
|
-
# source://sord//lib/sord/parlour_plugin.rb#8
|
530
|
-
def parlour; end
|
531
|
-
|
532
|
-
# Sets the attribute parlour
|
533
|
-
#
|
534
|
-
# @param value the value to set the attribute parlour to.
|
535
|
-
#
|
536
|
-
# source://sord//lib/sord/parlour_plugin.rb#8
|
537
|
-
def parlour=(_arg0); end
|
538
|
-
|
539
|
-
class << self
|
540
|
-
# source://sord//lib/sord/parlour_plugin.rb#91
|
541
|
-
# sord omit - no YARD return type given, using untyped
|
542
|
-
sig { params(block: T.untyped).returns(T.untyped) }
|
543
|
-
def with_clean_env(&block); end
|
544
|
-
end
|
545
|
-
end
|
546
|
-
|
547
|
-
# source://sord//lib/sord/resolver.rb#7
|
548
|
-
module Sord::Resolver
|
549
|
-
class << self
|
550
|
-
# source://sord//lib/sord/resolver.rb#60
|
551
|
-
# sord omit - no YARD type given for "nodes", using untyped
|
552
|
-
# sord omit - no YARD type given for "names_to_paths", using untyped
|
553
|
-
# sord omit - no YARD type given for "path", using untyped
|
554
|
-
# sord omit - no YARD return type given, using untyped
|
555
|
-
sig { params(nodes: T.untyped, names_to_paths: T.untyped, path: T.untyped).returns(T.untyped) }
|
556
|
-
def add_rbi_objects_to_paths(nodes, names_to_paths, path = T.unsafe(nil)); end
|
557
|
-
|
558
|
-
# source://sord//lib/sord/resolver.rb#44
|
559
|
-
# sord omit - no YARD type given for "all_decls", using untyped
|
560
|
-
# sord omit - no YARD type given for "names_to_paths", using untyped
|
561
|
-
# sord omit - no YARD type given for "path", using untyped
|
562
|
-
# sord omit - no YARD return type given, using untyped
|
563
|
-
sig { params(all_decls: T.untyped, names_to_paths: T.untyped, path: T.untyped).returns(T.untyped) }
|
564
|
-
def add_rbs_objects_to_paths(all_decls, names_to_paths, path = T.unsafe(nil)); end
|
565
|
-
|
566
|
-
# @return [Array<String>]
|
567
|
-
#
|
568
|
-
# source://sord//lib/sord/resolver.rb#99
|
569
|
-
sig { returns(T::Array[String]) }
|
570
|
-
def builtin_classes; end
|
571
|
-
|
572
|
-
# @return [void]
|
573
|
-
#
|
574
|
-
# source://sord//lib/sord/resolver.rb#76
|
575
|
-
sig { void }
|
576
|
-
def clear; end
|
577
|
-
|
578
|
-
# source://sord//lib/sord/resolver.rb#24
|
579
|
-
# sord omit - no YARD type given for "hash", using untyped
|
580
|
-
# sord omit - no YARD return type given, using untyped
|
581
|
-
sig { params(hash: T.untyped).returns(T.untyped) }
|
582
|
-
def load_gem_objects(hash); end
|
583
|
-
|
584
|
-
# @param name [String]
|
585
|
-
# @return [String, nil]
|
586
|
-
#
|
587
|
-
# source://sord//lib/sord/resolver.rb#94
|
588
|
-
# _@param_ `name`
|
589
|
-
sig { params(name: String).returns(T.nilable(String)) }
|
590
|
-
def path_for(name); end
|
591
|
-
|
592
|
-
# @param name [String]
|
593
|
-
# @return [Array<String>]
|
594
|
-
#
|
595
|
-
# source://sord//lib/sord/resolver.rb#82
|
596
|
-
# _@param_ `name`
|
597
|
-
sig { params(name: String).returns(T::Array[String]) }
|
598
|
-
def paths_for(name); end
|
599
|
-
|
600
|
-
# @return [void]
|
601
|
-
#
|
602
|
-
# source://sord//lib/sord/resolver.rb#9
|
603
|
-
sig { void }
|
604
|
-
def prepare; end
|
605
|
-
|
606
|
-
# @param name [String]
|
607
|
-
# @param item [Object]
|
608
|
-
# @return [Boolean]
|
609
|
-
#
|
610
|
-
# source://sord//lib/sord/resolver.rb#118
|
611
|
-
# _@param_ `name`
|
612
|
-
# _@param_ `item`
|
613
|
-
sig { params(name: String, item: Object).returns(T::Boolean) }
|
614
|
-
def resolvable?(name, item); end
|
615
|
-
end
|
616
|
-
end
|
617
|
-
|
618
|
-
# Contains methods to convert YARD types to Parlour types.
|
619
|
-
#
|
620
|
-
# source://sord//lib/sord/type_converter.rb#9
|
621
|
-
module Sord::TypeConverter
|
622
|
-
class << self
|
623
|
-
# Given a YARD duck type string, attempts to convert it to one of a list of pre-defined RBS
|
624
|
-
# built-in interfaces.
|
625
|
-
#
|
626
|
-
# For example, the common duck type `#to_s` has a built-in RBS equivalent `_ToS`.
|
627
|
-
#
|
628
|
-
# If no such interface exists, returns `nil`.
|
629
|
-
#
|
630
|
-
# @param type [String]
|
631
|
-
# @return [Parlour::Types::Type, nil]
|
632
|
-
#
|
633
|
-
# source://sord//lib/sord/type_converter.rb#306
|
634
|
-
# Given a YARD duck type string, attempts to convert it to one of a list of pre-defined RBS
|
635
|
-
# built-in interfaces.
|
636
|
-
# For example, the common duck type `#to_s` has a built-in RBS equivalent `_ToS`.
|
637
|
-
# _@param_ `type`
|
638
|
-
sig { params(type: String).returns(T.nilable(Parlour::Types::Type)) }
|
639
|
-
def duck_type_to_rbs_type(type); end
|
640
|
-
|
641
|
-
# Handles SORD_ERRORs.
|
642
|
-
#
|
643
|
-
# @param name [String, Parlour::Types::Type]
|
644
|
-
# @param log_warning [String]
|
645
|
-
# @param item [YARD::CodeObjects::Base]
|
646
|
-
# @param replace_errors_with_untyped [Boolean]
|
647
|
-
# @return [Parlour::Types::Type]
|
648
|
-
#
|
649
|
-
# source://sord//lib/sord/type_converter.rb#262
|
650
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
651
|
-
# _@param_ `name`
|
652
|
-
# _@param_ `log_warning`
|
653
|
-
# _@param_ `item`
|
654
|
-
# _@param_ `replace_errors_with_untyped`
|
655
|
-
sig do
|
656
|
-
params(
|
657
|
-
name: T.any(String, Parlour::Types::Type),
|
658
|
-
log_warning: String,
|
659
|
-
item: YARD::CodeObjects::Base,
|
660
|
-
replace_errors_with_untyped: T::Boolean
|
661
|
-
).returns(Parlour::Types::Type)
|
662
|
-
end
|
663
|
-
def handle_sord_error(name, log_warning, item, replace_errors_with_untyped); end
|
664
|
-
|
665
|
-
# Given a string of YARD type parameters (without angle brackets), splits
|
666
|
-
# the string into an array of each type parameter.
|
667
|
-
#
|
668
|
-
# @param params [String] The type parameters.
|
669
|
-
# @return [Array<String>] The split type parameters.
|
670
|
-
#
|
671
|
-
# source://sord//lib/sord/type_converter.rb#53
|
672
|
-
# Given a string of YARD type parameters (without angle brackets), splits
|
673
|
-
# _@param_ `params` — The type parameters.
|
674
|
-
# _@return_ — The split type parameters.
|
675
|
-
sig { params(params: String).returns(T::Array[String]) }
|
676
|
-
def split_type_parameters(params); end
|
677
|
-
|
678
|
-
# Converts a YARD type into a Parlour type.
|
679
|
-
#
|
680
|
-
# @param yard [Boolean, Array, String] The YARD type.
|
681
|
-
# @param item [YARD::CodeObjects::Base] The CodeObject which the YARD type
|
682
|
-
# is associated with. This is used for logging and can be nil, but this
|
683
|
-
# will lead to less informative log messages.
|
684
|
-
# @param config [Configuration] The generation configuration.
|
685
|
-
# @return [Parlour::Types::Type]
|
686
|
-
#
|
687
|
-
# source://sord//lib/sord/type_converter.rb#126
|
688
|
-
# sord warn - YARD::CodeObjects::Base wasn't able to be resolved to a constant in this project
|
689
|
-
# _@param_ `yard` — The YARD type.
|
690
|
-
# _@param_ `item` — The CodeObject which the YARD type is associated with. This is used for logging and can be nil, but this will lead to less informative log messages.
|
691
|
-
# _@param_ `config` — The generation configuration.
|
692
|
-
sig do
|
693
|
-
params(
|
694
|
-
yard: T.any(T::Boolean, T::Array[T.untyped], String),
|
695
|
-
item: YARD::CodeObjects::Base,
|
696
|
-
config: Configuration
|
697
|
-
).returns(Parlour::Types::Type)
|
698
|
-
end
|
699
|
-
def yard_to_parlour(yard, item, config); end
|
700
|
-
end
|
701
|
-
end
|
702
|
-
|
703
|
-
# Configuration for how the type converter should work in particular cases.
|
704
|
-
#
|
705
|
-
# source://sord//lib/sord/type_converter.rb#99
|
706
|
-
class Sord::TypeConverter::Configuration
|
707
|
-
# @return [Configuration] a new instance of Configuration
|
708
|
-
#
|
709
|
-
# source://sord//lib/sord/type_converter.rb#100
|
710
|
-
# sord omit - no YARD type given for "replace_errors_with_untyped:", using untyped
|
711
|
-
# sord omit - no YARD type given for "replace_unresolved_with_untyped:", using untyped
|
712
|
-
# sord omit - no YARD type given for "output_language:", using untyped
|
713
|
-
sig do
|
714
|
-
params(
|
715
|
-
replace_errors_with_untyped: T.untyped,
|
716
|
-
replace_unresolved_with_untyped: T.untyped,
|
717
|
-
output_language: T.untyped
|
718
|
-
).void
|
719
|
-
end
|
720
|
-
def initialize(replace_errors_with_untyped:, replace_unresolved_with_untyped:, output_language:); end
|
721
|
-
|
722
|
-
# The language which the generated types will be converted to - one of
|
723
|
-
# `:rbi` or `:rbs`.
|
724
|
-
#
|
725
|
-
# source://sord//lib/sord/type_converter.rb#108
|
726
|
-
def output_language; end
|
727
|
-
|
728
|
-
# The language which the generated types will be converted to - one of
|
729
|
-
# `:rbi` or `:rbs`.
|
730
|
-
#
|
731
|
-
# source://sord//lib/sord/type_converter.rb#108
|
732
|
-
def output_language=(_arg0); end
|
733
|
-
|
734
|
-
# @return [Boolean] If true, T.untyped is used instead of SORD_ERROR_
|
735
|
-
# constants for unknown types.
|
736
|
-
#
|
737
|
-
# source://sord//lib/sord/type_converter.rb#112
|
738
|
-
def replace_errors_with_untyped; end
|
739
|
-
|
740
|
-
# @return [Boolean] If true, T.untyped is used instead of SORD_ERROR_
|
741
|
-
# constants for unknown types.
|
742
|
-
#
|
743
|
-
# source://sord//lib/sord/type_converter.rb#112
|
744
|
-
def replace_errors_with_untyped=(_arg0); end
|
745
|
-
|
746
|
-
# @param replace_unresolved_with_untyped [Boolean] If true, T.untyped is
|
747
|
-
# used when Sord is unable to resolve a constant.
|
748
|
-
#
|
749
|
-
# source://sord//lib/sord/type_converter.rb#116
|
750
|
-
def replace_unresolved_with_untyped; end
|
751
|
-
|
752
|
-
# @param replace_unresolved_with_untyped [Boolean] If true, T.untyped is
|
753
|
-
# used when Sord is unable to resolve a constant.
|
754
|
-
#
|
755
|
-
# source://sord//lib/sord/type_converter.rb#116
|
756
|
-
def replace_unresolved_with_untyped=(_arg0); end
|
757
|
-
end
|
758
|
-
|
759
|
-
# Taken from: https://github.com/ruby/rbs/blob/master/core/builtin.rbs
|
760
|
-
# When the latest commit was: 6c847d1
|
761
|
-
#
|
762
|
-
# Interfaces which use generic arguments have those arguments as `untyped`, since I'm not aware
|
763
|
-
# of any standard way that these are specified.
|
764
|
-
#
|
765
|
-
# source://sord//lib/sord/type_converter.rb#275
|
766
|
-
Sord::TypeConverter::DUCK_TYPES_TO_RBS_TYPE_NAMES = T.let(T.unsafe(nil), Hash)
|
767
|
-
|
768
|
-
# Match duck types which require the object implement one or more methods,
|
769
|
-
# like '#foo', '#foo & #bar', '#foo&#bar&#baz', and '#foo&#bar&#baz&#foo_bar'.
|
770
|
-
#
|
771
|
-
# source://sord//lib/sord/type_converter.rb#31
|
772
|
-
Sord::TypeConverter::DUCK_TYPE_REGEX = T.let(T.unsafe(nil), Regexp)
|
773
|
-
|
774
|
-
# A regular expression which matches a Ruby namespace immediately followed
|
775
|
-
# by another Ruby namespace in angle brackets or curly braces.
|
776
|
-
# This is the format usually used in YARD to model generic
|
777
|
-
# types, such as "Array<String>", "Hash<String, Symbol>",
|
778
|
-
# "Hash{String => Symbol}", etc.
|
779
|
-
#
|
780
|
-
# source://sord//lib/sord/type_converter.rb#21
|
781
|
-
Sord::TypeConverter::GENERIC_TYPE_REGEX = T.let(T.unsafe(nil), Regexp)
|
782
|
-
|
783
|
-
# Matches valid method names.
|
784
|
-
# From: https://stackoverflow.com/a/4379197/2626000
|
785
|
-
#
|
786
|
-
# source://sord//lib/sord/type_converter.rb#26
|
787
|
-
Sord::TypeConverter::METHOD_NAME_REGEX = T.let(T.unsafe(nil), Regexp)
|
788
|
-
|
789
|
-
# A regular expression which matches ordered lists in the format of
|
790
|
-
# either "Array(String, Symbol)" or "(String, Symbol)".
|
791
|
-
#
|
792
|
-
# source://sord//lib/sord/type_converter.rb#36
|
793
|
-
Sord::TypeConverter::ORDERED_LIST_REGEX = T.let(T.unsafe(nil), Regexp)
|
794
|
-
|
795
|
-
# A regular expression which matches the shorthand Array syntax,
|
796
|
-
# "<String>".
|
797
|
-
#
|
798
|
-
# source://sord//lib/sord/type_converter.rb#44
|
799
|
-
Sord::TypeConverter::SHORTHAND_ARRAY_SYNTAX = T.let(T.unsafe(nil), Regexp)
|
800
|
-
|
801
|
-
# A regular expression which matches the shorthand Hash syntax,
|
802
|
-
# "{String => Symbol}".
|
803
|
-
#
|
804
|
-
# source://sord//lib/sord/type_converter.rb#40
|
805
|
-
Sord::TypeConverter::SHORTHAND_HASH_SYNTAX = T.let(T.unsafe(nil), Regexp)
|
806
|
-
|
807
|
-
# A regular expression which matches Ruby namespaces and identifiers.
|
808
|
-
# "Foo", "Foo::Bar", and "::Foo::Bar" are all matches, whereas "Foo.Bar"
|
809
|
-
# or "Foo#bar" are not.
|
810
|
-
#
|
811
|
-
# source://sord//lib/sord/type_converter.rb#13
|
812
|
-
Sord::TypeConverter::SIMPLE_TYPE_REGEX = T.let(T.unsafe(nil), Regexp)
|
813
|
-
|
814
|
-
# Built in parlour single arg generics
|
815
|
-
#
|
816
|
-
# source://sord//lib/sord/type_converter.rb#47
|
817
|
-
Sord::TypeConverter::SINGLE_ARG_GENERIC_TYPES = T.let(T.unsafe(nil), Array)
|
818
|
-
|
819
|
-
# source://sord//lib/sord/version.rb#3
|
820
|
-
Sord::VERSION = T.let(T.unsafe(nil), String)
|