Quem está acostumado a trabalhar com Ruby on Rails sabe que não é comum deixarmos comentários no meio do código. Mas se você gosta de fazer comentários para se lembrar de fazer algumas tarefas no futuro, talvez o rails notes possa te ajudar.
O Rails vem como uma funcionalidade muito simples que varre seu código buscando comentários que começam com palavras chaves específicas e te mostra uma lista contendo o texto do comentário e arquivo em que ele se encontra. Se tivermos os seguintes comentários nos arquivos product_prices_controller.rb e rental_prices_controller.rb, por exemplo:
# FIXME No index valores devem ser apresentados com formato R$ 00,00.
# TODO Separar action create de RentalPrices em um service.
No terminal, o comando rails notes retornará:
$ rails notes
app/controllers/product_prices_controller.rb:
* [ 7] [FIXME] No index valores devem ser apresentados com formato R$ 00,00.
app/controllers/rental_prices_controller.rb:
* [18] [TODO] Separar action create de RentalPrices em um service.
Também é possível procurar por uma das palavras chave apenas. Para buscar somente as anotações com o termo TODO, por exemplo, você pode usar o seguinte comando:
$ bin/rails notes:todo
O rails notes busca por padrão as palavras chave FIXME, TODO e OPTIMIZE, mas você também pode definir as suas. Você pode saber mais sobre essa função na documentação oficial.
Referências
- https://guides.rubyonrails.org/command_line.html#rails-notes
- https://www.agiratech.com/rails-commands/#10_Notes
