Lack of completions (possibly because of definition in C file)
Open
Nobody has claimed this yet.
bug
help-wanted
pinned
vscode
- Dominant language
- Ruby
- Stars
- 2k
- Forks
- 281
- Avg merge
- 2h 14m
- Merged PRs (30d)
- 6
Description
Description
Ruby LSP Information
VS Code Version
1.96.2
Ruby LSP Extension Version
0.8.19
Ruby LSP Server Version
0.23.7
Ruby LSP Add-ons
Ruby Version
3.4.1
Ruby Version Manager
rbenv
Installed Extensions
Click to expand
- LiveServer (5.7.9)
- codetogether (2025.1.0)
- go (0.44.0)
- ruby-lsp (0.8.19)
Ruby LSP Settings
Click to expand
Workspace
{}
User
{
"enabledFeatures": {
"codeActions": true,
"diagnostics": true,
"documentHighlights": true,
"documentLink": true,
"documentSymbols": true,
"foldingRanges": true,
"formatting": true,
"hover": true,
"inlayHint": true,
"onTypeFormatting": true,
"selectionRanges": true,
"semanticHighlighting": true,
"completion": true,
"codeLens": true,
"definition": true,
"workspaceSymbol": true,
"signatureHelp": true,
"typeHierarchy": true
},
"featuresConfiguration": {},
"addonSettings": {},
"rubyVersionManager": {
"identifier": "auto"
},
"customRubyCommand": "",
"formatter": "auto",
"linters": null,
"bundleGemfile": "",
"testTimeout": 30,
"branch": "",
"pullDiagnosticsOn": "both",
"useBundlerCompose": false,
"bypassTypechecker": false,
"rubyExecutablePath": "",
"indexing": {},
"erbSupport": true,
"featureFlags": {}
}
Reproduction steps
- Start the Ruby LSP using a certain editor
- Open a Ruby file
- Paste one of the examples
- See lack of completion
Code snippet or error message
Digest::SHA2.hexdigest example:
require 'digest'
Digest::SHA2.hexd # <- try to autocomplete 'hexdigest'
Zlib example:
require 'zli # <- try to autocomplete 'zlib'
Both zlib module and hexdigest functions are defined inside C files, but have definition in RBS files.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing completion for Digest::SHA2.hexd and the Zlib require example in the Ruby LSP completion path. Trace how definitions from C files and their RBS declarations are indexed and exposed to completion. Done means the missing hexdigest and zlib completions appear in these examples, with regression coverage for both cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100