REditorSupport / REditorSupport/languageserver

Provide more detailed outline of R6 classes

Open
#455 5 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
675
Forks
118
Avg merge
1d 37m
Merged PRs (30d)
11

Description

I might not know how to make it happen in VS Code or if it belongs to https://github.com/REditorSupport/vscode-r-lsp , but I have noticed that the outline of R6 classes could be improved. Currently, the outline shows only the names of R6 classes. It would be amazing if it could show declarations of members inside R6 classes - immensely helpful for big classes.

Here is my VSCode settings.json

{
    "files.associations": {
        "*.rmd": "markdown"
    },
    "workbench.editorAssociations": {
        "*.ipynb": "jupyter.notebook.ipynb"
    },
    "r.bracketedPaste": true,
    "r.rpath.linux": "/usr/local/bin/R",
    "r.rterm.linux": "/usr/local/bin/radian",
    "r.sessionWatcher": true,
    "r.workspaceViewer.removeHiddenItems": true,
    "editor.cursorSmoothCaretAnimation": true,
    "editor.formatOnType": true,
    "editor.inlineSuggest.enabled": true,
    "files.insertFinalNewline": true,
    "files.trimFinalNewlines": true,
    "files.trimTrailingWhitespace": true,
}

The outline:
image

Environment:
languageserver version 0.3.10
R LSP Client 0.1.16

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the outline behavior in VS Code using languageserver 0.3.10 and R LSP Client 0.1.16, then inspect the language server's document-symbol handling for R6 classes. Done means the outline shows declarations of members inside R6 classes, not only the class names; the issue names no source file or test to begin with.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.