Document Symbol is a way to represent the structure of a document. They are used to provide a quick overview of the document and to allow for quick navigation.
Ruby LSP already provides document symbols for Ruby files, such as classes, modules, methods, etc. But the Rails addon provides additional document symbols for Rails specific features.
In VS Code, you can open the document symbols view by pressing Ctrl + Shift + O.
Navigates between Active Record callbacks, validations, and associations using the Document Symbol feature.
Navigates between Active Support test cases using the Document Symbol feature.
Navigates to the route definition of a controller action using the Code Lens feature.
Navigates to the view file(s) of a controller action using the Code Lens feature.
Go to definition is a feature that allows you to navigate to the definition of a symbol.
In VS Code, you can trigger go to definition in 3 different ways:
- Select
Go to Definitionfrom the context menu F12on a symbolCmd + Clickon a symbol
In the following demos, we will use the Cmd + Click method to trigger go to definition.
Navigates to the definitions of Active Record callbacks and validations.
Navigates to the definitions of Active Record associations.
The Ruby LSP extension provides a Ruby file operations icon in the Explorer view that can be used to trigger
the Rails generate and Rails destroy commands.
These commands are also available in the Command Palette.
The Rails addon provides 3 ways to run and debug ActiveSupport tests using the Code Lens feature.
