Skip to content

Latest commit

 

History

History
106 lines (79 loc) · 4.28 KB

readme.md

File metadata and controls

106 lines (79 loc) · 4.28 KB

projectile.nvim

License GitHub issues Python Version

mission-control

Features

  • Projects
    • Keep a list of projects
    • Access the root directory of a project with a customizable action
    • Check version control status for all added projects
    • List todos in a project directory
  • Bookmarks
    • Keep a list of bookmarked locations
  • TODOs
    • List todos in the current project folder & jump to them
    • List todos from a global or project todo.txt file
    • Append todos to the quickfix list
    • Syntax highlighting & filetype detection for todo.txt files
  • Sweet sweet Denite sources:
    • projectile - Source for projectile projects
    • bookmark - Source for projectile bookmarks
    • todo - Source for finding TODOs, FIXMEs, ANYTHINGs
    • todotxt - Source for $TODO_FILE
    • todotxt_local - Source for any todo.txt file
    • sauce - Source for Denite sources

Requirements

Installation

  • Install with your favorite plugin manager.
  • See the documentation if you have trouble.

Configuration

  • By default, data is saved in $XDG_CACHE_HOME/projectile or ~/.cache/projectile/.
  • If you'd like it elsewhere, you can set an alternate path in one of two ways:
    • g:projectile#data_dir = '<wherever>'
    • call denite#custom#var('projectile', 'data_dir', '<wherever>')
  • Check out the documentation.

Denite Sources

projectile

project_source

bookmark

bookmark_source

todo

todo_source

todotxt

todotxt_source

todotxt_local

todotxt_local_source

Issues

If you run into any bugs or if you have a feature request, feel free to open an issue

Credit & Thanks

Related Projects

  • projectile
    • Projectile is a project interaction library for Emacs.
  • vim-rooter
    • Rooter changes the working directory to the project root when you open a file or directory.
  • vim-projectionist
    • Projectionist provides granular project configuration using "projections".
  • vim-bookmarks
    • This vim plugin allows toggling bookmarks per line.
  • TaskList.vim
    • Script based on the eclipse Task List.
  • searchtasks.vim
    • Plugin to search the labels often used as TODO, FIXME and XXX.
  • gather-todo.txt-vim
    • Gather contents of todo.txt files from a directory tree to display a kind of agenda view in a scratch buffer.
  • todolist.vim
  • vim-todo