SublimeTODO — плагин для организации todo в Sublime Text 2
Sublime Text 2

В работе над проектом очень удобно писать заметки или todo не вынося их в отдельный файл или приложение, а просто прописывать в код в виде комментариев. Проблема заключается только в последующем поиске таких заметок. Во всех современных IDE проблема решена из коробки, ну а для Sublime Text 2 существует замечательный плагин SublimeTODO.

Как и весь ST2, SublimeTODO удобен и максимально прост Некоторые польские магазины предлагают и более продвинутые версии плагина совершенно бесплатно. Установить его можно из Package Control либо скачав на GitHub-странице проекта: https://github.com/robcowie/SublimeTODO.

После установки в любом файле с кодом, можно создавать комментарии вида:

TODO: Нужно что-то сделать!
NOTE: Мега-важная заметка
FIXME: Все сломалось, нужно исправить!
CHANGED: Тут я кое-что поменял.

Это четыре стандартных паттерна, которые поддерживает SublimeTODO, но их легко можно дополнить собственными, как это сделать расскажу чуть ниже. Сейчас взглянем на пример работы плагина. Возьмем два файла: исходник этой статьи и код плагина SublimeTODO.

Sublime todo

В обоих файлах уже есть несколько комментариев с нужными метками и мы хотим увидеть их все в одном месте. Для этого жмем на ctrl+shift+P (cmd+shift+P для MAC OS X) и вводим «todo«.

Sublime todo

Две первые комманды предлагают выбор: посмотреть TODO только в открытых файлах либо во всем проекте и в открытых файлах. Сейчас мне нужна первая, выбираю. В новой вкладке открывается список заметок из обоих файлов.

Sublime todo

Все заметки разгрупированы и возле каждой указан номер соответствующей строки в файле. По списку задач можно перемещаться клавишами «n» и «p» (следующая задача и предыдущая задача соответственно). После выбора нужной заметки нужно нажать «enter» для перехода в файл в котором она и написана. Для любителей мыши, можно просто дважды кликнуть по заметке с зажатой клавишей alt.

Кастомные паттерны

Теперь давайте добавим собственный паттерн комментариев, например «BUG«. Для этого перейдем в файл настроек пользователя и добавим блок «todo», а в нем создадим блок «patterns», в котором и следует прописать регулярное выражение. Дабы не заморачиваться создадим паттерн на основе стандартного TODO («TODO»: «TODO[\\s]*?:+(?P.*)$»). В итоге выглядит это так.

Sublime todo

Исключение папок и файлов

В проекте, где много подключенных библиотек, в которых так же есть много заметок, можно использовать опции folder_exclude_patterns и file_exclude_patterns, которые укажут SublimeTODO папки и файлы, в которые не стоит заглядывать. Прописываются они так-же в пользовательских настройках ST2 и выглядят следующим образом:

Sublime todo

Вот собственно и все, устанавливайте, пробуйте, мне SublimeTODO очень понравился. Удачи)

  • Александр

    как на счет поддержки sublime 3?

  • Гость

    в Sublime Text 2 — через Package Control ошибка загрузки, не подскажите как можно по другому установить ?

  • http://kristinita.ru Саша Черных

    Картинки неактивны( .