https://github.com/aymericbeaumet/vim-symlink

:running: Automagically follow symlinks
https://github.com/aymericbeaumet/vim-symlink

nvim symlink vim

Last synced: 2 months ago
JSON representation

:running: Automagically follow symlinks

• Host: GitHub
• URL: https://github.com/aymericbeaumet/vim-symlink
• Owner: aymericbeaumet
• License: mit
• Created: 2016-12-13T01:16:20.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-05-20T15:08:31.000Z (over 1 year ago)
• Last Synced: 2024-10-14T12:26:00.836Z (3 months ago)
• Topics: nvim, symlink, vim
• Language: Vim script
• Homepage:
• Size: 4.1 MB
• Stars: 74
• Watchers: 4
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# vim-symlink [![GitHub Actions](https://github.com/aymericbeaumet/vim-symlink/actions/workflows/ci.yml/badge.svg)](https://github.com/aymericbeaumet/vim-symlink/actions/workflows/ci.yml)

[vim-symlink](https://github.com/aymericbeaumet/vim-symlink) enables to

automatically follow the symlinks in Vim or Neovim. This means that when you

edit a pathname that is a symlink, vim will instead open the file using the

resolved target path.

[![demo](./media/demo.gif)](./media/demo.gif)

## Features

- Cross-platform

- Recursive symlinks resolution

- [`vimdiff`](http://vimdoc.sourceforge.net/htmldoc/diff.html) support

- Allow to create new files in symlinked directories

- Make [vim-fugitive](https://github.com/tpope/vim-fugitive) behave properly

  with linked files

## Install

Install with [packer](https://github.com/wbthomason/packer.nvim):

```lua

use { 'aymericbeaumet/vim-symlink', requires = { 'moll/vim-bbye' } }

```

Install with [vim-plug](https://github.com/junegunn/vim-plug):

```vim

Plug 'aymericbeaumet/vim-symlink'

Plug 'moll/vim-bbye' " optional dependency

```

_Note: [vim-bbye](https://github.com/moll/vim-bbye) allows to consistenly wipe

buffers without impacting the windows order. Even though a fallback is present

in vim-symlink (hence avoiding a required dependency), the vim-bbye

implementation is more robust and I advise you to leverage it._

## Usage

Read more about the usage in [the documentation](./doc/symlink.txt).