Skip to content

Latest commit

 

History

History
59 lines (46 loc) · 1.5 KB

README.md

File metadata and controls

59 lines (46 loc) · 1.5 KB

projection.nvim

Project management for neovim.

Quick guide

Install

" With Plug
Plug 'Diegovsky/projection.nvim'

Features

  • Basic project management
    • Add a new project
    • Remove a project
    • Go to project
    • Recently opened projects (should_sort=true)

Note: If you want vscode-like workspace local settings, consider also using direnv.

Setup

Add this to your neovim config file (init.lua):

-- To use the default settings
require'projection'.init()

init.vim:

" To use the default settings
lua require'projection'.init()

Possible settings

The function projection.init takes an optional table with the following keys:

Name Default Value Description
store_file $XDG_STATE_HOME/projects.json Where Projection.nvim will save your projects
should_sort false Whether Projection.nvim should sort the projects by most recent access
should_title true Whether Projection.nvim should change the terminal title to reflect currently opened project

How-to

local projection = require'projection'

-- Add a new project
projection.add_project()

-- Remove a project
projection.remove_project()

-- Go to a project
projection.goto_project()

-- Save the current project list to disk
-- You don't need to call this manually because it's called on vim exit.
projection.save_projects()