Skip to content
A central repository for sharing type definitions for Ruby gems
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci Fix CI (#45) Jul 10, 2019
lib Update ActiveRecord to remove 5.2 classes from all (#60) Jul 13, 2019
.gitattributes every journey starts with but a single step Apr 5, 2019
.gitignore every journey starts with but a single step Apr 5, 2019
.travis.yml Fix CI (#45) Jul 10, 2019
LICENCE add licence files Apr 5, 2019
NOTICE add licence files Apr 5, 2019
README.md Update README.md (#44) Jul 10, 2019

README.md

BuildStatus

sorbet-typed

A central repository for sharing type definitions for Ruby gems

Inspired by definitelytyped.org. Used in conjunction with Sorbet.

Installation

Use the Sorbet gem. srb init will fetch the applicable files from this repository into your project.

Adding .rbi files

To add .rbi files for a particular gem:

  1. Add a subdirectory to lib with the same name as the gem.
  2. 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 it all to affect all Gem versions.

For example, suppose you wanted to add type signatures to the json-schema gem, version 2.5.2.

  1. Create the directory lib/json-schema.
  2. 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/all
  • lib/json-schema/>1.0
  • lib/json-schema/~>2.5
  • lib/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/all
  • lib/json-schema/>1.0
  • lib/json-schema/~>2.5

Contributors

This repository was originally written by the fine folks at Coinbase. Thanks so much for starting the ball rolling!

You can’t perform that action at this time.