RubySchema

Stop shipping broken config files. Add editor validation and autocomplete for Ruby project configs in minutes.

RubySchema publishes JSON Schemas for popular Ruby project configuration files. Your editor can catch invalid keys, suggest valid options and show inline docs as you type.

Works with the YAML language server, JSON Schema-aware tooling and editor integrations like VS Code, Neovim and Zed.

21 schemas. Tested against real fixtures.

Quick Start

bin/rails app:template LOCATION=https://www.rubyschema.org/rails.rb

Injects schema comments into your Rails config files. Safe to re-run when new schemas are added.

Manual Setup

# yaml-language-server: $schema=<url>
{ "$schema": "<url>" }
#:schema <url>

Schemas

Rails
Database database.yml rubyschema.org/rails/database.json
Storage storage.yml rubyschema.org/rails/storage.json
Cable cable.yml rubyschema.org/rails/cable.json
Cache cache.yml rubyschema.org/rails/cache.json
Queue queue.yml rubyschema.org/rails/queue.json
Recurring recurring.yml rubyschema.org/rails/recurring.json
Deployment & CI
Kamal deploy.yml rubyschema.org/kamal/deploy.json
Lefthook lefthook.yml rubyschema.org/lefthook.json
Code Quality
RuboCop .rubocop.yml rubyschema.org/rubocop.json
Standard .standard.yml rubyschema.org/standard.json
Packwerk package.yml rubyschema.org/packwerk/package.json
Background Jobs
Sidekiq sidekiq.yml rubyschema.org/sidekiq.json
Shoryuken shoryuken.yml rubyschema.org/shoryuken.json
Monitoring
Honeybadger honeybadger.yml rubyschema.org/honeybadger.json
RoRvsWild rorvswild.yml rubyschema.org/rorvswild.json
Scout APM scout_apm.yml rubyschema.org/scout_apm.json
PgHero pghero.yml rubyschema.org/pghero.json
I18n
Locale files locales/*.yml rubyschema.org/i18n/locale.json
i18n-tasks i18n-tasks.yml rubyschema.org/i18n-tasks.json
Other
Mongoid mongoid.yml rubyschema.org/mongoid.json
Vite Ruby vite.json rubyschema.org/vite.json