Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rlivings39/vscode-fzf-quick-open

vscode extension providing quick file/folder open and searching using fzf
https://github.com/rlivings39/vscode-fzf-quick-open

fd fzf ripgrep vscode vscode-extension

Last synced: 3 months ago
JSON representation

vscode extension providing quick file/folder open and searching using fzf

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.com/rlivings39/vscode-fzf-quick-open.svg?branch=master)](https://travis-ci.com/rlivings39/vscode-fzf-quick-open)

[![Marketplace](https://img.shields.io/visual-studio-marketplace/v/rlivings39.fzf-quick-open.svg)](https://marketplace.visualstudio.com/items?itemName=rlivings39.fzf-quick-open)

[![Installs](https://img.shields.io/visual-studio-marketplace/i/rlivings39.fzf-quick-open.svg)](https://marketplace.visualstudio.com/items?itemName=rlivings39.fzf-quick-open)

[![Rating](https://img.shields.io/visual-studio-marketplace/r/rlivings39.fzf-quick-open.svg)](https://marketplace.visualstudio.com/items?itemName=rlivings39.fzf-quick-open&ssr=false#review-details)



# fzf-based fuzzy searching in VScode to open files/folders and filter ripgrep results

Any time that vscode requires interaction with the OS file dialog, the workflow can become much less efficient. This comes up when opening files outside of your workspace folders or adding a workspace folder. This extension solves that by providing these actions using [fzf](https://github.com/junegunn/fzf).



Provides an interface to search using `ripgrep` and browse the results using `fzf`. This is inspired by Vim's `rg` and `fzf` integration. The search pattern defaults to the word under your cursor or your current selection and is easily overridden.



Works on *nix, Mac, and Windows. Tested with CMD, PowerShell, and Git Bash on Windows.



# Usage

Provides the commands:



* `fzf: Search using rg and fzf` to search using `fzf` and `ripgrep`

* `fzf: Open file using fzf` opens a terminal in which you can choose a file

* `fzf: Add workspace folder using fzf` to add a workspace folder



On terminal launch, the `pwd` is chosen based on the active editor file. Also adds



* `fzf: Search in PWD using rg and fzf`

* `fzf: Open file in PWD using fzf`

* `fzf: Add workspace folder from PWD using fzf`



which are the same as above but switches to parent directory of active file on every invocation.



On terminal launch, the `Project Root (.git)` is opened based on the results of `git rev-parse --show-toplevel` on the active editor file. Also adds



* `fzf: Search in Project Root (.git) using rg and fzf`

* `fzf: Open file in Project Root (.git) using fzf`



which are the same as the above but switches to project root directory of the active file on every invocation.



Bind the commands to keyboard shortcuts to launch faster.



## Configuration



Change the setting `fzf-quick-open.initialWorkingDirectory` to override the initial working directory used for the fzf terminal. Change `fzf-quick-open.findDirectoriesCmd` to change the command used to find directories. Something like `fd --type d` is very fast if you use [fd](https://github.com/sharkdp/fd).



By default `fzf` is used as the fuzzy matcher command. To change this to add flags or use another tool like skim (`sk`) modify the setting `fzf-quick-open.fuzzyCmd` to be the command that should be run. It will be plugged in to a context like: `rg searchTerm | fzf --ansi --print0 ...` and needs to support `--ansi --print0` flags.



To change the `rg` case matching options use the setting `fzf-quick-open.ripgrepSearchStyle` to choose between:



* Case sensitive

* Ignore case

* Smart case



To pass other flags to `rg` add them to `fzf-quick-open.ripgrepOptions`.



# Setup



1. [Install fzf](https://github.com/junegunn/fzf)

1. [Install ripgrep](https://github.com/BurntSushi/ripgrep)

1. For best performance you should set up `fzf` to use the amazingly fast [fd](https://github.com/sharkdp/fd)



    **`~/.config/fish/config.fish`**



    ```fish

    set --universal FZF_DEFAULT_COMMAND 'fd'

    ```



    **`~/.bashrc`**



    ```bash

    echo "export FZF_DEFAULT_COMMAND='fd'" >> ~/.bashrc

    ```



1. Configure the setting `fzf-quick-open.findDirectoriesCmd` to use `fd`: `fd --type d`



# Examples

**Search with ripgrep**

![Search with rg and fzf](resources/fzfVscodeRg.gif)



**Open file**

![Open file with fzf](resources/fzfVscodeOpenFile.gif)



**Open workspace folder**

![Add workspace folder with fzf](resources/fzfVscodeOpenFolder.gif)