file-surfer.nvim

Find your most important files fast. 🏃‍♀️ 💨

⚡️ Features

⚡ Quickly find files in a predefined set of directories
- 📂 Define static paths
- 📦 Define dynamic paths to scan for directories with a certain depth and optionally only include directories with a .git folder
✨ Automatically change directory to the selected Folder
⌘ Create a user command to quickly open the finder
⛏️ Use FzfLua as the picker (Others to be added in the future)

☄ Usage

TODO

🏗️ Installation

---@module "lazy"
---@type LazyPluginSpec
return {
    "nikbrunner/file-surfer.nvim",
    dependencies = {
        "ibhagwan/fzf-lua" -- Required for the picker
    },
    event = "VeryLazy",
---@module "file-surfer"
---@type file-surfer.Config
    opts = {
        -- Example opts for paths. By default, there are no paths defined.
        paths = {
            static = {
                ["~/.scripts"] = vim.fn.expand("$HOME") .. "/.scripts",
            },
            dynamic = {
                {
                    -- For example add your project folder where you clone all your repos
                    path = vim.fn.expand("~/repos"),
                    scan_depth = 2,
                    use_git = true, -- Only include directories with a .git folder
                },
                {
                    -- Or add your config folder to quickly find your config files
                    path = vim.fn.expand("$XDG_CONFIG_HOME"),
                    scan_depth = 1,
                },
            },
        },
    },
    keys = {
        {
            "<leader>f",
            function()
                require("file-surfer").find()
            end,
            desc = "󱝆 Surf",
        },
    },
}

⚙ Configuration

Note: The options are also available in Neovim by calling :h file-surfer.options

https://github.com/nikbrunner/file-surfer.nvim/blob/main/lua/file-surfer/config.lua#L3-L31

⌨ Contributing

PRs and issues are always welcome. Make sure to provide as much context as possible when opening one.

make deps to install docs/tests dependencies
make lint to format the code
make documentation to generate the documentation
make test to run the tests

To run the linter you can use this.

lua-language-server --configpath .luarc.json --logpath luals-log --check .

🎭 Motivations

I often found myself wanting to quickly reference or look for snippets in other files from my projects, so I made this to enhance my workflow.

nikbrunner/file-surfer.nvim