Skip to content

Rics-Dev/project-explorer.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Project Explorer for neovim

Simple project manager and explorer for neovim

Screenshot

Features

  • List Projects based of pattern
  • Create new projects directory
  • Add projects to favorites
  • List favorites projects only

Installation

  • Lazy.nvim
return {
  "Rics-Dev/project-explorer.nvim",
  dependencies = {
    "nvim-telescope/telescope.nvim",
  },
  opts = {
    paths = { "~/dev/*" }, --custom path set by user
    -- custom find command set by the user. Default should always work on unix unless user has heavily modified tools and/or PATH
    -- for Windows Users: installing `fd` is recommended with the equivalent `fd` command
    -- "fd . %s -td --min-depth %d --max-depth %d"
    command_pattern = "find %s -mindepth %d -maxdepth %d -type d -not -name '.git'",
    newProjectPath = "~/dev/", --custom path for new projects
    file_explorer = function(dir) --custom file explorer set by user
      vim.cmd("Neotree close")
      vim.cmd("Neotree " .. dir)
    end,
    -- Or for oil.nvim:
    -- file_explorer = function(dir)
    --   require("oil").open(dir)
    -- end,
  },
  config = function(_, opts)
    require("project_explorer").setup(opts)
  end,
  keys = {
    { "<leader>fp", "<cmd>ProjectExplorer<cr>", desc = "Project Explorer" },
  },
  lazy = false,
}

Optional dependencies

fd - Install fd from sharkdp

How to use

Default keybinding is <leader>fp to open the project explorer you can also open it by executing :ProjectExplorer

  • To cd into a project just press Enter on the selected project.
  • To Add a project use <C-a>.
  • To add a project to favorite projects use <C-A-f>
  • To display favorite projects only use <C-f>.

About

A simple project explorer plugin for neovim

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages