rigortype/rigor/rigor-rbs-setup

Rigor RBS Setup

Most of what Rigor cannot type on a real application is the surface of third-party gems that ship no RBS: a call into such a gem returns Dynamic, so every downstream method on the result is unprotected and some genuine bugs go uncaught. The Ruby ecosystem's answer is the community RBS collection at `ruby/gem_rbs_collection`; this skill wires it into the project.

First: load the version-current copy

This skill's exact commands, flags, and config keys drift between Rigor releases, so follow the copy that ships with the installed Rigor rather than any vendored or frozen copy of this file. Get the complete current procedure in one call:

rigor skill --full rigor-rbs-setup

If you already loaded this skill via rigor skill you have the current copy — just proceed. If rigor is not on PATH, this task needs it: run `rigor-next-steps` to install Rigor first, then come back.

When to use

• rigor check ends with `info: N gem(s) in Gemfile.lock have no RBS

available: …` — that list is the gap this skill closes.

• A deep call chain into a gem (an HTTP client, a parser, a service

object) types as Dynamic and you want Rigor to see through it.

When NOT to use

• The project has no Rigor config yet — run rigor-project-init first.
• A specific gem you need is not in the community collection — RBS

setup will not cover it. That residue is for rigor-plugin-author (if it is your own DSL) or a Rigor issue (if it is a popular gem worth built-in support).

How Rigor consumes it (so you know what "done" looks like)

Rigor auto-detects rbs_collection.lock.yaml at the project root (rbs_collection.auto_detect defaults to true) and feeds each gem's downloaded RBS directory into its signature paths, skipping stdlib entries it already bundles. No `.rigor.yml` change is required — the lockfile's presence is the whole wiring. (Set rbs_collection.lockfile: only if the lockfile lives somewhere other than the project root.)

Procedure

Phase 1 — see the gap

rigor check

Read the closing info line listing the gems with no RBS. That is your target set.

Phase 2 — make the rbs CLI available

rbs collection is part of the rbs gem and reads the project's Gemfile.lock. Check it is runnable:

rbs --version            # or: bundle exec rbs --version

If it is missing, add it to the project's development group (bundle add rbs --group development) or install it standalone (gem install rbs). Prefer bundle exec rbs … when rbs is in the Gemfile so it matches the project's resolved versions. If bundle exec rbs runs an rbs that a mise-installed gem:rigortype put on PATH, see the install guide's note on `rbs` shadowing.

Phase 3 — initialise the collection config (first time only)

rbs collection init

This writes rbs_collection.yaml (which gems to pull, which to ignore). Skip if the file already exists; review it either way — the default pulls RBS for every gem in the lockfile that the collection knows.

Phase 4 — install

rbs collection install      # bundle exec rbs collection install when bundled

This resolves against ruby/gem_rbs_collection, writes rbs_collection.lock.yaml, and downloads the .rbs files into .gem_rbs_collection/.

Phase 5 — verify (re-check; watch for new diagnostics)

rigor check

Two things to confirm:

1. The `info` "no RBS available" list shrank — the gems now covered

dropped off it.

1. No surprising new diagnostics. Community RBS occasionally ships a

signature stricter than the gem's real runtime behaviour, which can surface a false positive. Treat the diff like any other:

• In acknowledge mode, regenerate the baseline

(rigor baseline regenerate) so the new envelope is recorded.

• For a genuine new error the sharper types caught, that is a win

— fix it.

• For a clear RBS-quality false positive, # rigor:disable <rule> the

site with a reason, or pin the gem out in rbs_collection.yaml.

Phase 6 — commit

Commit the config + lockfile, gitignore the download dir:

# .gitignore
.gem_rbs_collection/

Commit rbs_collection.yaml and rbs_collection.lock.yaml so every contributor and CI resolves the same RBS. .gem_rbs_collection/ is regenerable from the lockfile (rbs collection install), so it is not committed.

Next step

Re-run rigor skill describe — with the gem-RBS foundation in place it will route you to the next move (CI wiring, baseline work, or protection uplift).