README.md in tapioca-0.11.12 vs README.md in tapioca-0.11.13
- old
+ new
@@ -84,10 +84,11 @@
Options:
-c, [--config=<config file path>] # Path to the Tapioca configuration file
# Default: sorbet/tapioca/config.yml
-V, [--verbose], [--no-verbose] # Verbose output for debugging purposes
+ # Default: false
```
<!-- END_HELP -->
## Getting started
@@ -117,10 +118,11 @@
Options:
-c, [--config=<config file path>] # Path to the Tapioca configuration file
# Default: sorbet/tapioca/config.yml
-V, [--verbose], [--no-verbose] # Verbose output for debugging purposes
+ # Default: false
Get project ready for type checking
```
<!-- END_HELP_COMMAND_INIT -->
@@ -165,18 +167,21 @@
--out, -o, [--outdir=directory] # The output directory for generated gem RBI files
# Default: sorbet/rbi/gems
[--file-header], [--no-file-header] # Add a "This file is generated" header on top of each generated RBI file
# Default: true
[--all], [--no-all] # Regenerate RBI files for all gems
+ # Default: false
--pre, -b, [--prerequire=file] # A file to be required before Bundler.require is called
--post, -a, [--postrequire=file] # A file to be required after Bundler.require is called
# Default: sorbet/tapioca/require.rb
-x, [--exclude=gem [gem ...]] # Exclude the given gem(s) from RBI generation
[--include-dependencies], [--no-include-dependencies] # Generate RBI files for dependencies of the given gem(s)
+ # Default: false
--typed, -t, [--typed-overrides=gem:level [gem:level ...]] # Override for typed sigils for generated gem RBIs
# Default: {"activesupport"=>"false"}
[--verify], [--no-verify] # Verify RBIs are up-to-date
+ # Default: false
[--doc], [--no-doc] # Include YARD documentation from sources when generating RBIs. Warning: this might be slow
# Default: true
[--loc], [--no-loc] # Include comments with source location when generating RBIs
# Default: true
[--exported-gem-rbis], [--no-exported-gem-rbis] # Include RBIs found in the `rbi/` directory of the gem
@@ -193,10 +198,11 @@
[--halt-upon-load-error], [--no-halt-upon-load-error] # Halt upon a load error while loading the Rails application
# Default: true
-c, [--config=<config file path>] # Path to the Tapioca configuration file
# Default: sorbet/tapioca/config.yml
-V, [--verbose], [--no-verbose] # Verbose output for debugging purposes
+ # Default: false
Generate RBIs from gems
```
<!-- END_HELP_COMMAND_GEM -->
@@ -348,19 +354,20 @@
Usage:
tapioca annotations
Options:
[--sources=one two three] # URIs of the sources to pull gem RBI annotations from
- # Default: ["https://raw.githubusercontent.com/Shopify/rbi-central/main"]
+ # Default: "https://raw.githubusercontent.com/Shopify/rbi-central/main"
[--netrc], [--no-netrc] # Use .netrc to authenticate to private sources
# Default: true
[--netrc-file=NETRC_FILE] # Path to .netrc file
[--auth=AUTH] # HTTP authorization header for private sources
--typed, -t, [--typed-overrides=gem:level [gem:level ...]] # Override for typed sigils for pulled annotations
-c, [--config=<config file path>] # Path to the Tapioca configuration file
# Default: sorbet/tapioca/config.yml
-V, [--verbose], [--no-verbose] # Verbose output for debugging purposes
+ # Default: false
Pull gem RBI annotations from remote sources
```
<!-- END_HELP_COMMAND_ANNOTATIONS -->
@@ -465,25 +472,29 @@
[--file-header], [--no-file-header] # Add a "This file is generated" header on top of each generated RBI file
# Default: true
[--only=compiler [compiler ...]] # Only run supplied DSL compiler(s)
[--exclude=compiler [compiler ...]] # Exclude supplied DSL compiler(s)
[--verify], [--no-verify] # Verifies RBIs are up-to-date
+ # Default: false
-q, [--quiet], [--no-quiet] # Suppresses file creation output
+ # Default: false
-w, [--workers=N] # Number of parallel workers to use when generating RBIs (default: 2)
# Default: 2
[--rbi-max-line-length=N] # Set the max line length of generated RBIs. Signatures longer than the max line length will be wrapped
# Default: 120
-e, [--environment=ENVIRONMENT] # The Rack/Rails environment to use when generating RBIs
# Default: development
-l, [--list-compilers], [--no-list-compilers] # List all loaded compilers
+ # Default: false
[--app-root=APP_ROOT] # The path to the Rails application
# Default: .
[--halt-upon-load-error], [--no-halt-upon-load-error] # Halt upon a load error while loading the Rails application
# Default: true
-c, [--config=<config file path>] # Path to the Tapioca configuration file
# Default: sorbet/tapioca/config.yml
-V, [--verbose], [--no-verbose] # Verbose output for debugging purposes
+ # Default: false
Generate RBIs for dynamic methods
```
<!-- END_HELP_COMMAND_DSL -->
@@ -843,9 +854,10 @@
# Default: true
-w, [--workers=N] # Number of parallel workers (default: auto)
-c, [--config=<config file path>] # Path to the Tapioca configuration file
# Default: sorbet/tapioca/config.yml
-V, [--verbose], [--no-verbose] # Verbose output for debugging purposes
+ # Default: false
Check duplicated definitions in shim RBIs
```
<!-- END_HELP_COMMAND_CHECK_SHIMS -->