fzf-make

Crates.iofzf-make
lib.rsfzf-make
version
sourcesrc
created_at2023-10-07 16:18:53.149732+00
updated_at2025-01-25 10:19:08.921063+00
descriptionA command line tool that executes commands using fuzzy finder with preview window for make, pnpm, yarn and just.
homepage
repositoryhttps://github.com/kyu08/fzf-make
max_upload_size
id996461
Cargo.toml error:TOML parse error at line 30, column 1 | 30 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
kyu08 (kyu08)

documentation

README

fzf-make is a command line tool that executes commands using fuzzy finder with preview window. Currently supporting make, pnpm, yarn, just.

License:MIT Latest Release crates.io Crates.io Total Downloads

🛠️ Features

  • Select and execute a make target or (pnpm | yarn) scripts or just recipe using fuzzy-finder with a preview window by running fzf-make!
  • Execute the last executed command(By running fzf-make --repeat.)
  • Command history
  • Support make, pnpm, yarn, just. Scheduled to be developed: npm.
  • [make] Support include directive
  • [pnpm] Support workspace(collect scripts all of package.json in the directory where fzf-make is launched.)
  • [yarn] Support workspace(collect all scripts which is defined in workspaces field in root package.json.)
  • [just] Support execution inside of directory of justfile.
  • (Scheduled to be developed) Support config file

📦 Installation

macOS

Homebrew

# install
brew install fzf-make

# update 
brew upgrade fzf-make

Arch Linux

fzf-make can be installed from the AUR using an AUR helper. For example:

paru -S fzf-make

NixOS / Nix (package manager)

fzf-make can be run from the repository (latest version)

nix run github:kyu08/fzf-make

Or from the nixpkgs (channel >= 23.05)

nix run nixpkgs#fzf-make

Note You may need to enable experimental feature. In that case, execute the following command to enable them echo "experimental-features = nix-command flakes" | tee ~/.config/nix/nix.conf

OS-independent method

Cargo

cargo install --locked fzf-make
# Or build from HEAD
cargo install  --git  https://github.com/kyu08/fzf-make/

💡 Usage

Run target using fuzzy finder

  1. Execute fzf-make in the directory you want to run make target, or (pnpm | yarn) scripts or just recipe.
  2. Select command you want to execute. If you type some characters, the list will be filtered. demo demo

Run target from history

  1. Execute fzf-make in the directory you want to run make target, or (pnpm | yarn) scripts or just recipe.(For just, we support execution inside of directory of justfile.)
  2. Press Tab to move to the history pane.
  3. Select command you want to execute. demo

How fzf-make judges which command runner can be used

make

Whether makefile(file name should be one of GNUmakefile, makefile, Makefile) is in the current directory.

pnpm

Whether package.json and pnpm-lock.yaml are in the current directory.

yarn

Whether package.json and yarn.lock are in the current directory.

just

Whether justfile or .justfile are in the current directory or ancestor directories. If the lower cased file name matches justfile or .justfile, it is treat as a justfile. (e.g. justFile or .JustFile are also valid.)

Commands Supported

Command Description
fzf-make Launch fzf-make
fzf-make --repeat / fzf-make -r / fzf-make repeat Execute last executed target
fzf-make --history / fzf-make -h / fzf-make history Launch fzf-make with the history pane focused
fzf-make --help / fzf-make help Show help
fzf-make --version / fzf-make -v / fzf-make version Show version

Example Aliases

To simplify the usage of fzf-make, you can define aliases in your shell configuration. Below is an example configuration that works for most shells (bash, zsh, fish, etc.):

alias fm='fzf-make'
alias fr='fzf-make repeat'
alias fh='fzf-make history'

💻 Development

  1. Clone this repository
  2. Change the codes
  3. Run make run

To execute test, run make test(needs nextest).

nix

Or you can use nix to create a development shell with the project dependencies.

Within the repo root, execute the following command:

nix develop

👥 Contribution

  • Contributions are welcome!
  • If you have a Feature request, please create an issue first.
  • If you have added fzf-make to some package manager, please let me know. (or please send a PR to add how to install via the package manager in the README.md)
  • If you have any questions, feel free to create an issue and ask.

🗒 Related Article(s)

Commit count: 293

cargo fmt