https://github.com/valentin271/fp

A small project finder
https://github.com/valentin271/fp

cd project ratatui rust workspace

Last synced: 19 days ago
JSON representation

A small project finder

• Host: GitHub
• URL: https://github.com/valentin271/fp
• Owner: Valentin271
• License: mit
• Created: 2024-01-04T14:22:35.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-08-28T18:06:33.000Z (4 months ago)
• Last Synced: 2024-08-28T19:44:08.580Z (4 months ago)
• Topics: cd, project, ratatui, rust, workspace
• Language: Rust
• Homepage:
• Size: 154 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Find Project (`fp`)

A small utility to quickly change project directory on the command line.

It is heavily inspired by [telescope-project.nvim] (in fact it even uses the same fuzzy search algorithm) with my theme [vim-enfocado].

[telescope-project.nvim]: https://github.com/nvim-telescope/telescope-project.nvim

[vim-enfocado]: https://github.com/wuelnerdotexe/vim-enfocado

![`fp` screenshot](assets/demo.png)

# Why

I want:

- something **easy**, **fast**, and **no setup** (or as little as possible)

- something simple overall, meaning no SQL database or tracking project navigation ...

- to search through project, not through recent directories

- possibly a [telescope.nvim]-like interface

Most other project/workspace switcher do not meet that.

It's also a good excuse to use [ratatui](https://github.com/ratatui-org/ratatui/).

[telescope.nvim]: https://github.com/nvim-telescope/telescope.nvim

# Install

```sh

cargo install --git https://github.com/Valentin271/fp

echo "alias fp='cd \$(command fp)'" >> ~/.profile # or .bash_aliases or whatever else your shell uses

```

# Functioning

Currently `fp` searches for projects in `$HOME`, ignoring hidden directories and build/dependency

directories like `node_modules`, `target`, `cmake*` and more.

## Preview

File listing is similar to running:

```sh

ls -1 -A --group-directories-first

```

It also uses your `LS_COLORS`.

# TODO

In no particular order

- [ ] implement projects cache

- [ ] configurable search path

- [ ] display `filtered entries / total` just like telescope

- [ ] configurable whitelist

- [ ] configurable blacklist?