tips.txt

shows a random tip when you cd into a directory. pulls from tips.txt files and TODOs in your code.

💡 TODO: ./src/api.ts:42: // TODO: add rate limiting

install

oh-my-zsh:

git clone https://github.com/ejfox/tips.txt ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/tips.txt

add tips.txt to plugins in .zshrc

manual:

source ~/path/to/tips.txt.plugin.zsh

config

all optional. set in .zshrc before loading the plugin.

export TIPSTXT_SOURCES="tips todos"    # sources to use (space-separated)
export TIPSTXT_ICON="💡"               # prefix icon
export TIPSTXT_COLOR="90"              # ansi color (90=dim, 33=yellow, 32=green)
export TIPSTXT_TODO_EXTENSIONS="js,ts,py,rs,go"  # file types to scan for todos
export TIPSTXT_SHOW_ON_LOAD="false"    # disable tip on shell start

usage

drop a tips.txt in any project:

echo "run make test before committing" >> tips.txt

or just let it find your TODOs.

see tips.txt.example for ideas.

contributing

it's ~50 lines of zsh. add a source, tweak the colors, whatever. PRs welcome.

MIT license.