Using fzf to fuzzy-find OpenFOAM features

FOAM fuzzy finder.md

Fuzzy finding 'FOAM features

Accompanies OnCFD Newsletter #173

A couple of code snippets that use fzf to mine your install & extract the answers to everyday OpenFOAM questions, like...

• How do I use a particular feature?
• What does so-and-so dictionary look like?
• Does this need a semi-colon? 🤦‍♂️

It looks like this...

Here are the code snippets...

fzf + grep + less version

grep \
--line-buffered --line-number --color=never \
--recursive --binary-files=without-match '' $FOAM_TUTORIALS |
fzf \
--delimiter : \
--preview 'less {1}' \
--preview-window 'up,75%,border,+{2}/3'

fzf + ripgrep + bat version

rg \
--color=always --line-number --no-heading \
--smart-case '' $FOAM_TUTORIALS |
fzf --ansi \
--color 'hl:-1:underline,hl+:-1:underline:reverse' \
--delimiter : \
--preview 'bat -lcpp --color=always {1} --highlight-line {2}' \
--preview-window 'up,75%,border,+{2}+3/3,~3'

That should save you some typing, but make sure you check out the original article for more info 👋

Hey @robinknowles thanks for this great tool!
I have a question if I may,
I did some aliases (also discovered that if you do aliases instead of funciton as you posted it goes way faster! not sure why), in any case...
sometimes my fuzzy searchs are too much fuzzy any ideas how I would make it less fuzzy?
one example:

here I am looking for the swarmcorrection and it arrives to make the word from the path of the file lol.
the alias I am using is:
alias ftut="rg --color=always --line-number --no-heading --smart-case '' $FOAM_TUTORIALS | fzf --ansi --color 'hl:-1:underline,hl+:-1:underline:reverse' --delimiter : --preview 'batcat -lcpp --color=always {1} --highlight-line {2}' --preview-window 'up,75%,border,+{2}+3/3,~3' | sed 's/:.*//'"

Hi @otaolafranc - I'm glad you're getting some use out of it.

Unfortunately, when I try your command on my machine I get the expected behaviour i.e. it pulls up a bunch of phaseProperties files in twoPhaseEulerFoam etc 🤔

That's with rg = 14.1.0 , fzf = 0.44.1 & bat = 0.24.0 in an Ubuntu Docker container.

Not sure if it's a version thing or an operating system thing.

fzf has options to tweak how it matches, but they aren't something I've played with.

Hope you can get it working how you need 🤞

I have the 'good' matches but also when i go up even more on the list i beging getting some matches such as the one showed there...
for the corresponding versions I am rg=14.1.0 fzf=0.57.0 and bat=0.24.0. strange... will have a look at the link, but as it is a pipe of so many things I am a little bit lost lol.
thanks in any case!