A Sublime Text 2 plugin to extract and list TODO comments from open files and project folders.
Originally taken from https://github.com/robcowie/SublimeTODO and slightly customized.
Checkout from github and copy to proper Packages directory:
$ cd Sublime Text 2/Packages
$ git clone https://robcowie@github.com/robcowie/SublimeTODO.gitAll plugin configuration must be placed in user or project-specific settings inside a todo object, for example;
{
// other user config ...
"todo": {
"patterns": {}
}
}See an example user settings file here.
Extraction uses regular expressions that return one match group
representing the message. Default patterns are provided for BUG, TODO, NOTE, FIXME
and CHANGED comments.
Note that the pattern must provide at least one named group which will be used to group the comments in results.
By default, searching is case sensitive. You can change this behaviour by adding
"case_sensitive": false
to the todo settings object.
Global settings folder_exclude_patterns, file_exclude_patterns and binary_file_patterns are excluded from search results.
To exclude further directories, add directory names (not glob pattern or regexp) to folder_exclude_patterns in todo settings:
"todo": {
"folder_exclude_patterns": [
"vendor",
"tmp"
]
}To add file excludes, add glob patterns to file_exclude_patterns:
"file_exclude_patterns": [
"*.css"
]Override the results view title by setting result_title
"result_title": "TODO Results"Show TODOs: Project and open files scans all files in your project
Show TODOs: Open files only scans only open, saved files
Both are triggered from the command palette. No default key bindings are provided.
Results can be navigated by keyboard only:
next,previous,clear,enter
Note: mouse support was dropped in this fork.
All of SublimeTODO is licensed under the MIT license.
Copyright (c) 2012 Rob Cowie szaz@mac.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.