https://github.com/AkashKarnatak/rooter.nvim

rooter.nvim is a neovim plugin written in lua to change current working directory to project's root directory.
https://github.com/AkashKarnatak/rooter.nvim

neovim neovim-plugin

Last synced: 3 months ago
JSON representation

rooter.nvim is a neovim plugin written in lua to change current working directory to project's root directory.

• Host: GitHub
• URL: https://github.com/AkashKarnatak/rooter.nvim
• Owner: AkashKarnatak
• License: mit
• Archived: true
• Created: 2021-05-17T18:02:46.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-06-08T14:11:35.000Z (over 2 years ago)
• Last Synced: 2024-05-11T01:31:01.975Z (6 months ago)
• Topics: neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 8.79 KB
• Stars: 43
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## NOTE: This repository is no longer maintained. Check out [project.nvim](https://github.com/ahmedkhalf/project.nvim)

## rooter.nvim

`rooter.nvim` changes current working directory to project root of the file opened in current buffer. It

identifies a directory as project root if it contains any of the file or folder specified

in `vim.g.rooter_pattern`. `rooter.nvim` triggers every time the buffer changes.

Although this plugin has been tested only on linux, but it should work for all Unix based OS.

## Customization

`rooter.nvim` provides you with two options.

| Options                | Description                                                                 | Type     |

|------------------------|-----------------------------------------------------------------------------|----------|

| `vim.g.rooter_pattern` | List of patterns(file or folder) which describes a directory as project root| list     |

| `vim.g.outermost_root` | Whether to change directory to outermost root directory or not              | boolean  |

Default configurations are 

```lua

vim.g.rooter_pattern = {'.git', 'Makefile', '_darcs', '.hg', '.bzr', '.svn', 'node_modules', 'CMakeLists.txt'} 

vim.g.outermost_root = true

```

## Updates

* Added support for `nvim-tree`.

## Bugs

Patterns like `*.sln` does not work as of now.