Skip to content

Latest commit

 

History

History
97 lines (74 loc) · 3.9 KB

README.md

File metadata and controls

97 lines (74 loc) · 3.9 KB
Raw

VSC Todo+

Logo

Manage todo lists with ease. Powerful, easy to use and customizable.

Features

  • Easy to use: you're just a few shortcuts away from becoming a master
  • Portable: being a plain text format you can read and edit it using any editor
  • Custom symbols: you can replace the default symbols with any of the supported ones
    • Box: - ❍ ❑ ■ ⬜ □ ☐ ▪ ▫ – — ≡ → › [ ]
    • Done: ✔ ✓ ☑ + [x] [X] [+]
    • Cancel: ✘ x X [-]
  • Code blocks: you can define code blocks by wrapping them in backticks (`)
  • Custom colors: all colors can be customized
  • Custom special tags: special tags' names and their colors can be customized
  • Timekeeping: you can mark todos as started and track elapsed time until completion
  • Archive: you can move completed todos to a special "Archive" section with a shortcut

Install

Run the following in the command palette:

ext install vscode-todo-plus

Usage

It adds 6 commands to the command palette:

'Todo: Open' // Open or create your project's todo file
'Todo: Start' // Mark a todo as started
'Todo: Toggle Box' // Toggle todo's box symbol
'Todo: Toggle Cancel' // Toggle todo's done symbol
'Todo: Toggle Done' // Toggle todo's cancel symbol
'Todo: Archive' // Archive completed todos

It adds 5 shortcuts when editing a Todo file:

'Cmd/Ctrl+Shift+A' // Triggers  `Todo: Archive`
'Cmd/Ctrl+Enter' // Triggers `Todo: Toggle Box`
'Alt+D' // Triggers `Todo: Toggle Done`
'Alt+C' // Triggers `Todo: Toggle Cancel`
'Alt+S' // Triggers `Todo: Start`

Settings

{
  "todo.file": "TODO", // Todo file name
  "todo.defaultContent": "\nTodo:\n  ☐ Item\n", // New todo files default content
  "todo.indentation": "  ", // String used for indentation
  "todo.symbols.box": "☐", // Box symbol
  "todo.symbols.done": "✔", // Done symbol
  "todo.symbols.cancel": "✘", // Cancel symbol
  "todo.colors.cancel": "#f92672", // Cancelled todo color
  "todo.colors.done": "#a6e22e", // Done todo color
  "todo.colors.code": "#fd971f", // Code color
  "todo.colors.comment": "#75715e", // Comment color
  "todo.colors.project": "#66d9ef", // Project color
  "todo.colors.tag": "#e6db74", // Tag color
  "todo.tags.names": ["critical", "high", "low", "today"], // Special tags' names
  "todo.tags.backgroundColors": ["#e54545", "#e59f45", "#e5d145", "#ae81ff"], // Special tags' background colors
  "todo.tags.foregroundColors": ["#000000", "#000000", "#000000", "#000000"], // Special tags' foreground colors
  "todo.formatting.enabled": true, // Enable markdown-like formatting
  "todo.timekeeping.started.format": "YY-MM-DD HH:mm", // Format used for displaying time inside @started
  "todo.timekeeping.finished.enabled": true, // Enable the @done/cancelled tag. It's always enabled if you explicitly start a todo
  "todo.timekeeping.finished.format": "YY-MM-DD HH:mm", // Format used for displaying time inside @done/cancelled
  "todo.timekeeping.elapsed.enabled": true, // Enable the @lasted/wasted tag
  "todo.archive.name": "Archive" // Name of the special "Archive" section
}

Dates are formatted using moment.

Demo

Demo

Related:

  • Projects+ Todo+: Bird's-eye view over your projects, view all your todo files aggregated into one.

  • Noty: Autosaving sticky note with support for multiple notes, find/replace, programmers shortcuts and more. It implements a subset of the functionalities provided by this extension.

License

MIT © Fabio Spampinato