Hace tiempo empece a utilizar una forma de organizar “notas” dentro del código, utilizando comentarios. Estos comentarios tienen que empezar con //
o #
y puede ser un TODO
para código que falta por implementar o agregar y FIX
o FIXME
para código que necesita arreglarse.
// TODO: add user authentication
// FIX: database connection
Existen plugins para algunos editores de texto para poder obtener una lista de este tipo de comentarios, ya que no son nuevos ni yo los he inventado, pero creo que me funciona más ver la lista dentro de la terminal, por lo tanto he creado un pequeño alias que a alguien más le puede servir:
alias todo="grep --color=always --exclude-dir={.git,node_modules,.next} -RIin -E '(//|#)\s?(TODO|FIXM?E?):?' . | sed -e 's/:[ \t]*/:/g'"
El alias utiliza grep
para buscar una expresión regular dentro del código con una lista de directorios excluidos y sed
para arreglar un poco el resultado, ya que los comentarios se pueden encontrar en cualquier parte del código y esto nos permite nomalizar un poco la lista y que se pueda apreciar mejor.