Вам больше никогда не придется иметь дело с устаревшими комментариями TODO
Вы когда-нибудь замечали в своей кодовой базе устаревшие // TODO:
комментарии, на которые стоило бы обратить внимание давным-давно? 🤔
Ну а как же тогда:
// This will raise an error: // TODO: 2020-01-01: This is an expired TODO comment.
Выглядит потрясающе, да?
Давайте обсудим, как мы можем сделать что-то подобное.
Как дела?
Представляем eslint-plugin-no-expired-todo-comments
, удобный инструмент, который предотвращает загромождение вашего кода комментариями TODO с просроченными датами.
В этом сообщении блога мы рассмотрим установку, использование и преимущества использования этого крошечного плагина для поддержания более чистой кодовой базы.
Кстати, эта работа была вдохновлена parker-codes/todo-by @parker_codes, посмотрите и вы!
Что это такое?
eslint-plugin-no-expired-todo-comments
— это плагин ESLint, который предоставляет новое правило для обнаружения комментариев TODO с истекшим сроком действия. Этот плагин гарантирует, что в вашей кодовой базе нет устаревших комментариев TODO, помогая поддерживать чистоту и организованность кода.
Монтаж
Вы можете легко установить плагин, используя npm, yarn или pnpm, что бы вы ни использовали в основном, как показано ниже:
npm install eslint-plugin-no-expired-todo-comments --save-dev # or yarn add eslint-plugin-no-expired-todo-comments --dev # or pnpm add eslint-plugin-no-expired-todo-comments --save-dev
Применение
После того, как вы установили плагин, пришло время начать его использовать! Просто добавьте правило no-expired-todo-comments
в конфигурацию ESLint:
Теперь всякий раз, когда у вас есть комментарий TODO с истекшей датой в вашей кодовой базе, ESLint будет вызывать ошибку, предлагая вам решить ее, прежде чем двигаться дальше:
// This will raise an error: // TODO: 2020-01-01: This is an expired TODO comment.
Так просто!
Преимущества
Используя eslint-plugin-no-expired-todo-comments
, вы можете:
- Держите кодовую базу в чистоте и порядке, удаляя ненужные и устаревшие комментарии TODO.
- Убедитесь, что ваша команда остается в курсе задач, так как просроченные комментарии TODO теперь будут вызывать ошибки.
- Улучшайте качество кода, своевременно отвечая на комментарии TODO.
Содействие
Проект приветствует участие сообщества! Если вы столкнулись с какими-либо ошибками или проблемами, пожалуйста, откройте проблему на странице проекта GitHub. Если вы хотите внести свой код, создайте форк проекта и отправьте запрос на вытягивание со своими изменениями.
Заключение
Таким образом, приведенный выше плагин является полезным инструментом для поддержания чистой и организованной кодовой базы за счет предотвращения устаревших комментариев TODO. С этим плагином вам никогда не придется беспокоиться о том, что вы забудете или пренебрежете важными задачами, скрытыми в вашем коде.
И напоследок небольшая программная шутка в завершение:
Почему программисты всегда путают Рождество и Хэллоуин? 🎃 🎄
Потому что 31 октября == 25 декабря! 😂
Удачного кодирования, и пусть ваши комментарии TODO никогда больше не будут забыты! 😉
P.S.: Если вам понравился этот материал — вам может понравиться еще одна крутая вещь, которую я сделал недавно:
Кроме того, давайте общаться в Twitter! (@maxprilutskiy). 👈 😉
Первоначально опубликовано на https://dev.to 14 мая 2023 г.