Skip to content

Latest commit

 

History

History
326 lines (225 loc) · 17 KB

readme.RU.md

File metadata and controls

326 lines (225 loc) · 17 KB
Raw

Taskbook

📓 Задачи, разделы и заметки для коммандной строки

Boards

Build Status

Описание

Используя простой и минимальный синтаксис, taskbook позволяет эффективно управлять задачами и заметками из разных разделов в терминале. Все данные атомарно записываются в хранилище для предотвращения повреждений и никому и никуда не передаются. Удаленные записи автоматически сохраняются в архиве и могут быть просмотрены, либо восстановлены в любой момент.

Можете прочитать этот документ на 简体中文, English, Français, Deutsch, Portuguese, 日本語, 한국어.

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

Присоединяйтесь к Gitter, или Twitter, чтобы поделиться своим мнением об этом проекте.

Особенности

  • Организация задач и заметок в разделах задач
  • Раздел задач и просмотр хронологии
  • Механизм для указания приоритетности и добавления в избранное
  • Поиск и фильтрация записей
  • Архивация и восстановление удаленных записей
  • Легкий и быстрый
  • Данные автоматически записываются в хранилище
  • Выбор места хранилища
  • Просмотр прогресса
  • Простое и минимальное использование синтаксиса
  • Уведомления об обновлениях
  • Конфигурируемый через ~/.taskbook.json
  • Данные хранятся в формате JSON в ~/.taskbook/storage

Просморите особенности в разделе taskbook.

Содержание

Установка

npm install --global taskbook

Использование

$ tb --help

  Использование
    $ tb [<options> ...]

    Опции
        none             Показать разделы
      --task, -t         Создать задачу
      --note, -n         Создать заметку
      --timeline, -i     Отобразить хронологию
      --delete, -d       Удаление записи
      --check, -c        Поставить/Отменить метку на задаче
      --star, -s         Добавить/Убрать запись в избранное
      --list, -l         Показать элементы списком по атрибутам
      --find, -f         Поиск по записям
      --edit, -e         Редактировать описание записи
      --move, -m         Переместить запись между разделами
      --priority, -p     Обновить приоритет задачи
      --archive, -a      Отобразить архивированные записи
      --restore, -r      Восстановить записи из архива
      --help, -h         Показать текст помощи
      --version, -v      Показать установленную версию

    Примеры
      $ tb
      $ tb --task Сделать сэндвич
      $ tb --task @кодинг Улучшить документацию
      $ tb --task @кодинг @обзоры Обзор PR #42
      $ tb --note @кодинг Mergesort худший случай O(nlogn)
      $ tb --check 1 2
      $ tb --delete 4
      $ tb --star 2
      $ tb --priority @3 2
      $ tb --timeline
      $ tb --edit @3 Merge PR #42
      $ tb --move @1 готовка
      $ tb --find документация
      $ tb --list pending кодинг
      $ tb --archive
      $ tb --restore 4

Обзоры

Обзор раздела

Запуск taskbook без каких-либо опций покажет все сохраненные записи, сгрупированные по их соответвующим разделам.

Boards

Обзор хронологии

Для просмотра всех записей в хронологическом порядке (по дате создания), может быть использована опция --timeline/-i.

Timeline View

Конфигурация

Для настройки taskbook, откройте файл ~/.taskbook.json и измените любые опции под себя. Для восстановления настроек по умолчанию, просто удалите конфигурацинный файл в домашней директории.

Ниже показаны все доступные опции и их соответвствующие значения по умолчанию.

{
  "taskbookDirectory": "",
  "displayCompleteTasks": true,
  "displayProgressOverview": true
}

Детально

taskbookDirectory
  • Тип: String
  • По умолчанию: ~

Полный системный путь, где хранилище будет создано и т.д; /home/username/the-cloud

Если оставите неопределенным, домашний каталог ~ будет использован и taskbook будет настроен внутри ~/.taskbook/.

displayCompleteTasks
  • Тип: Boolean
  • По умолчанию: true

Показ задач, которые завершены

displayProgressOverview
  • Тип: Boolean
  • По умолчанию: true

Показ прогресса ниже хронологии и обзора разделов.

Руководство по полетам

Ниже приведено небольшое руководство с примерами по использованию taskbook. В случае, если вы обнаружили ошибку или считаете, что пример недостаточно понятен и может быть объяснен лучше, не стесняйтесь заводить issue, либо pull request.

Создать задачу

Для создания новой задачи используйте опцию --task/-t следуя с описанием вашей задачи.

$ tb -t Улучшить документацию

Создать заметку

Для создания новой заметки используйте опцию --note/-n с последующим описанием вашей заметки.

$ tb -n Mergesort худший случай O(nlogn)

Создать раздел

Разделы создаются автоматически при создании новой задачи, либо новой заметки. Для создания одного и более разделов, укажите их названия с префиксом @ в описании записей, которые создаются. В конечном результате, новая запись будет создана во всех указанных разделах. Все записи, у которых не указан раздел, автоматически добавляются в раздел по умолчанию; My Board.

$ tb -t @кодинг @доки Обновление руководста по контрибуции

Пометить задачу

Чтобы пометить задачу как выполненная/невыполненная, используйте опцию --check/-c c последующими id ваших задач. Заметьте, что данная опция обновит статус complete задач на противоположный, поэтому пометка завершенной задачи будет отображатся как в процессе, а та задача, которая в процессе на завершенную. Дублирующиеся id автоматически отфильтровываются.

$ tb -c 1 3

Добавить запись в избранные

Чтобы отметить одну и более задачи, как избранные, используйте опцию --star/-s с последующими id выбранных записей. Функциональность данной опции такая же, как у опции --check описаной выше.

$ tb -s 1 2 3

Отображение разделов

Запуск taskbook без опций отобразит все сохраненные записи, сгруппированные по разделам.

$ tb

Отображение хронологии

Для отображения всех записей в хронологическом порядке, основанное на дате создания, может быть использована опция --timeline/-i.

$ tb -i

Назначение приоритета

Чтобы назначить приоритет для задачи по время создания, добавьте синтакс p:xв описании задачи, где x может быть числом 1, 2 или 3. Заметьте, что все задачи по умолчанию создаются с нормальным приоритетом - 1.

  • 1 - Нормальный приоритет
  • 2 - Средний приоритет
  • 3 - Высокий приоритет
$ tb -t @кодинг Исправить проблему `#42` p:3

Чтобы обновить приоритет определенной задачи после создания, используйте опцию --priority/-p вместе с id задачи c префиком @ и числом 1, 2 или 3. Заметьте, что порядок указания id задачи и приоритета не важен.

$ tb -p @1 2

Перемещение записи

Для того, чтобы переместить записи в один или более разделов, необходимо использовать опцию --move/-m , с последующим id записи с префиксом @ и названием разделов, в которые вы хотите ее перенести. Раздел по умолчанию My board обозначается с помощью ключевого слова myboard. Порядок указания id задачи и названия разделов в команде не важен.

$ tb -m @1 myboard отзывы

Удаление записи

Для удаления одной и более записей используйте опцию --delete/-d с последующим id записей. Заметьте, что удаленные записи автоматически архивируются и могут быть просмотрены, либо восстановлены в любой момент. Дублирующиеся id автоматически отфильтровываются.

$ tb -d 1 2

Отображение архива

Для отображения архивированных записей используйте опцию --archive/-a. Заметьте, что все архивированные записи будут отображаться в хронологическом порядке по дате создания.

$ tb -a

Восстановление записей

Для восстановления одной и более записей используйте опцию --restore/-r с последующим id записей. Заметьте, что id архивированных записей могут быть получены при запуске с опцией --archive/-a. Дублирующиеся id автоматически отфильтровываются.

$ tb -r 1 2

Вывести записи списком

Чтобы вывести группу записей списком, где каждая запись соответствует указанным атрибутам, используйте опцию --list/-l вместе с необходимыми атрибутами. Названия разделов вместе со статусом записи могут использоваться в качестве атрибутов. Для примера отображения записей списком, которые относятся к разделу по умолчанию myboard и имеют статус pending (в ожидании), следующая команда может быть использована;

$ tb -l myboard pending

Ниже приведены поддерживаемые по-умолчанию атрибуты списка вместе с их псевдонимами;

  • myboard - Записи, которые принадлежат разделу My board
  • task, tasks, todo - Записи, которые являются задачами.
  • note, notes - Записи, которые являются заметками.
  • pending, unchecked, incomplete - Записи, которые находятся в ожидании.
  • done, checked, complete - Записи, которые являются завершенными.
  • star, starred - Записи, добавленные в избранные.

Поиск записей

Для поиска одной и более записей используйте опцию --find/-f, с последующим словом для поиска.

$ tb -f документация

Разработка

Для большей информации о том, как можно способствовать этому проекту, пожалуйста, прочитайте contributing guidelines.

  • Форкните данный репозиторий и склонируйте на вашу машину
  • Перейдите в ваш склонированный проект: cd taskbook
  • Установите зависимости проекта: npm install либо yarn install
  • Проверьте код на ошибки: npm test либо yarn test

Относится

  • chalk - Стилизация строк в терминале
  • signale - Автономный консольный логгер

Команда

Лицензия

MIT