samuraikun/graphql-ruby-hands-on

using GraphQL on Ruby3/Rails7

DevContainer for Ruby 3.3, Rails 7.1, graphql-ruby, and Sidekiq

devcontainer for Ruby3.3, Ruby on Rails 7.1

• language server: solargraph
• debugging: debug
• formatter: rubocop
• type checking: rbs, rbs_rails, steep

VSCode DevContainer

Install remote container

※ https://code.visualstudio.com/docs/remote/containers#_installation

Run DevContainer

1. Open VSCode, then run Reopen in Container

Operation

Run Rails server

Run below command in terminal on the DevContainer

$ bin/rails db:seed
$ bin/rails s

GraphQL Playground

Access to http://0.0.0.0:3000/graphiql

Type Checking

$ bundle exec rbs collection install

# rbs_rails
$ bin/rake rbs_rails:all

# Steep check
$ bundle exec steep check

Solargraph

# Generate documentation for bundled gems
$ bundle exec solargraph bundle

# Download Ruby core documentation
$ bundle exec solargraph download-core

Debugging

Run Run Debug (Shortcut key: F5)

VSCode Debugging

VSCode extensions

• rebornix.Ruby
• castwide.solargraph
• KoichiSasada.vscode-rdbg
• soutaro.steep-vscode
• soutaro.rbs-syntax
• redhat.vscode-yaml
• VisualStudioExptTeam.vscodeintellicode
• esbenp.prettier-vscode
• EditorConfig.EditorConfig
• GitHub.copilot
• GitHub.copilot-chat

Architecture

Work on Docker Compose

• app: ruby:3.1-bullseye
• sidekiq: v7
• postgres: postgres:14
• redis: redis:7

References

• Visual Studio Code Doc - Developing inside a Container
• VS Code Solargraph Extension
• VSCode rdbg Ruby Debugger