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

Todo v0.6.0

Mikael Jorhult
Todo v0.6.0
Расширение для Brackets/Edge Code, которое отображает все комментарии TODO в текущем документе или проекте.



Использование
Расширение может быть активировано путем перехода к меню Вид и нажать на Todo, с использованием горячих клавиш нажмите команду CTRL + ALT + T (для WIN) / CMD + ALT + T (для MAC) или, нажмите на значок в панели инструментов.
Панель будет отображаться в нижней части окна Brackets где будут отображаются все комментарии TODO в рамках документа в списке.

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

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

                                                                                               

Пожалуйста, обратите внимание, что многострочные комментарии не будут работать. Todo будет возвращать только первую строку комментария.
 
Комментарии


// TODO: This is a comment.

/* NOTE The colon after the tag is optional. */

/* @NOTE Preceding at sign is also optional. */

# NOTE: This is a comment as well.


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

// TODO: [x]This task is done.


Пользовательские настройки
Настройки расширений можно переопределить, добавив файл .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"
    }
}

 

Комментарий Syntax
Добавляя префикс и суффикс Todo может распознать комментарии в других форматах и языков. Примеры ниже рассматриваются некоторые распространенные форматы.

jsDoc / phpDoc Syntax 
Code


{
    "regex": {
        "prefix": "(?:\\* *@*)(",
        "suffix": "):? *(.*?) ?(?=\\n)"
    }
}


HTML Comment Syntax 
Code


{
    "regex": {
        "prefix": "(?:<!--) *(",
        "suffix": "):? *(.*?) ?(?=-->)"
    }
}


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

Пожалуйста, обратите внимание, что исключение будет работать только с проектами широкого области поиска.

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


{
    "search": {
        "scope": "project",
        "excludeFiles": [ ".scss" ]
    }
}


 
Исключить файлы с именами, содержащими слова index 
Code


{
    "search": {
        "scope": "project",
        "excludeFiles": [ "index" ]
    }
}

 

Исключить все папки
Code


{
    "search": {
        "scope": "project",
        "excludeFolders": [ "vendor" ]
    }
}


Исключить только корневую папку

Code


{
    "search": {
        "scope": "project",
        "excludeFolders": [ "/vendor" ]
    }
}

 



Рекомендации
Рекомендуем после установки расширения, проверить его на обновление более новой версии при помощи МЕНЕДЖЕР РАСШИРЕНИЙ. Если расширение не имеет более нового обновления, значит вы используете последнюю версию.
Установка
Способ 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