Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/EtiamNullam/relative-source.nvim
Use this plugin to keep your neovim config clean and portable!
https://github.com/EtiamNullam/relative-source.nvim
lua neovim neovim-plugin nvim nvim-plugin
Last synced: 3 months ago
JSON representation
Use this plugin to keep your neovim config clean and portable!
- Host: GitHub
- URL: https://github.com/EtiamNullam/relative-source.nvim
- Owner: EtiamNullam
- Created: 2022-05-12T22:09:57.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-06-14T18:09:12.000Z (over 2 years ago)
- Last Synced: 2024-05-05T16:30:49.679Z (7 months ago)
- Topics: lua, neovim, neovim-plugin, nvim, nvim-plugin
- Language: Lua
- Homepage:
- Size: 15.6 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# relative-source.nvim
This [`neovim`](http://neovim.io/) plugin will let you easily source files relative to current script or file.
It's helpful when creating config in a form of a tree, spanning across multiple `lua` and `vimrc` files.
## Features
- Run scripts at relative (`path/to/file.lua`) and absolute (`~/path/to/file.lua`) paths.
- Supports `wildcards` (`path/*/to/file/*.lua`) and path traversal (`../../path/to/file.lua`).
- Will continue to the next file when error is encountered and display a message about what has gone wrong using `vim.notify()`, so one error will not cripple your whole configuration.
- Jump to listed files using `gf` as patterns are compatible.
- No caching.
## Requirements
```
nvim >= 0.5
```
## Installation
### Plugin manager
Any plugin manager should work.
vim-plug:
```vim
Plug 'EtiamNullam/relative-source.nvim'
```
### Manual
Place `relative-source.lua` in directory:
Unix:
```
~/.config/nvim/lua/
```
Windows:
```
~/AppData/Local/nvim/lua/
```
## Usage
### Example
Here you can see how this plugin can be used run config across multiple files.
`init.lua`:
```lua
vim.api.nvim_command [[
call plug#begin('~/.vim-plug')
Plug 'EtiamNullam/relative-source.nvim'
call plug#end()
]]
-- first run will fail here, so you have to invoke ':PlugInstall'
require('relative-source').source {
'activate-plugins.vimrc',
'setup-*',
'plugins/setup-*.lua',
}
```
## Updating
### Versioning
I will try to loosely follow [`Semantic Versioning 2.0`](https://semver.org/spec/v2.0.0.html).
Which means given `major`.`minor`.`patch`:
- `major` will change on API-breaking changes.
- `minor` will change on compatible changes.
- `patch` will change on bugfixes.
### Pinning
Branches `v`, `v.` and tags `v..` are available to follow so you don't have to worry about plugin breaking on update.
#### `vim-plug` examples
Pin to specific major version, allowing minor versions and patches to change:
```vim
Plug 'EtiamNullam/relative-source.nvim', { 'branch': 'v0' }
```
Pin to specific minor version, allowing patches to change:
```vim
Plug 'EtiamNullam/relative-source.nvim', { 'branch': 'v0.2' }
```
Pin to specific patch, allowing basically no change:
```vim
Plug 'EtiamNullam/relative-source.nvim', { 'tag': 'v0.2.0' }
```
#### Multiple `plug` blocks
When you have multiple `vim-plug`'s `plug` blocks:
- Pin version in the first block if needed.
- Include in the last block to allow updates.
```vim
call plug#begin('~/.vim-plug')
Plug 'EtiamNullam/relative-source.nvim', { 'branch: 'v0' }
call plug#end()
call plug#begin('~/.vim-plug')
Plug 'EtiamNullam/relative-source.nvim'
call plug#end()
```