Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Добавить опцию вывода справки с учетом всех плагинов #270

Open
GladilovDmitry opened this issue Aug 26, 2021 · 5 comments

Comments

@GladilovDmitry
Copy link
Contributor

Существует проблема
Слабая справка по плагинам. По сути её нет. Есть лишь перечисление плагинов на github в readme, и перечисление плагинов по команде gitsync plugins list -a. Как использовать плагины и для чего - не ясно.
Команда gitsync sync --help помогает понять функционал плагина, но по умолчанию не выводит никакой информации по опциям команды sync при использовании плагинов. Требуется включить каждый плагин чтобы увидеть добавляемые им опции.

Хотелось бы иметь следующую функциональность
Опция --all-plugins к команде gitsync sync --help в виде gitsync sync --help --all-plugins выводит справку по всем опциям всех плагинов, не требуя предварительное подключение плагина.

Дополнительный контекст
Сравните

C:\Users\ERP-Test>gitsync sync --help
...
Опции:
  -u, --storage-user            пользователь хранилища конфигурации ...
  -p, --storage-pwd             пароль пользователя хранилища конфигурации ...
  -e, --ext, --extension        имя расширения для работы с хранилищем расширения...
Опции:
  -u, --storage-user            пользователь хранилища конфигурации ...
  -p, --storage-pwd             пароль пользователя хранилища конфигурации ...
  -e, --ext, --extension        имя расширения для работы с хранилищем расширения ...
  -l, --limit                   [*limit] выгрузить не более <Количества> версий от текущей выгруженной ...
      --minversion              [*limit] <номер> минимальной версии для выгрузки (по умолчанию 0)
      --maxversion              [*limit] <номер> максимальной версии для выгрузки (по умолчанию 0)
  -C, --error-comment           [*check-comments] флаг вызова ошибки при отсутствии текста комментария
      --task-prefix             [*check-comments] Префикс задачи. (env $GITSYNC_TASK_PREFIX)
      --min-task-count          [*check-comments] Минимальное количество упоминаний задач (по умолчанию 0)
      --max-task-count          [*check-comments] Максимальное количество упоминаний задач (по умолчанию 0)
  -S, --skip-exists-tags        [*smart-tags] флаг пропуска ошибок создания существующих тегов...
  -N, --numerator               [*smart-tags] флаг добавляет номер хранилища 1С как тег вида v.X
  -R, --rename-module           [*unpackForm] переименование module -> module.bsl ...
  -F, --rename-form             [*unpackForm] переименование form -> form.txt ...
  -P, --push                    [*sync-remote] Флаг отправки изменений на удаленный репозиторий...
  -G, --pull                    [*sync-remote] Флаг получения изменений из удаленный репозитория ...
  -T, --push-tags               [*sync-remote] Флаг отправки тегов по версиям ...
  -n, --push-n-commits          [*sync-remote] <число> количество коммитов до промежуточной ... 
  -P, --project-name            [*edtExport] Имя проекта (env $GITSYNC_PROJECT_NAME)
  -W, --workspace-location      [*edtExport] расположение рабочей области ...
  -B, --base-project-name       [*edtExport] имя базового проекта в рабочей области ...
@khorevaa
Copy link
Member

Так это есть? Справка по плагинам выводится если плагин подключен...

@GladilovDmitry
Copy link
Contributor Author

Для человека работающего с инструментом - да, "это же есть". Только про это нигде не сказано.
А для того кто первый раз вызвал gitsync sync --help, а потом установил плагин и по той же команде вызова справки получил новые записи в справке - это wtf.

@gygabites
Copy link

Похоже, проблема актуальна и по сей день.
Активировал плагин replace-authors, команда gitsync plugins ls -a возвращает такое описание:
[on] [1.6.0] - replace-authors - Плагин добавляет функциональность замены автора коммита

Команда gitsync plugins help replace-authors возвращает ошибку. Остается только смотреть справку в исходниках.

@EvilBeaver
Copy link
Member

Команда gitsync plugins help replace-authors возвращает ошибку. Остается только смотреть справку в исходниках.

Отличный повод починить эту ошибку и прислать исправление 😃

@nixel2007
Copy link
Member

gitsync sync --help все ещё должен вывести справку с учётом новых опций (если они есть)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants