/
cli.rb
324 lines (295 loc) · 10.3 KB
/
cli.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# typed: true
# frozen_string_literal: true
module Tapioca
class Cli < Thor
include CliHelper
include ConfigHelper
include SorbetHelper
include ShimsHelper
FILE_HEADER_OPTION_DESC = "Add a \"This file is generated\" header on top of each generated RBI file"
class_option :config,
aliases: ["-c"],
banner: "<config file path>",
type: :string,
desc: "Path to the Tapioca configuration file",
default: TAPIOCA_CONFIG_FILE
class_option :verbose,
aliases: ["-V"],
type: :boolean,
desc: "Verbose output for debugging purposes",
default: false
desc "init", "initializes folder structure"
def init
command = Commands::Init.new(
sorbet_config: SORBET_CONFIG_FILE,
tapioca_config: TAPIOCA_CONFIG_FILE,
default_postrequire: DEFAULT_POSTREQUIRE_FILE
)
command.execute
end
desc "require", "generate the list of files to be required by tapioca"
option :postrequire, type: :string, default: DEFAULT_POSTREQUIRE_FILE
def require
command = Commands::Require.new(
requires_path: options[:postrequire],
sorbet_config_path: SORBET_CONFIG_FILE
)
Tapioca.silence_warnings do
command.execute
end
end
desc "todo", "generate the list of unresolved constants"
option :todo_file,
type: :string,
desc: "Path to the generated todo RBI file",
default: DEFAULT_TODO_FILE
option :file_header,
type: :boolean,
desc: FILE_HEADER_OPTION_DESC,
default: true
def todo
command = Commands::Todo.new(
todo_file: options[:todo_file],
file_header: options[:file_header]
)
Tapioca.silence_warnings do
command.execute
end
end
desc "dsl [constant...]", "generate RBIs for dynamic methods"
option :outdir,
aliases: ["--out", "-o"],
banner: "directory",
desc: "The output directory for generated DSL RBI files",
default: DEFAULT_DSL_DIR
option :file_header,
type: :boolean,
desc: FILE_HEADER_OPTION_DESC,
default: true
option :only,
type: :array,
banner: "compiler [compiler ...]",
desc: "Only run supplied DSL compiler(s)",
default: []
option :exclude,
type: :array,
banner: "compiler [compiler ...]",
desc: "Exclude supplied DSL compiler(s)",
default: []
option :verify,
type: :boolean,
default: false,
desc: "Verifies RBIs are up-to-date"
option :quiet,
aliases: ["-q"],
type: :boolean,
desc: "Suppresses file creation output",
default: false
option :workers,
aliases: ["-w"],
type: :numeric,
desc: "EXPERIMENTAL: Number of parallel workers to use when generating RBIs",
default: 1
option :rbi_max_line_length,
type: :numeric,
desc: "Set the max line length of generated RBIs. Signatures longer than the max line length will be wrapped",
default: 120
def dsl(*constants)
command = Commands::Dsl.new(
requested_constants: constants,
outpath: Pathname.new(options[:outdir]),
only: options[:only],
exclude: options[:exclude],
file_header: options[:file_header],
compiler_path: Tapioca::Dsl::Compilers::DIRECTORY,
tapioca_path: TAPIOCA_DIR,
should_verify: options[:verify],
quiet: options[:quiet],
verbose: options[:verbose],
number_of_workers: options[:workers],
rbi_formatter: rbi_formatter(options)
)
if options[:workers] != 1
say(
"Using more than one worker is experimental and might produce results that are not deterministic",
:red
)
end
Tapioca.silence_warnings do
command.execute
end
end
desc "gem [gem...]", "generate RBIs from gems"
option :outdir,
aliases: ["--out", "-o"],
banner: "directory",
desc: "The output directory for generated gem RBI files",
default: DEFAULT_GEM_DIR
option :file_header,
type: :boolean,
desc: FILE_HEADER_OPTION_DESC,
default: true
option :all,
type: :boolean,
desc: "Regenerate RBI files for all gems",
default: false
option :prerequire,
aliases: ["--pre", "-b"],
banner: "file",
desc: "A file to be required before Bundler.require is called",
default: nil
option :postrequire,
aliases: ["--post", "-a"],
banner: "file",
desc: "A file to be required after Bundler.require is called",
default: DEFAULT_POSTREQUIRE_FILE
option :exclude,
aliases: ["-x"],
type: :array,
banner: "gem [gem ...]",
desc: "Exclude the given gem(s) from RBI generation",
default: []
option :typed_overrides,
aliases: ["--typed", "-t"],
type: :hash,
banner: "gem:level [gem:level ...]",
desc: "Override for typed sigils for generated gem RBIs",
default: DEFAULT_OVERRIDES
option :verify,
type: :boolean,
desc: "Verify RBIs are up-to-date",
default: false
option :doc,
type: :boolean,
desc: "Include YARD documentation from sources when generating RBIs. Warning: this might be slow",
default: true
option :exported_gem_rbis,
type: :boolean,
desc: "Include RBIs found in the `rbi/` directory of the gem",
default: true
option :workers,
aliases: ["-w"],
type: :numeric,
desc: "EXPERIMENTAL: Number of parallel workers to use when generating RBIs",
default: 1
option :auto_strictness,
type: :boolean,
desc: "Autocorrect strictness in gem RBIs in case of conflict with the DSL RBIs",
default: true
option :dsl_dir,
aliases: ["--dsl-dir"],
banner: "directory",
desc: "The DSL directory used to correct gems strictnesses",
default: DEFAULT_DSL_DIR
option :rbi_max_line_length,
type: :numeric,
desc: "Set the max line length of generated RBIs. Signatures longer than the max line length will be wrapped",
default: 120
def gem(*gems)
Tapioca.silence_warnings do
all = options[:all]
verify = options[:verify]
command = Commands::Gem.new(
gem_names: all ? [] : gems,
exclude: options[:exclude],
prerequire: options[:prerequire],
postrequire: options[:postrequire],
typed_overrides: options[:typed_overrides],
outpath: Pathname.new(options[:outdir]),
file_header: options[:file_header],
doc: options[:doc],
include_exported_rbis: options[:exported_gem_rbis],
number_of_workers: options[:workers],
auto_strictness: options[:auto_strictness],
dsl_dir: options[:dsl_dir],
rbi_formatter: rbi_formatter(options)
)
raise MalformattedArgumentError, "Options '--all' and '--verify' are mutually exclusive" if all && verify
unless gems.empty?
raise MalformattedArgumentError, "Option '--all' must be provided without any other arguments" if all
raise MalformattedArgumentError, "Option '--verify' must be provided without any other arguments" if verify
end
if options[:workers] != 1
say(
"Using more than one worker is experimental and might produce results that are not deterministic",
:red
)
end
if gems.empty? && !all
command.sync(should_verify: verify)
else
command.execute
end
end
end
map "gems" => :gem
desc "check-shims", "check duplicated definitions in shim RBIs"
option :gem_rbi_dir, type: :string, desc: "Path to gem RBIs", default: DEFAULT_GEM_DIR
option :dsl_rbi_dir, type: :string, desc: "Path to DSL RBIs", default: DEFAULT_DSL_DIR
option :shim_rbi_dir, type: :string, desc: "Path to shim RBIs", default: DEFAULT_SHIM_DIR
option :payload, type: :boolean, desc: "Check shims against Sorbet's payload", default: true
def check_shims
index = RBI::Index.new
shim_rbi_dir = options[:shim_rbi_dir]
if !Dir.exist?(shim_rbi_dir) || Dir.empty?(shim_rbi_dir)
say("No shim RBIs to check", :green)
exit(0)
end
payload_path = T.let(nil, T.nilable(String))
if options[:payload]
if sorbet_supports?(:print_payload_sources)
Dir.mktmpdir do |dir|
payload_path = dir
result = sorbet("--no-config --print=payload-sources:#{payload_path}")
unless result.status
say_error("Sorbet failed to dump payload")
say_error(result.err)
exit(1)
end
index_payload(index, payload_path)
end
else
say_error("The version of Sorbet used in your Gemfile.lock does not support `--print=payload-sources`")
say_error("Current: v#{SORBET_GEM_SPEC.version}")
say_error("Required: #{FEATURE_REQUIREMENTS[:print_payload_sources]}")
exit(1)
end
end
index_rbis(index, "shim", shim_rbi_dir)
index_rbis(index, "gem", options[:gem_rbi_dir])
index_rbis(index, "dsl", options[:dsl_rbi_dir])
duplicates = duplicated_nodes_from_index(index, shim_rbi_dir)
unless duplicates.empty?
duplicates.each do |key, nodes|
say_error("\nDuplicated RBI for #{key}:", :red)
nodes.each do |node|
node_loc = node.loc
next unless node_loc
loc_string = location_to_payload_url(node_loc, path_prefix: payload_path)
say_error(" * #{loc_string}", :red)
end
end
say_error("\nPlease remove the duplicated definitions from the #{shim_rbi_dir} directory.", :red)
exit(1)
end
say("\nNo duplicates found in shim RBIs", :green)
exit(0)
end
desc "annotations", "Pull gem annotations from a central RBI repository"
option :repo_uri, type: :string, desc: "Repository URI to pull annotations from", default: CENTRAL_REPO_ROOT_URI
def annotations
command = Commands::Annotations.new(central_repo_root_uri: options[:repo_uri])
command.execute
end
map ["--version", "-v"] => :__print_version
desc "--version, -v", "show version"
def __print_version
puts "Tapioca v#{Tapioca::VERSION}"
end
no_commands do
def self.exit_on_failure?
true
end
end
end
end