REditorSupport / REditorSupport/languageserver
Document symbol display in Rmd is not reliable
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 675
- Forks
- 118
- Avg merge
- 1d 37m
- Merged PRs (30d)
- 11
Description
In R Markdown files, sometimes document symbols are not displayed in VSCode's breadcrumbs view.
However, I have no idea what causes this issue. Please see the reprex below.
Reprex
Case 1: Document Symbol Appears Correctly
- Download this Rmd file
- Open the file in VSCode.
- Press
Ctrl+Shift+. (period).
Case 2: Document Symbol Does Not Appear
- Download another Rmd file
- Open the file in VSCode.
- Press
Ctrl+Shift+. (period).
System Info
Version: 1.55.2 (system setup)
Commit: 3c4e3df9e89829dce27b7b5c24508306b151f30d
Date: 2021-04-13T09:35:57.887Z
Electron: 11.3.0
Chrome: 87.0.4280.141
Node.js: 12.18.3
V8: 8.7.220.31-electron.0
OS: Windows_NT x64 10.0.19042
Contributor guide
No contributing guide indexed for this repository
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
Reproduce the behavior using data-import.Rmd and data-visualize.Rmd from the linked reprex in VSCode 1.55.2, then inspect the language-server handling of R Markdown document symbols. Done means identifying and fixing the cause so both files reliably show document symbols in the breadcrumbs view, with a regression check for the two cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100