https://github.com/zimeg/proximity.nvim

find the nearest matching file fast
https://github.com/zimeg/proximity.nvim

neovim

Last synced: 21 days ago
JSON representation

find the nearest matching file fast

• Host: GitHub
• URL: https://github.com/zimeg/proximity.nvim
• Owner: zimeg
• License: mit
• Created: 2024-06-30T04:43:14.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-04T07:12:25.000Z (4 months ago)
• Last Synced: 2024-08-04T08:23:24.338Z (4 months ago)
• Topics: neovim
• Language: Lua
• Homepage:
• Size: 12.7 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# proximity.nvim

Jump to the nearest upward matching file in one fast motion. Helpful when

navigating to known places from the depts of a project. Better when followed

with `` for fast returns.

Install this plugin using a plugin manager of choice then `setup` the plugin:

```lua

local proximity = require("proximity")

proximity.setup({

	targets = {

		["pc"] = { "CHANGELOG.md" },

		["pr"] = { "README.md" },

	},

})

```

The above `setup` options show placeholder values and can be forgone if no other

`targets` are used.

## Customizations

Different configurations can find certain files in some other common situations.

### Adjacent files

Search for files in related directories on the quest upwards:

```lua

proximity.setup({

	targets = {

		["pm"] = { ".github/MAINTAINERS_GUIDE.md" },

	},

})

```

### Multiple matches

Attempt to find different files using the same motion:

```lua

proximity.setup({

	targets = {

		["pp"] = { "package.json", "pyproject.toml" },

	},

})

```