Include constants in outline

[joeldrapper]

I think it would make sense to include constants in the outline because it’s common to have Ruby files that define lots of constants and these are currently quite tricky to navigate compared to files that define lots of methods or classes.

[vitallium]

Just to confirm my understanding: do you want to display only constants that are written in uppercase, or do you want to display all constants?

[andyw8]

Ideally the outline would be populated from the language server via textDocument/documentSymbol:

zed-industries/zed#23095

[joeldrapper]

All constants. Anything that starts with a capital letter.

Foo = 1
BAR = 2
Error = Class.new(RuntimeError)

[vitallium]

@andyw8 Thanks for linking that! I forgot that Zed does not support textDocument/documentSymbol currently.

@joeldrapper something like this?

# frozen_string_literal: true

ABC = 1
Goo = 2
Foo = 3

foo = 1

class Category < ApplicationRecord
  validates :name, presence: true, length: { maximum: 255 }, uniqueness: true
  validates :hidden, inclusion: { in: [ true, false ] }
end

class RubyBlog
  URL    = "rubyguides.com"
  AUTHOR = "Jesus Castello"
  SomeError = "Jesus Castello"
end

We need to be careful here, as most things are constants in Ruby. I wonder what edge cases we could validate for this use case.

[joeldrapper]

This looks perfect to me. 🤩

I can't think of an example I've seen in my Ruby career where I wouldn't want the constants to be outlined like this.