https://github.com/jdkato/todoview

A Sublime Text 3 package to manage TODO-like comments.
https://github.com/jdkato/todoview

sublime-text-3 todo

Last synced: 7 days ago
JSON representation

A Sublime Text 3 package to manage TODO-like comments.

• Host: GitHub
• URL: https://github.com/jdkato/todoview
• Owner: jdkato
• License: mit
• Created: 2017-07-25T01:21:16.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-26T02:13:36.000Z (over 7 years ago)
• Last Synced: 2024-11-24T02:42:16.542Z (2 months ago)
• Topics: sublime-text-3, todo
• Language: Python
• Homepage:
• Size: 21.5 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TODOView



  



TODOView offers an easy way to search for and navigate to TODO-like comments in your codebase. Navigation is controlled by *query strings*, which are sudmitted via the Command Palette entry `TODOView: Search`. 

A query string has the following structure:

```text

scope:type(s):assignee(s)

```

where

- `scope` may be one of "(f)ile" (the active view only), "(o)pen" (all open views), or "\*" (any non-excluded file in the sidebar);

- `type(s)` is a comma-separated list of annotations to be included in the search (or "\*" to search for all `targets`, as listed in the [settings file](https://github.com/jdkato/TODOView/blob/master/TODOView.sublime-settings)); and

- `assignee(s)` is a comma-separated list of [Google-style](https://google.github.io/styleguide/pyguide.html#TODO_Comments) identifiers (or "\*" to include all identifiers in the search).

If we wanted to search for all TODOs or NOTEs assigned to `jdkato` in our currently open files, we'd use:

```text

open:TODO,NOTE:jdkato

```

A special case is the empty string, which is treated as `*:*:*`.

## Installation