RFC: Add solargraph gem to developer environments for code completion and syntax highlighting

aidenfine · February 9, 2026, 9:02pm

Context and Problem Statement

Katello development environments do not ship with an easy option for code completion and syntax highlighting.

Proposal

Add solargraph ruby gem as a dev dependency to Katello with support of solargraph config files to make intellisense easily supported in the Katello project. This would only be added to the Katello developer environment only and would not effect anything user facing. Note that for devs that still do not want solargraph enabled it can be disabled at a project level for themselves.

I have provided an example of how solargraph behaves in VSCode.

Alternative Designs

We could possibly make solargraph opt-in vs a dev dependency.

qcjames53 · February 9, 2026, 9:06pm

This seems like a great quality-of-life add. If we ever get around to adding yard documentation to katello methods, having docs auto-populate on highlight would be very nice.

ekohl · February 11, 2026, 3:27pm

In Foreman we load all Bundler files:

github.com/theforeman/foreman

Gemfile

e27225ac0


      
          Dir["#{File.dirname(FOREMAN_GEMFILE)}/bundler.d/*.rb"].each do |bundle|
            instance_eval(Bundler.read_file(bundle))
          end

We then also have a .gitignore line:

github.com/theforeman/foreman

.gitignore

e27225ac0


      
          test/reports/*
          db/schema.rb
          db/structure.sql
          config/settings.yaml
          config/ignored_environments.yml
          config/settings.plugins.d
          config/database.yml
          config/initializers/local_secret_token.rb
          config/initializers/encryption_key.rb
          Gemfile.lock
          bundler.d/*.local.rb
          *.sw?
          .idea
          *.pyc
          public/apipie-cache
          public/apipie-dsl-cache
          public/assets
          .DS_Store
          foreman_client
          doc/
          .rbenv*

So you can already apply this locally:

echo "gem 'solargraph'" > bundler.d/solargraph.local.rb

s/katello //
Because I’d love to have that more. In my experience it forces people to really think about what their method does, which inputs & outputs it has, etc.

aruzicka · February 11, 2026, 3:33pm

Is there a reason for picking solargraph over ruby-lsp these days?