kyu08/fzf-make

A command line tool that executes make target using fuzzy finder with preview window.

fzf-make is a command line tool that executes make target using fuzzy finder with preview window.

[English] [Deutsch] [Français]

🛠️ Features

• Select and execute a make target using fuzzy-finder
• Execute last executed target(By running fzf-make --repeat.)
• Command history
• Support include directive
• (Scheduled to be developed) Support config file

👓 Prerequisites

• bat (In the future, we intend to make it work with cat as well, but currently it only works with bat.)

📦 Installation

macOS

Homebrew

You don't need to install bat because fzf-make will install it automatically via Homebrew.

# install
brew install kyu08/tap/fzf-make

# update 
brew 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

💡 Usage

Run target using fuzzy finder

1. Execute fzf-make in the directory include makefile(file name should be one of GNUmakefile, makefile, Makefile)
2. Select make command you want to execute. If you type some characters, the list will be filtered.

Run target from history

1. Execute fzf-make in the directory include makefile(file name should be one of GNUmakefile, makefile, Makefile)
2. Press Tab to move to the history pane.
3. Select make command you want to execute.

Commands Supported

Command	Description
fzf-make	Launch fzf-make
fzf-make --repeat / fzf-make -r / fzf-make repeat	Execute last executed target
fzf-make --help / fzf-make -h / fzf-make help	Show help
fzf-make --version / fzf-make -v / fzf-make version	Show version

💻 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)

• (Japanese)Makefileに定義されたtargetをfzfで選択して実行するCLIツールをRustでつくった

fzf-make's Issues

Run `cargo publish` on CI

https://r7kamura.com/articles/2021-11-14-crate-auto-release

Check whether `CREDITS` needs update on CI

Check whether CREDITS file includes all of dependencies in cargo.toml on CI.

• Try this https://github.com/embarkstudios/cargo-about?tab=readme-ov-file.

Make target to be executed display prettier

actual

This crate can be helpful.
https://github.com/colored-rs/colored

Add crates.io badge to README

TODO

• Add badge to readme
  • en
  • german

Format might be following:

  ![crates.io](https://img.shields.io/crates/v/fzf-make?style=flatflat-square)

that shows like this.

use cat when bat is unavailable

Introduce integration tests

This can be helpful...?
https://github.com/a-kenji/tui-term/tree/release/test/typescript

[bat error]: invalid digit found in string

Hey,

I just tried out fzf-make on Shuttle's Makefile and got this error.

Also, I'm getting a different error for the last entry:

Thanks for this tool!

Update `README.md`

• Fix cargo install

Automate updating brew tap repository

https://github.com/mislav/bump-homebrew-formula-action

[BUG] invalid extract method

expected: ^(.*):$ \1
now: (.*): \1 (this pattern matches string including : like url)

Task names with inline comment are not detected

How to reproduce

foo: # This is a comment
	echo "foo"

bar:
	echo "bar"

Actual

• fzf-make only shows bar.

Expected

• fzf-make will show foo and bar.

[Tell me your opinion!] Support config file

I think it's good idea to support config that enables to configure behavior which has file format such as yaml.
Possible settings would include the following:

• Direction of preview window(vertical / horizontal)
• Preview command(bat / cat)
• Show executed command or not
• Behavior when return key is pressed(Run the target / Just show make ${selected_target} to prompt?(I'm not sure if possible)y)
• Forcus the target executed at the last time
• etc...

Please let me know options you want! 😀
Also I welcome your feature requests!

Support passing arg(s) to target

Consider change preview window to vertical window

why

can't see long make target

solutions

• to add window vertical option
• change the way of viewing of bat somehow
• always show window vertical

Catch panic at `main.rs`

https://zenn.dev/yoshiyoshifujii/articles/f4e9af4a404e95

Forcus the target executed at the last time(can be enabled via config file )

Treat clippy's warning as errors

    # Change this line in .github/workflows/lint.yml
    cargo clippy
    # as below
    cargo clippy -- -D warnings

release v0.5.0

https://qiita.com/kcwebapply/items/4777dfc9151ebb3e8a19

1. make build-releaseを実行してバイナリを生成
2. バイナリを含めてタグ打ちリリース
3. brew create https://github.com/kyu08/fzf-make/archive/refs/tags/v0.5.0.tar.gzを実行してsha256を取得
4. kyu08/homebrew-tap fzf-make.rbのsha256を書き換えてpush
5. ローカルでbrew update, brew upgrade fzf-makeを実行してダウンロードでエラーが出ないことを確認

Disable showing line number of preview window

Show version and help

• show version
• show help

print selected target name to stdout

Use mold to accelerate build

• brew install mold
  https://keens.github.io/blog/2021/12/20/moldwotsukautorustnobirudogahayakunaru/

Check bat is installed or not

It may be better giving option through config file like.
And use cat by default.

preview_command: bat # or cat

• Delete bat dependency from Homebrew Formula.

Simplify release

# AsIs
1. Run make bump-fzf-make-version locally to update version of cargo.toml
1. Create PR and merge into main
1. Create release on GitHub (GitHub Actions runs cargo publish and update brew formula automatically)

# ToBe
- Execute release on GitHub Actions to do all of the above
- Execute make release locally to do all of the above(kick GitHub Actions)

AsIs

• When make bump-fzf-make-version executed, commit, push, and fill PR are executed

ToBe

• When make bump-fzf-make-version executed, commit, push, and create and merge PR to main, then make draft release

support include directive

support this syntax

include foo.mk

.PHONY: test
test:
    cargo test

Setup CI/CD

CI

• cargo test
• cargo check
• cargo fmt

CD

• something make release easier

hide fzf window when fzf-make terminated

Update description in orhun/PKGBUILDs

https://github.com/orhun/PKGBUILDs/blob/master/fzf-make/PKGBUILD

Make it possible to install via `cargo install`

• add how to install via cargo install --git ${repo}
• add to crate.io if needed. (and modify README.md)

Add workflow like dependabot

• Check monthly if possible
• Assign @kyu08 as reviewer
• Check github-actions and cargo crates

update README

• save gif within this repo
• update demo gif
• write features(support include directive ...)

Update README.md

• Add fzf-make help and fzf-make version in Usage section.
  • like #73 (comment)
• Update gif

reconsider module structure

Maybe skim related codes could be combined into one module.

Routing - Handler - Usecase のような層に分ける

install via homebrew

• update tap repo
• update readme

Run `cargo fmt`, `cargo clippy` on CI

Maintainer TODO

• Be ready to review pull/merge requests, accepting those that are valid by merging them, leaving an overall approving review, or by adding the “hacktoberfest-accepted” label.
• Reject any spammy requests you receive by labeling them as “spam,” and any other invalid contributions by closing them or labeling them as “invalid.”

https://hacktoberfest.com/participation/#maintainers

Make sure it works on linux

It's fine to test using linux container image on Docker...? (I don't have linux machine)

TODO: Update my homebrew repo if needed. (for installation on linux)

Ensure that generate release build and update `version` in `cargo.toml` are executed at the same time

update Makefile like below.

.PHONY: build-release
build-release:
        # TODO: update cargo.toml
	@cargo build --verbose --release

update README

• Makeの仕様完全対応はちょっと大変そうなのでREADMEに対応しているターゲットの形式を書いておく。
• READMEにMakefile以外には対応していないことを書いておく(xxx.mkとかは未対応)

add readme

release 0.2.0

Reconsider error handling

Use anyhow

output nothing when target that expect standard input executed

出力が無だったら標準入力を要求するターゲットとみなしてもいいかもしれない？

Show file name on the top of preview window

Command history

UI

Requirements

• Display histories
  • Read and parse history
  • Add UI in History pane
  • Test
    • Pass a history file path and check whether parse result is valid
• Update history
  • Update history when a target to be executed
    • Append a target to head of histories
    • Remove duplicates
  • Test
    • At first update history, and then check content of history struct
    • Check some conversions of struct to file is valid
• Add fzf-make --repeat to execute the target last executed

Data structure of history file

• ~/.config/fzf-make/history.toml
• In the future, config file can be added. So this file is used only for history.

[[histories]]
path = "Users/john/projects/projectA"
executed-targets = ["test", "lint"]

[[histories]]
path = "Users/john/projects/projectB"
executed-targets = ["test", "lint"]

[[histories]]
path = "Users/john/projects/projectC"
executed-targets = ["test", "lint"]

Support `fzf-make target-list`

Just show a list of targets.

What `v0.8.0` includes

https://github.com/kyu08/fzf-make/issues?q=is%3Aopen+is%3Aissue+milestone%3Av0.8.0

Ignore statement like `some_var := 1`

Actual

If fzf-make was executed when following makefile exists, some_var and run is detected as target.

some_var := 1

.PHONY: run
run:
    go run main.go

Expected

some_var is not detected as target.

[BUG] fzf-make only shows upper few lines

preview window does not be scrolled

Add README translations

• Add translation which has file name like doc/README-ja.md.
• Add the link in README.md in the same format as sharkdp/bat.

Fix lint errors