Skip to content

Add gem command info and notice of command deprecation to readme #531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MathyouMB wants to merge 1 commit into from
Closed

Add gem command info and notice of command deprecation to readme #531

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,12 @@ $ bundle exec tapioca
Commands:
tapioca --version, -v # show version
tapioca dsl [constant...] # generate RBIs for dynamic methods
tapioca generate [gem...] # generate RBIs from gems
tapioca gem [gem...] # generate RBIs from gems
tapioca generate [gem...] # DEPRECATED: generate RBIs from gems
tapioca help [COMMAND] # Describe available commands or one specific command
tapioca init # initializes folder structure
tapioca require # generate the list of files to be required by tapioca
tapioca sync # sync RBIs to Gemfile
tapioca sync # DEPRECATED: sync RBIs to Gemfile
tapioca todo # generate the list of unresolved constants

Options:
Expand All @@ -83,13 +84,21 @@ Command: `tapioca init`

This will create the `sorbet/config` and `sorbet/tapioca/require.rb` files for you, if they don't exist. If any of the files already exist, they will not be changed.

### Generate for gems
### Generate RBIs for gems - **v0.5.0**

Command: `tapioca gem [gem...]`

This command will generate RBIs for the specified gems, place them in the RBI directory, and sync them with previously generated RBIs. This command will add, update, and remove RBIs as necessary.

The `gem` command is new in [release v0.5.0](https://github.com/Shopify/tapioca/releases/tag/v0.5.0) and combines the **now deprecated** `generate` and `sync` commands. If you are using a Tapioca version below v0.5.0, you will not be able to use this command.

### Generate for gems - **DEPRECATED with v0.5.0**

Command: `tapioca generate [gems...]`

This will generate RBIs for the specified gems and place them in the RBI directory.

### Generate for all gems in Gemfile
### Generate for all gems in Gemfile - **DEPRECATED with v0.5.0**

Command: `tapioca sync`

Expand Down