A central repository for sharing type defintions for Ruby gems
Inspired by definitelytyped.org. Used in conjunction with Sorbet.
Use the Sorbet gem. srb init will fetch the applicable files from this repository into your project.
To add .rbi files for a particular gem:
- Add a subdirectory to
libwith the same name as the gem. - Add a subdirectory to the gem subdirectory with a name matching the version you are adding signatures to.
The naming of this directory follows the format of
Gem::Requirement, separated by,-or&. All requirements in the name must be satisfied. You can also name itallto affect all Gem versions.
For example, suppose you wanted to add type signatures to the json-schema gem, version 2.5.2.
- Create the directory
lib/json-schema. - Choose an appropriate requirement version string you want to type.
For
2.5.2, any of the following directory names would work:2.5.2/~>2.5/~>2/>1.4,<3/~>2.5,!=2.5.3/all/
Note that the rbis script will include all matching directory's .rbi files.
As an example, if the following directories existed:
lib/json-schema/alllib/json-schema/>1.0lib/json-schema/~>2.5lib/json-schema/>2.6
For json-schema@2.5.2, all of the .rbi files that exist in the following directories would be loaded:
lib/json-schema/alllib/json-schema/>1.0lib/json-schema/~>2.5
This repository was originally written by the fine folks at Coinbase. Thanks so much for starting the ball rolling!