related-files.nvim

An extension for telescope.nvim to jump between related files, as specified in code comments.

Compatibility

Version	Telescope Version
0.1.0	0.1.8

Installation

Packer

use { "nvim-telescope/telescope.nvim", tag = "0.1.6" }
use { "synchronal/related-files.nvim", requires = { "nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim" } }

local status_ok, telescope = pcall(require, "telescope")
if status_ok then
  telescope.load_extension('related_files')
else
  error("error loading related-files; telescope not found")
end

Adding related files

Related files are added to a file as a code comment:

# @related [a related file](path/to/file.txt)
# @related [another file](path/to/file.lua)

// @related [file name](path/to/file)

Usage

:Telescope related_files

Development

nvim --cmd "set rtp+=$(pwd)" fixtures/first.sh

:lua require("telescope").load_extension('related_files')
:Telescope related_files