Giter Club home page Giter Club logo

tasklist.nvim's Introduction

Tasklist.nvim

A floating window plugin for easy access to todos and other notes

The todos for a project...

project todos

... are separate from the "global" todos. The todo's that can't be associated with a single project.

global todos

If the directory that you open neovim from is a part of a git repo, the todos will be associated with the repo. Otherwise, the todos are associated with the directory you're in.

๐Ÿ“ฆ Installation

Install the plugin with your preferred package manager:

-- Lua
return {
  "rrossmiller/tasklist.nvim",
  config = function(opts)
    local todo = require("tasklist")
    vim.keymap.set("n", "<leader>tt", function() todo.toggle_window() end, { desc = 'Open global TODOs window' })
    vim.keymap.set("n", "<leader>tp", function() todo.toggle_proj_window() end, { desc = 'Open project TODOs window' })
    todo.setup()
  end
},

โš™๏ธ Configuration

Tasklist comes with the following defaults:

{
    dir = vim.fn.expand(vim.fn.stdpath("state") .. "/todos/"), -- directory where todo files are saved. ~/.local/store/nvim/todos/
    style = '', -- neovim supports blank, or simple
    border = 'rounded', -- nvim allows these: https://neovim.io/doc/user/api.html#api-win_config:~:text=%27winhighlight%27.-,border
}

๐Ÿ› ๏ธ Roadmap

  • read and write todos in buffer from/to a file
  • project/repo-level vs global todo
  • sync the instances/open windows (rpc)
    • update the window whenever any todo window/file was updated
    • only update the window if the underlying file was updated
  • fancy icons marking doneness?
    • change a prefix of a line to mean that the todo is done and the style of the line should change to reflect that

tasklist.nvim's People

Contributors

rrossmiller avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.