Форма авторизации

Todo v0.8.2

Mikael Jorhult
Todo v0.8.2
Расширение Brackets, которое отображает все комментарии TODO в текущем документе и проекте.



Применение
Расширение можно активировать, перейдя в меню «Вид» и нажав «TODO», с помощью клавиши CTRL / CMD + ALT + T или щелкнув значок на панели инструментов. В нижней части окна Brackets будет отображаться панель с отображением всех комментариев TODO в документе.

Нажав на один из комментариев в списке, вы переместите курсор в эту точку в документе.

Синтаксис комментария
TODO по умолчанию распознает комментарии в C-style, используя теги TODO, NOTE, FIXME, CHANGES или FUTURE, как показано на скришотах.

Обратите внимание, что многострочные комментарии не будут работать. Функция TODO вернет только первую строку комментария.

// TODO: Это комментарий.

/ * ПРИМЕЧАНИЕ Двоеточие после тега является необязательным. * /

/ * @NOTE Предшествующее знаку также необязательно. * /

Отметить задачи как выполненные
Чтобы отслеживать прогресс вашей команды, вы можете отметить задачи как выполненные. Это достигается добавлением [x] перед текстом задачи.

// TODO: [x] Эта задача выполнена.

Задачи могут быть отсортированы так, чтобы сделанные задачи перемещались в конец списка, проверяя этот параметр в диалоговом окне настроек.

Пользовательские настройки
Настройки расширения можно переопределить, добавив файл .todo в папку проекта. Это простой JSON, который переопределяет настройки по умолчанию.

Пользовательские настройки позволят вам настроить теги, которые будут использоваться, или стиль комментариев, который вы хотите использовать. Это позволит вам использовать расширение с другими синтаксисами комментариев, включая такие стандарты, как JSDoc и phpDoc, или принести свои собственные в виде простых комментариев на выбранном вами языке. На скриншотах приведены параметры альтернативных синтаксисов для некоторых общих стандартов.

Обратите внимание, что обратные косые черты в регулярных выражениях должны быть экранированы сами собой, поскольку они сначала сохраняются в строках JavaScript перед анализом в качестве регулярных выражений.

Это настройки по умолчанию, так как они установлены в файле .todo.
Код
{
  "regex": {
  "prefix": "(?:\\/\\*|\\/\\/|#) *@?(",
  "suffix": "):? *(.*?) ?(?=\\*/|\\n|$)"
  },
  "tags": [
  "TODO",
  "NOTE",
  "FIX ?ME",
  "CHANGES",
  "FUTURE"
  ],
  "case": false,
  "search": {
  "scope": "current",
  "excludeFolders": [],
  "excludeFiles": []
  }
}


Область поиска
По умолчанию TODO просматривает открытый документ для комментариев. Это хорошо для небольших проектов, но для более крупных проектов вы можете следить за ходом выполнения всех частей проекта. Это делается путем изменения области поиска для проекта вместо текущего.
Код
{
  "search": {
  "scope": "project"
  }
}


Синтаксис комментария
Добавляя префикс и суффикс, TODO может распознавать комментарии в других форматах и языках. Примеры ниже описывают некоторые распространенные форматы.
jsDoc / phpDoc Syntax
Код
{
  "regex": {
  "prefix": "(?:\\* *@*)(",
  "suffix": "):? *(.*?) ?(?=\\n)"
  }
}


Синтаксис комментария HTML
Код
{
  "regex": {
  "prefix": "(?:<!--) *(",
  "suffix": "):? *(.*?) ?(?=-->)"
  }
}


Цвета тегов
Каждый из тегов по умолчанию имеет свой цвет, но их можно переопределить, используя диалог настроек или файл .todo. Это делается либо путем определения тега в виде строки, разделения имени тега и цвета на символ двоеточия, либо путем определения тега как объекта с именем и свойством цвета.
Код
{
  "tags": [
  "TODO:#d95",
  { "name": "NOTE", "color": "#696" }
  ]
}


Исключение файлов и папок
Файлы и папки могут исключаться из поиска, определяя свойства excludeFolders и excludeFiles в объекте поиска. Они должны быть массивом строк, содержащих полные или частичные имена файлов или папок, которые должны быть исключены.
Обратите внимание, что исключение будет работать только с областью поиска по всему проекту.

Исключить файлы SCSS
Код
{
  "search": {
  "scope": "project",
  "excludeFiles": [ ".scss" ]
  }
}


Исключить файлы с именами, содержащими индекс слова
Код
{
  "search": {
  "scope": "project",
  "excludeFiles": [ "index" ]
  }
}


Исключить все папки
Код
{
  "search": {
  "scope": "project",
  "excludeFolders": [ "vendor" ]
  }
}


Исключить только корневую папку
Код
{
  "search": {
  "scope": "project",
  "excludeFolders": [ "/vendor" ]
  }
}


GitHub упоминание и проблемы
Указав в своем проекте пользователя GitHub и репозиторий, TODO автоматически распознает и свяжет упоминания и проблемы в GitHub, используя символы @ и #.
Код
{
  "github": {
  "user": "mikaeljorhult",
  "repository": "brackets-todo"
  }
}


Рекомендации
Рекомендуем после установки расширения, проверить его на обновление более новой версии при помощи МЕНЕДЖЕР РАСШИРЕНИЙ. Если расширение не имеет более нового обновления, значит вы используете последнюю версию.
Установка
Способ 1:
1. Скачать архив расширения
2. Запустить редактор Brackets
3. Распаковать скачанный архив в папку /user/. Как найти папку /user/ ?
    В редакторе Brackets выбираем вкладку ПОМОЩЬ > ПОКАЗАТЬ ДИРЕКТОРИЮ РАСШИРЕНИЙ
4. Распаковываем.
5. После распаковки у вас появится новая папка с названием расширения в директории /user/.
6. Перезапускаем редактор Brackets
7. Радуемся установленному расширению.
Способ 2:
1. Запустить редактор Brackets
2. Переходим во вкладку ФАЙЛ > МЕНЕДЖЕР РАСШИРЕНИЙ
3. В появившемся окне, в поле ПОИСК вводим - Todo
4. Нажимаем УСТАНОВИТЬ.
5. Начнется загрузка и установка расширения.
6. По завершению установки, редактор Brackets перезапустится.
    Если этого не произошло - перезагружаем вручную.
7. Радуемся установленному расширению.
Комментарии к материалу
Всего комментариев: 0

avatar