checkoff 0.223.0 → 0.225.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/checkoff.gemspec +10 -5
- 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 +3 -4
- 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 +4 -210
- 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,435 +0,0 @@
|
|
1
|
-
# typed: true
|
2
|
-
|
3
|
-
# DO NOT EDIT MANUALLY
|
4
|
-
# This is an autogenerated file for types exported from the `yard-sorbet` gem.
|
5
|
-
# Please instead update this file by running `bin/tapioca gem yard-sorbet`.
|
6
|
-
|
7
|
-
|
8
|
-
class YARD::Handlers::Ruby::ClassHandler < ::YARD::Handlers::Ruby::Base
|
9
|
-
include ::YARDSorbet::Handlers::StructClassHandler
|
10
|
-
end
|
11
|
-
|
12
|
-
# Types are documentation
|
13
|
-
#
|
14
|
-
# source://yard-sorbet//lib/yard-sorbet/version.rb#5
|
15
|
-
module YARDSorbet; end
|
16
|
-
|
17
|
-
# Extract & re-add directives to a docstring
|
18
|
-
#
|
19
|
-
# source://yard-sorbet//lib/yard-sorbet/directives.rb#6
|
20
|
-
module YARDSorbet::Directives
|
21
|
-
class << self
|
22
|
-
# source://yard-sorbet//lib/yard-sorbet/directives.rb#21
|
23
|
-
sig { params(docstring: ::String, directives: T::Array[::String]).void }
|
24
|
-
def add_directives(docstring, directives); end
|
25
|
-
|
26
|
-
# source://yard-sorbet//lib/yard-sorbet/directives.rb#10
|
27
|
-
sig { params(docstring: T.nilable(::String)).returns([::YARD::Docstring, T::Array[::String]]) }
|
28
|
-
def extract_directives(docstring); end
|
29
|
-
end
|
30
|
-
end
|
31
|
-
|
32
|
-
# Custom YARD Handlers
|
33
|
-
#
|
34
|
-
# @see https://rubydoc.info/gems/yard/YARD/Handlers/Base YARD Base Handler documentation
|
35
|
-
#
|
36
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers.rb#7
|
37
|
-
module YARDSorbet::Handlers; end
|
38
|
-
|
39
|
-
# Applies an `@abstract` tag to `abstract!`/`interface!` modules (if not alerady present).
|
40
|
-
#
|
41
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/abstract_dsl_handler.rb#7
|
42
|
-
class YARDSorbet::Handlers::AbstractDSLHandler < ::YARD::Handlers::Ruby::Base
|
43
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/abstract_dsl_handler.rb#21
|
44
|
-
sig { void }
|
45
|
-
def process; end
|
46
|
-
end
|
47
|
-
|
48
|
-
# Extra text for class namespaces
|
49
|
-
#
|
50
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/abstract_dsl_handler.rb#18
|
51
|
-
YARDSorbet::Handlers::AbstractDSLHandler::CLASS_TAG_TEXT = T.let(T.unsafe(nil), String)
|
52
|
-
|
53
|
-
# The text accompanying the `@abstract` tag.
|
54
|
-
#
|
55
|
-
# @see https://github.com/lsegal/yard/blob/main/templates/default/docstring/html/abstract.erb The `@abstract` tag template
|
56
|
-
#
|
57
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/abstract_dsl_handler.rb#16
|
58
|
-
YARDSorbet::Handlers::AbstractDSLHandler::TAG_TEXT = T.let(T.unsafe(nil), String)
|
59
|
-
|
60
|
-
# Handle `enums` calls, registering enum values as constants
|
61
|
-
#
|
62
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/enums_handler.rb#7
|
63
|
-
class YARDSorbet::Handlers::EnumsHandler < ::YARD::Handlers::Ruby::Base
|
64
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/enums_handler.rb#14
|
65
|
-
sig { void }
|
66
|
-
def process; end
|
67
|
-
|
68
|
-
private
|
69
|
-
|
70
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/enums_handler.rb#29
|
71
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
|
72
|
-
def const_assign_node?(node); end
|
73
|
-
end
|
74
|
-
|
75
|
-
# Extends any modules included via `mixes_in_class_methods`
|
76
|
-
#
|
77
|
-
# @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook Sorbet `mixes_in_class_methods` documentation
|
78
|
-
#
|
79
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/include_handler.rb#9
|
80
|
-
class YARDSorbet::Handlers::IncludeHandler < ::YARD::Handlers::Ruby::Base
|
81
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/include_handler.rb#16
|
82
|
-
sig { void }
|
83
|
-
def process; end
|
84
|
-
|
85
|
-
private
|
86
|
-
|
87
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/include_handler.rb#28
|
88
|
-
sig { returns(::YARD::CodeObjects::NamespaceObject) }
|
89
|
-
def included_in; end
|
90
|
-
end
|
91
|
-
|
92
|
-
# Tracks modules that invoke `mixes_in_class_methods` for use in {IncludeHandler}
|
93
|
-
#
|
94
|
-
# @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook Sorbet `mixes_in_class_methods` documentation
|
95
|
-
#
|
96
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb#9
|
97
|
-
class YARDSorbet::Handlers::MixesInClassMethodsHandler < ::YARD::Handlers::Ruby::Base
|
98
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb#21
|
99
|
-
sig { void }
|
100
|
-
def process; end
|
101
|
-
|
102
|
-
class << self
|
103
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb#18
|
104
|
-
sig { params(code_obj: ::String).returns(T.nilable(T::Array[::String])) }
|
105
|
-
def mixed_in_class_methods(code_obj); end
|
106
|
-
end
|
107
|
-
end
|
108
|
-
|
109
|
-
# A YARD Handler for Sorbet type declarations
|
110
|
-
#
|
111
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#7
|
112
|
-
class YARDSorbet::Handlers::SigHandler < ::YARD::Handlers::Ruby::Base
|
113
|
-
# Swap the method definition docstring and the sig docstring.
|
114
|
-
# Parse relevant parts of the `sig` and include them as well.
|
115
|
-
#
|
116
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#24
|
117
|
-
sig { void }
|
118
|
-
def process; end
|
119
|
-
|
120
|
-
private
|
121
|
-
|
122
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#73
|
123
|
-
sig { params(method_objects: T::Array[::YARD::CodeObjects::MethodObject]).void }
|
124
|
-
def document_attrs(method_objects); end
|
125
|
-
|
126
|
-
# An attr* sig can be merged into a previous attr* docstring if it is the only parameter passed to the attr*
|
127
|
-
# declaration. This is to avoid needing to rewrite the source code to separate merged and unmerged attr*
|
128
|
-
# declarations.
|
129
|
-
#
|
130
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#60
|
131
|
-
sig { params(attr_node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Boolean) }
|
132
|
-
def merged_into_attr?(attr_node); end
|
133
|
-
|
134
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#76
|
135
|
-
sig do
|
136
|
-
params(
|
137
|
-
attach_to: T.any(::YARD::CodeObjects::MethodObject, ::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode),
|
138
|
-
docstring: T.nilable(::String),
|
139
|
-
include_params: T::Boolean
|
140
|
-
).void
|
141
|
-
end
|
142
|
-
def parse_node(attach_to, docstring, include_params: T.unsafe(nil)); end
|
143
|
-
|
144
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#97
|
145
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode, docstring: ::YARD::Docstring).void }
|
146
|
-
def parse_params(node, docstring); end
|
147
|
-
|
148
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#107
|
149
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode, docstring: ::YARD::Docstring).void }
|
150
|
-
def parse_return(node, docstring); end
|
151
|
-
|
152
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#85
|
153
|
-
sig { params(docstring: ::YARD::Docstring, include_params: T::Boolean).void }
|
154
|
-
def parse_sig(docstring, include_params: T.unsafe(nil)); end
|
155
|
-
|
156
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#50
|
157
|
-
sig { params(attr_node: ::YARD::Parser::Ruby::MethodCallNode).void }
|
158
|
-
def process_attr(attr_node); end
|
159
|
-
|
160
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#36
|
161
|
-
sig { params(def_node: ::YARD::Parser::Ruby::MethodDefinitionNode).void }
|
162
|
-
def process_def(def_node); end
|
163
|
-
end
|
164
|
-
|
165
|
-
# YARD types that can have docstrings attached to them
|
166
|
-
#
|
167
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#14
|
168
|
-
YARDSorbet::Handlers::SigHandler::Documentable = T.type_alias { T.any(::YARD::CodeObjects::MethodObject, ::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode) }
|
169
|
-
|
170
|
-
# Class-level handler that folds all `const` and `prop` declarations into the constructor documentation
|
171
|
-
# this needs to be injected as a module otherwise the default Class handler will overwrite documentation
|
172
|
-
#
|
173
|
-
# @note this module is included in `YARD::Handlers::Ruby::ClassHandler`
|
174
|
-
#
|
175
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#10
|
176
|
-
module YARDSorbet::Handlers::StructClassHandler
|
177
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#14
|
178
|
-
sig { void }
|
179
|
-
def process; end
|
180
|
-
|
181
|
-
private
|
182
|
-
|
183
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#50
|
184
|
-
sig do
|
185
|
-
params(
|
186
|
-
object: ::YARD::CodeObjects::MethodObject,
|
187
|
-
props: T::Array[::YARDSorbet::TStructProp],
|
188
|
-
docstring: ::YARD::Docstring,
|
189
|
-
directives: T::Array[::String]
|
190
|
-
).void
|
191
|
-
end
|
192
|
-
def decorate_t_struct_init(object, props, docstring, directives); end
|
193
|
-
|
194
|
-
# Create a virtual `initialize` method with all the `prop`/`const` arguments
|
195
|
-
#
|
196
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#30
|
197
|
-
sig { params(props: T::Array[::YARDSorbet::TStructProp], class_ns: ::YARD::CodeObjects::ClassObject).void }
|
198
|
-
def process_t_struct_props(props, class_ns); end
|
199
|
-
|
200
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#60
|
201
|
-
sig { params(props: T::Array[::YARDSorbet::TStructProp]).returns(T::Array[[::String, T.nilable(::String)]]) }
|
202
|
-
def to_object_parameters(props); end
|
203
|
-
end
|
204
|
-
|
205
|
-
# Handles all `const`/`prop` calls, creating accessor methods, and compiles them for later usage at the class level
|
206
|
-
# in creating a constructor
|
207
|
-
#
|
208
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#8
|
209
|
-
class YARDSorbet::Handlers::StructPropHandler < ::YARD::Handlers::Ruby::Base
|
210
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#15
|
211
|
-
sig { void }
|
212
|
-
def process; end
|
213
|
-
|
214
|
-
private
|
215
|
-
|
216
|
-
# Add the source and docstring to the method object
|
217
|
-
#
|
218
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#28
|
219
|
-
sig { params(object: ::YARD::CodeObjects::MethodObject, prop: ::YARDSorbet::TStructProp).void }
|
220
|
-
def decorate_object(object, prop); end
|
221
|
-
|
222
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#38
|
223
|
-
sig { returns(T::Boolean) }
|
224
|
-
def immutable?; end
|
225
|
-
|
226
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#42
|
227
|
-
sig { params(kwd: ::String).returns(T.nilable(::String)) }
|
228
|
-
def kw_arg(kwd); end
|
229
|
-
|
230
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#45
|
231
|
-
sig { params(name: ::String).returns(::YARDSorbet::TStructProp) }
|
232
|
-
def make_prop(name); end
|
233
|
-
|
234
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#56
|
235
|
-
sig { returns(T::Array[::YARD::Parser::Ruby::AstNode]) }
|
236
|
-
def params; end
|
237
|
-
|
238
|
-
# Register the field explicitly as an attribute.
|
239
|
-
#
|
240
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#60
|
241
|
-
sig { params(object: ::YARD::CodeObjects::MethodObject, name: ::String).void }
|
242
|
-
def register_attrs(object, name); end
|
243
|
-
|
244
|
-
# Store the prop for use in the constructor definition
|
245
|
-
#
|
246
|
-
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#68
|
247
|
-
sig { params(prop: ::YARDSorbet::TStructProp).void }
|
248
|
-
def update_state(prop); end
|
249
|
-
end
|
250
|
-
|
251
|
-
# Helper methods for working with `YARD` AST Nodes
|
252
|
-
#
|
253
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#6
|
254
|
-
module YARDSorbet::NodeUtils
|
255
|
-
class << self
|
256
|
-
# Traverse AST nodes in breadth-first order
|
257
|
-
#
|
258
|
-
# @note This will skip over some node types.
|
259
|
-
# @yield [YARD::Parser::Ruby::AstNode]
|
260
|
-
#
|
261
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#21
|
262
|
-
sig do
|
263
|
-
params(
|
264
|
-
node: ::YARD::Parser::Ruby::AstNode,
|
265
|
-
_blk: T.proc.params(n: ::YARD::Parser::Ruby::AstNode).void
|
266
|
-
).void
|
267
|
-
end
|
268
|
-
def bfs_traverse(node, &_blk); end
|
269
|
-
|
270
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#31
|
271
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).void }
|
272
|
-
def delete_node(node); end
|
273
|
-
|
274
|
-
# Enqueue the eligible children of a node in the BFS queue
|
275
|
-
#
|
276
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#35
|
277
|
-
sig { params(queue: ::Thread::Queue, node: ::YARD::Parser::Ruby::AstNode).void }
|
278
|
-
def enqueue_children(queue, node); end
|
279
|
-
|
280
|
-
# Gets the node that a sorbet `sig` can be attached do, bypassing visisbility modifiers and the like
|
281
|
-
#
|
282
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#48
|
283
|
-
sig do
|
284
|
-
params(
|
285
|
-
node: ::YARD::Parser::Ruby::AstNode
|
286
|
-
).returns(T.any(::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode))
|
287
|
-
end
|
288
|
-
def get_method_node(node); end
|
289
|
-
|
290
|
-
# Find and return the adjacent node (ascending)
|
291
|
-
#
|
292
|
-
# @raise [IndexError] if the node does not have an adjacent sibling (ascending)
|
293
|
-
#
|
294
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#53
|
295
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(::YARD::Parser::Ruby::AstNode) }
|
296
|
-
def sibling_node(node); end
|
297
|
-
|
298
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#60
|
299
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
|
300
|
-
def sigable_node?(node); end
|
301
|
-
|
302
|
-
# @see https://github.com/lsegal/yard/blob/main/lib/yard/handlers/ruby/attribute_handler.rb YARD::Handlers::Ruby::AttributeHandler.validated_attribute_names
|
303
|
-
#
|
304
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#71
|
305
|
-
sig { params(attr_node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Array[::String]) }
|
306
|
-
def validated_attribute_names(attr_node); end
|
307
|
-
end
|
308
|
-
end
|
309
|
-
|
310
|
-
# Command node types that can have type signatures
|
311
|
-
#
|
312
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#10
|
313
|
-
YARDSorbet::NodeUtils::ATTRIBUTE_METHODS = T.let(T.unsafe(nil), Array)
|
314
|
-
|
315
|
-
# Skip these method contents during BFS node traversal, they can have their own nested types via `T.Proc`
|
316
|
-
#
|
317
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#12
|
318
|
-
YARDSorbet::NodeUtils::SKIP_METHOD_CONTENTS = T.let(T.unsafe(nil), Array)
|
319
|
-
|
320
|
-
# Node types that can have type signatures
|
321
|
-
#
|
322
|
-
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#14
|
323
|
-
YARDSorbet::NodeUtils::SigableNode = T.type_alias { T.any(::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode) }
|
324
|
-
|
325
|
-
# Translate `sig` type syntax to `YARD` type syntax.
|
326
|
-
#
|
327
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#6
|
328
|
-
module YARDSorbet::SigToYARD
|
329
|
-
class << self
|
330
|
-
# @see https://yardoc.org/types.html
|
331
|
-
#
|
332
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#23
|
333
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
334
|
-
def convert(node); end
|
335
|
-
|
336
|
-
private
|
337
|
-
|
338
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#58
|
339
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(::String) }
|
340
|
-
def build_generic_type(node); end
|
341
|
-
|
342
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#67
|
343
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
344
|
-
def convert_aref(node); end
|
345
|
-
|
346
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#79
|
347
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
|
348
|
-
def convert_array(node); end
|
349
|
-
|
350
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#87
|
351
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
|
352
|
-
def convert_collection(node); end
|
353
|
-
|
354
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#94
|
355
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
|
356
|
-
def convert_hash(node); end
|
357
|
-
|
358
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#102
|
359
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
360
|
-
def convert_list(node); end
|
361
|
-
|
362
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#28
|
363
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
364
|
-
def convert_node(node); end
|
365
|
-
|
366
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#40
|
367
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
368
|
-
def convert_node_type(node); end
|
369
|
-
|
370
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#107
|
371
|
-
sig { params(node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Array[::String]) }
|
372
|
-
def convert_t_method(node); end
|
373
|
-
|
374
|
-
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#118
|
375
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
|
376
|
-
def convert_unknown(node); end
|
377
|
-
end
|
378
|
-
end
|
379
|
-
|
380
|
-
# Used to store the details of a `T::Struct` `prop` definition
|
381
|
-
#
|
382
|
-
# source://yard-sorbet//lib/yard-sorbet/t_struct_prop.rb#6
|
383
|
-
class YARDSorbet::TStructProp < ::T::Struct
|
384
|
-
const :default, T.nilable(::String)
|
385
|
-
const :doc, ::String
|
386
|
-
const :prop_name, ::String
|
387
|
-
const :source, ::String
|
388
|
-
const :types, T::Array[::String]
|
389
|
-
|
390
|
-
class << self
|
391
|
-
# source://sorbet-runtime/0.5.11647/lib/types/struct.rb#13
|
392
|
-
def inherited(s); end
|
393
|
-
end
|
394
|
-
end
|
395
|
-
|
396
|
-
# Helper methods for working with `YARD` tags
|
397
|
-
#
|
398
|
-
# source://yard-sorbet//lib/yard-sorbet/tag_utils.rb#6
|
399
|
-
module YARDSorbet::TagUtils
|
400
|
-
class << self
|
401
|
-
# source://yard-sorbet//lib/yard-sorbet/tag_utils.rb#16
|
402
|
-
sig do
|
403
|
-
params(
|
404
|
-
docstring: ::YARD::Docstring,
|
405
|
-
tag_name: ::String,
|
406
|
-
name: T.nilable(::String)
|
407
|
-
).returns(T.nilable(::YARD::Tags::Tag))
|
408
|
-
end
|
409
|
-
def find_tag(docstring, tag_name, name); end
|
410
|
-
|
411
|
-
# Create or update a `YARD` tag with type information
|
412
|
-
#
|
413
|
-
# source://yard-sorbet//lib/yard-sorbet/tag_utils.rb#28
|
414
|
-
sig do
|
415
|
-
params(
|
416
|
-
docstring: ::YARD::Docstring,
|
417
|
-
tag_name: ::String,
|
418
|
-
types: T.nilable(T::Array[::String]),
|
419
|
-
name: T.nilable(::String),
|
420
|
-
text: ::String
|
421
|
-
).void
|
422
|
-
end
|
423
|
-
def upsert_tag(docstring, tag_name, types = T.unsafe(nil), name = T.unsafe(nil), text = T.unsafe(nil)); end
|
424
|
-
end
|
425
|
-
end
|
426
|
-
|
427
|
-
# The `void` return type, as a constant to reduce array allocations
|
428
|
-
#
|
429
|
-
# source://yard-sorbet//lib/yard-sorbet/tag_utils.rb#10
|
430
|
-
YARDSorbet::TagUtils::VOID_RETURN_TYPE = T.let(T.unsafe(nil), Array)
|
431
|
-
|
432
|
-
# {https://rubygems.org/gems/yard-sorbet Version history}
|
433
|
-
#
|
434
|
-
# source://yard-sorbet//lib/yard-sorbet/version.rb#7
|
435
|
-
YARDSorbet::VERSION = T.let(T.unsafe(nil), String)
|