feat(cable): add pj channel for project directory finding

[josephschmitt]

📺 PR Description

Adds a new cable channel for pj, a fast project directory finder that searches your filesystem for project directories.

Works with monorepos by deeply looking for nested projects, too:

• Two source modes: default and --no-nested
• Preview using ls
• Actions: expand path, open in $EDITOR, connect to tmux session, open new tmux tab, clear cache
• Keybindings for all actions

Two of the actions require tmux to work. Given they’re optional and not the primary (nor even secondary) actions, I figured it was ok to not list tmux as a requirement. Let me know if you disagree.

Checklist

• my commits and PR title follow the conventional commits format
• if this is a new feature, I have added tests to consolidate the feature and prevent regressions
• if this is a bug fix, I have added a test that reproduces the bug (if applicable)
• I have added a reasonable amount of documentation to the code where appropriate

[josephschmitt]

I wanted to use the native {regex_replace} for the tilde expansion, but it doesn’t seem to be working, so I used sed instead. Opened an issue regarding regex_replace here: #900

[josephschmitt]

I wanted to use the native {regex_replace} for the tilde expansion, but it doesn’t seem to be working, so I used sed instead. Opened an issue regarding regex_replace here: #900

Turns out the docs were just outdated. However it also turns out that the replace syntax can't read the $HOME env var, so sed remains the best path forward here.

[alexpasmantier]

Cool!

A better solution in my opinion might be to make pj output resolved absolute paths by default (or behind a flag).

[josephschmitt]

Cool!

A better solution in my opinion might be to make pj output resolved absolute paths by default (or behind a flag).

@alexpasmantier so it does by default, the --shorten flag is what returns ~ instead of absolute paths.

What I was struggling to get working (which you can see via some of the issues I opened) is to get display to show colored ansi icons AND the shortened home directory but then output to display the fully resolved path.

At first I tried using plain pj --icons --ansi which would just give me the absolute paths. But when I used the display template syntax to then replace $HOME with ~, the ANSI coloring on the icons broke.

So what I ended up with instead was to have command use the results from pj --icons --ansi --shorten and then replace them in output since that does seem to work well with ANSI coloring.

I’m open to suggestions, I really would much rather do it how you said. But displaying tilde for the home directory instead of the full path is such a nicer UX and cleans up the list so much that this felt worth it

[josephschmitt]

@alexpasmantier Lmk if you have any other feedback or concerns, happy to address

[alexpasmantier]

Sorry for the delay, would you mind adding a small screenshot of the channel for the documentation? 😊

[josephschmitt]

@alexpasmantier I have a couple of screenshots in the PR. Should they go somewhere in the code itself? Is there an assets folder? Or maybe a command I can run to generate the docs for this? happy to add!