Что это?
Плагин для опасность-js. Это собирает все комментарии «TODO», представленные в запросе на тягу (PR) и публикуют их как комментарий к пр.
NPM JS — плагин опасности Тодос
Это довольно простой плагин, который просто сканирует ваш различие для сопоставления комментариев, он поддерживает различные комментарии к стилю языка, включая JS, C, C ++, Ruby, Java, Elm, HTML, Bash и т. Д. ( открыть вопрос Если что-то отсутствует). Вы также можете указать пользовательские ключевые слова, кроме «TODO» или «FIXME».
Как настроить?
- Настроить ОПАСНОСТЬ-JS и добавьте его в свою непрерывную интеграцию (CI) трубопровод
- Добавить Опасность-плагин-тодос на «Ограниченность», как упоминалось в Readme
В следующий раз ваш трубопровод CI работает для любого PR, этот плагин сканирует разницу, чтобы получить все TO-делать комментарии и опубликовать их через опасность в качестве комментариев на PR. Комментарий будет обновляться на последовательных прогонах.
Возможные рабочие процессы
Сценарий A:
Иногда, когда вы начинаете работать над функцией, которую вы видите вещи по тому, что нужно исправить, и вы в конечном итоге добавляете комментарий to-do или исправьте комментарий для них. Затем филиал объекта объединяется, и комментарии быстро забываются, если они не были связаны с частью кодовой базы, которая видит частые обновления.
Чтобы отслеживать такие дос, этот плагин можно использовать, так как список из них будет добавлен в качестве комментариев к пр. Этот список до DOS может затем перемещаться в новую проблему до объединения PR, и проблема добавлена в отставание.
Сценарий B:
Этот плагин также может быть использован для создания фактического автоматического обновления списка дел.
Просто добавьте все ваши задачи для PR в коде в качестве DOS и открыть работу в процессе (WIP) PR, это создаст список до DOS в PR комментариев.
Теперь, когда вы работаете над ними и удалите их, комментарий будет обновлен, и ваш список станет меньше. Как только вы закончите с ними, PR будет готов объединиться.
Больше возможностей входящих
Есть некоторые новые идеи, которые работают над ( Проверьте вопросы здесь ), как:
- Создайте ссылку для создания новой проблемы со списком To-DOS автоматически : Это было бы очень здорово для нашего сценария выше. Ссылка может быть настроена для поддержки разных трекеров выпуска
- Шоу завершено до DOS Следует отмечаться PRS, которые завершены и удаляют старые до DOS. Это будет добавить сообщение успеха на удалении старых до DOS.
В любом случае, я надеюсь, что это полезно для вас. Если у вас есть идеи о том, как сделать это лучше, чтобы освободить меня на Twitter Или открыть проблему на репо.
Оригинал: «https://dev.to/rohit_gohri/dangerjs-plugin-todos-3gk1»