command-line fuzzy finder(fzf)

Introduce Our Team

Team Member

• 박경연(팀장) contestpark
• 김홍빈 HongBeenKim
• 민세원 minSW
• 이영우 duddn311

Wiki

• Home
• History
• New Scheme
• Role

Web Site

• https://19-1-skku-oss.github.io/2019-1-OSS-L5/

Introduce Our Project

fzf is a general-purpose command-line fuzzy finder.

It's an interactive Unix filter for command-line that can be used with any list; files, command history, processes, hostnames, bookmarks, git commits, etc.

주어진 input 에 대해서 fuzzy finding 을 하게 해주는 Command line Fuzzy Finder 로, 쉽게 말해 터미널에서의 finder 명령어를 대신할 수 있다.

approximate string matching로 정해진 형식으로 typing하면 fzf 결과를 손쉽게 확인 할 수 있다.

현재 한국에서 가장 활발하게 활동 중인 오픈소스 소프트웨어이다.

예를들어 fzf를 실행시킨 후 exampleo를 검색하면 다음과 같이 exampleo가 들어간 모든 파일을 찾아준다.

Install and Usages

fzf project는 다음과 같은 구성요소로 이루어져 있다:

• fzf executable
• fzf-tmux script for launching fzf in a tmux pane
• Shell extensions
  • Key bindings (CTRL-T, CTRL-R, and ALT-C) (bash, zsh, fish)
  • Fuzzy auto-completion (bash, zsh)
• Vim/Neovim plugin

추가적인 파일을 다운받을 수 있으며, 필요 없는 경우 실행 가능한 fzf만 다운받을 수 있다.

Install using git

$ git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf
$ ~/.fzf/install

Usages

fzf는 interactive finder를 실행하고, 리스트를 STDIN에서 읽으며, 그리고 선택된 아이탬을 STDOUT에 출력한다.

$ find * -type f | fzf > selected

간단한 실행을 위해서는,

$ fzf

자세한 방법은 original repository참고

What we implemented

이 오픈소스의 다양한 기능 중에는 터미널 배경의 색을 바꿀 수 있는 Color Scheme이라는 기능이 있는데, 다음과 같은 코드를 terminal에 입력하면,

$ export FZF_DEFAULT_OPTS='
  --color fg:28,bg:231,hl:21,fg+:0,bg+:153,hl+:21
  --color info:124,prompt:124,spinner:124,pointer:66,marker:66
'

다음과 같이 fzf의 테마가 바뀐다.

우리 팀은 이 Color Scheme 부분에 추가적인 기능을 구현하기로 했는데,

• 원래 프로젝트에 소개된 Color Scheme의 종류가 너무 적음
• 사용자가 직접 색깔을 customize할 경우 RGB값을 일일히 찾아 코드를 만들기 불편

다음과 같은 문제점들을 해결하기 위해

• 새로운 정적 Color Scheme 예시들을 추가
• 색깔을 선택하면 자동적으로 코드를 만들어주는 프로그램(Color Picker) 구현

하기로 하였다.

그래서 우리는 다음과 같은 순서로 프로젝트를 진행하였다.

1. Translation of Color Scheme Wiki

Color Scheme을 수정하고, Color Picker를 만들기 위해 먼저 original repository의 Color Scheme에 대한 이해가 필요하였다. 그렇기 때문에 Color Scheme Wiki를 번역하여, 정적 페이지에 포스팅 했다.

2. New Static Color Scheme

기존에 있는 Color Scheme에 정적 Scheme 몇가지를 더 추가하였다.

이 Scheme들은 개발자들이 익숙한 다양한 Visual Studio Code의 테마를 기반으로 만들었다.

예를들어 VS Code의 테마중 하나인 Dark테마와 비교를 해보면

Visual Studio Code Dark

fzf Scheme Dark

로 테마가 거의 비슷하게 적용되었음을 알 수 있다.

더 다양한 테마는 Wiki의 New Scheme참고.

3. Implement Color Picker

Implementation

Color Picker를 구현하는데 go-atilectron-bundler를 사용하였다.

html, css, js를 통해 view를 만들고, 이 프로그램을 통해 기존의 fzf와 통신할 수 있게 만들어 주었다. (issue #10 참고)

먼저, Color Picker를 html, css, js를 통해 구현하였다.

다음으로, go-astilectron-bundler를 사용해 Color Picker GUI를 구현한 결과이다

환경변수를 등록한 경우 $ fzf --color g 를 통해 사용할 수 있다.

Reset을 누르는 경우 전에 fzf에 적용되어있던 scheme으로 되돌아가고, Apply to fzf를 누른 뒤 창을 닫으면 fzf에 내가 설정한 Scheme이 적용된걸 볼 수 있다.

Install and Usage

Install

• Download

$ git clone https://github.com/19-1-skku-oss/2019-1-OSS-L5.git

• Build(using astilectron)

$ cd fzf
$ astilectron-bundler cc
$ astilectron-bundler -v
$ go build
$ fzf --color g

• Modify environment variable

$ export FZF_PATH="파일 다운받은 경로/fzf"
$ export PATH=$FZF_PATH:$PATH

Usage

• Color Picker 실행

$ fzf --color g

• fzf 실행

$ fzf

4. Pull Request

현재 원본 repository에 pull request를 보내 놓은 상태다.

Pull Request

GUI color picker for fzf #1601

Issue

Color Picker to make custom Color Scheme for fzf #1602

---

This document is edited by 박경연