zed-r

Provides tree-sitter queries and Language Server Protocol (LSP) support for Zed.

Installing

The latest version can be installed from the Zed extensions menu, or by cloning the repo and installing it locally from the Zed extensions menu.

LSP

The R packages 'languageserver' and 'lintr' are needed

RStudio keybindings

• Add this to your keybindings.json by opening the command palette (Ctrl+Shift+P) and selecting zed: open keybindings

  {
    "context": "Editor",
    "bindings": {
      "ctrl-shift-f10": "repl::Restart", # Equivalent to restarting R in RStudio
      "ctrl-\\": "assistant::InlineAssist",
      "ctrl-shift-m": ["workspace::SendKeystrokes", "space |> space"],
      "alt--": ["workspace::SendKeystrokes", "space < - space"],
      "ctrl-alt-i": ["workspace::SendKeystrokes", "\n# space %%\n"],
      "ctrl-shift-d": [
        "task::Spawn",
        { "task_name": "Document local R package", "reveal_target": "center" }
      ]
    }
  },
  {
    "context": "Workspace",
    "bindings": {
      "ctrl-shift-t": [
        "task::Spawn",
        { "task_name": "Run all R tests", "reveal_target": "center" }
      ],
      "ctrl-shift-r": [
        "task::Spawn",
        { "task_name": "Run current R file test", "reveal_target": "center" }
      ],
      "ctrl-shift-b": [
        "task::Spawn",
        {
          "task_name": "Install local R package",
          "reveal_target": "center"
        }
      ],
      "ctrl-2": [
        "task::Spawn",
        { "task_name": "R Terminal", "reveal_target": "center" }
      ]
    }
  }

Tasks for R (works with RStudio keybindings)

• Add this to your tasks.json by opening the command palette (Ctrl+Shift+P) and selecting zed: open tasks

[
  {
    "label": "R Terminal",
    "command": "R",
    "cwd": "$ZED_WORKTREE_ROOT",
    "use_new_terminal": true
  },
  {
    "label": "Install local R package",
    "command": "R CMD INSTALL .",
    "cwd": "$ZED_WORKTREE_ROOT",
    "use_new_terminal": false,
    "allow_concurrent_runs": false,
    "reveal": "always",
    "show_summary": true,
    "show_output": true,
    "show_error": true
  },
  {
    "label": "Document local R package",
    "command": "Rscript -e \"devtools::document(roclets = c('rd', 'collate', 'namespace'))\"",
    "cwd": "$ZED_WORKTREE_ROOT",
    "use_new_terminal": false,
    "allow_concurrent_runs": false
  },
  {
    "label": "Run all R tests",
    "command": "Rscript -e \"testthat::test_dir('tests/testthat')\"",
    "cwd": "$ZED_WORKTREE_ROOT",
    "use_new_terminal": false,
    "allow_concurrent_runs": false,
    "reveal": "always",
    "show_summary": true,
    "show_output": true
  },
  {
    "label": "Run current R file test",
    "command": "Rscript -e \"testthat::test_file('$ZED_RELATIVE_FILE')\"",
    "cwd": "$ZED_WORKTREE_ROOT",
    "use_new_terminal": false,
    "allow_concurrent_runs": false,
    "reveal": "always",
    "show_summary": true,
    "show_output": true
  }
]

• For a different keyboard shortcut for tasks, follow this section in the official Zed documentation.

Caveats

• A custom startup message in .Rprofile can potentially cause the the LSP message headers to be decoded improperly and prevent the language server from starting in Zed (#7).

Known issues

Check out the project's issue list for a list of unresolved issues. Feel free to fix any of them and send me a pull request!