Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gbprod/open-related.nvim
A Neovim plugin to quickly open related files
https://github.com/gbprod/open-related.nvim
neovim neovim-plugin nvim nvim-plugin
Last synced: 26 days ago
JSON representation
A Neovim plugin to quickly open related files
- Host: GitHub
- URL: https://github.com/gbprod/open-related.nvim
- Owner: gbprod
- License: wtfpl
- Created: 2021-09-16T09:53:15.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-29T08:39:04.000Z (almost 3 years ago)
- Last Synced: 2023-04-04T12:37:13.059Z (over 1 year ago)
- Topics: neovim, neovim-plugin, nvim, nvim-plugin
- Language: Lua
- Homepage:
- Size: 27.3 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# open-related.nvim
Quickly open related files in neovim.
Work in progress, API could change.
## Motivation
The aim is to quickly open and create files related to the current one. For example, we
want to go to the test file or to the implementation, or go to the header file...
## Usage
Open relations using vim command `OpenRelated` or `lua require("open-related").open_related()`.
Create relations using vim command `CreateRelated` or `lua require("open-related").create_related()`.
## setup
```lua
-- install using packer
use("gbprod/open-related", {
requires = {
{ 'nvim-lua/plenary.nvim' },
{ 'nvim-telescope/telescope.nvim' }
}
})
open_related = require('open-related')
open_related.setup({})
-- This will add a simple relation
open_related.add_relation({
-- Filetypes where the relation apply
filetypes = { 'php' },
-- Does the relation should apply
condition = function(bufnr)
return true
end,
-- return relations
related_to = function(bufnr, opts)
return {}
end,
-- Options that will be passed to the related_to function
opts = {},
})
```
The `related_to` function should return a table of :
```lua
{
file = "exact/match", -- If present, this is the path from cwd of an expected relation
}
```
### Setup structure
```lua
require('open-related').setup({
open_with = "qflist", -- or telescope
create_with = "inputlist", -- or telescope
})
```
## Helpers
Helpers can simplify creating relations.
### Find relations based on the filename
`from_patterns` will allows to tranform filename in order to find the related files.
The basic example will be to find the C++ header file (and reverse).
```lua
open_related.add_relation({
filetypes = { 'cpp' },
related_to = filename.from_patterns({
-- This will capture the part before the `.h` (using lua `match` function)
-- and apply it to associated pattern (using lua `format` function)
{ match = "(.*).h$", format = "%s.cpp"},
{ match = "(.*).cpp$", format = "%s.h" },
}),
})
```
## Builtins
This comes with some builtin relations for some languages, this allows to use "well-known" relations.
You can override builtins options using the `with` method.
### C++
Alternate throught the header and the implementation file.
```lua
open_related.add_relation(
require("open-related.builtin.cpp").alternate_header
)
```
### php
Alternate throught test files.
eg. `src/Model/Product.php` <=> `tests/Model/ProductTest.php`
```lua
open_related.add_relation(
require("open-related.builtin.php").alternate_test_file
)
```
You can specify additionnal tests namespace prefixes using the `test_namespace_prefixes`
```lua
open_related.add_relation(
require("open-related.builtin.php").alternate_test_file.with({
opts = {
test_namespace_prefixes = { "Integration", "Unit" },
},
})
)
```
This will match : `src/Model/Product.php` <=> `tests/Model/ProductTest.php` and `tests/Unit/Model/ProductTest.php` and `tests/Integration/Model/ProductTest.php`