sg.nvim

sg.nvim is a plugin focused on bringing many of the features of sourcegraph.com into Neovim.

Status: Alpha (see #Features for currently supported features)

Bug Reporting

If you encounter a bug, please run :SourcegraphInfo and copy the contents of the information into your bug report. It will greatly help in debugging what is happening (and there will probably be some bugs to start... Sorry!)

Setup

Connection

You can connect to an existing Sourcegraph instance using the same environment variables that are used for src-cli. See this for more information.

If you have these environment variables set when opening Neovim, you'll connect to your instance of Sourcegraph

Features:

• Read files:
  • Directly from sourcegraph links: :edit <sourcegraph url>
    • sg.nvim will automatically add protocols for handling https://sourcegraph.com/* links.
  • Directly from buffer names: :edit sg://github.com/tjdevries/sam.py/-/src/sam.py
  • Use :SourcegraphLink to get a link for the location under your cursor
• Reading non-files:
  • Repository roots
  • Folders
    • Expand Folders
    • Unexpand Folders
    • Open file from folder
• Use builtin LSP client to connect to SG
  • Goto Definition
  • Goto References
    • <20 references
    • kind of broken right now for lots of references
• Basic Search
  • literal, regexp and structural search support
  • type:symbol support
  • repo support
• Advanced Search Features
  • Autocompletion
  • Memory of last searches
• More ??

Installation

-- Use your favorite package manager to install, for example in lazy.nvim
return {
  {
    "sourcegraph/sg.nvim",
    build = "cargo build --workspace",
    dependencies = { "nvim-lua/plenary.nvim" },
  },
}

You also need to have the appropriate environment variables to log in to your sourcegraph instance, as described in https://github.com/sourcegraph/src-cli#log-into-your-sourcegraph-instance

Nix(OS)

The project is packaged as a Nix Flake. Consume it as you normally would. In your Nix configuration, make sure that sg-nvim is included both as a Neovim plugin and as an environment/user package (because sg-lsp needs to be on your PATH).

See https://nixos.wiki/wiki/Neovim for more details on configuring neovim using Nix. Or see https://github.com/willruggiano/neovim.drv for a practical example.

For contributors and maintainers:

• There should be nothing to do, nix-related, when changes are made to the Rust project
• If you're Nix savvy and want to contribute, it would be nice to use crate2nix instead of the generic buildRustPackage. A github workflow would be needed to autoupdate the generated crate2nix files.

Setup:

-- Setup the LSP server to attach when you edit an sg:// buffer
require("sg").setup {
  -- Pass your own custom attach function
  --    If you do not pass your own attach function, then the following maps are provide:
  --        - gd -> goto definition
  --        - gr -> goto references
  on_attach = your_custom_lsp_attach_function
}


```vim
" Example mapping for doing searches from within neovim (may change)
nnoremap <space>ss <cmd>lua require('sg.telescope').fuzzy_search_results()<CR>

Demos:

• Latest Demo: Alpha Release
• Short clip of cross repository jump to definition: Clip
• Demo v2: YouTube
• Demo v1: YouTube