[DevTools] 개발자 친화적인 터미널 LS — PLS

pls는 개발자 친화적인 기능을 가진 이쁘고 강력한 터미널 ls 툴이다. pls에서 p는 아래 의미를 포함한다.

• Pretty (the output from pls surely looks better)
• Powerful (pls has lots of features and endless customisation)
• Programmer (pls is geared towards developers)
• Professional (pls can be extensively tweaked by the pros)
• Python (pls is written in Python!)

 

쉬운 사용법, 폴더/파일 아이콘 표시, 프로그래밍 언어별 파일명 색상 구분(*.js 파일 노락색으로 표시 등), 중요 파일은 굵게 혹은 밑줄로 표시, 중요하지 않은 파일은 흐리게 표시, Git status 표시 등 다양한 기능을 제공한다.

 

무엇보다 파일/폴더 목록을 더 직관적이고 이쁘게 표시하는 점이 마음에 든다. 추후엔 하위 폴더를 트리 목록으로 볼 수 있는 기능도 지원한다고 한다(다른 ls 도구인 lsd에선 이미 지원하고 있다)

 

이미지 출처 - 공식 홈페이지

 

설치

---

pls는 pip 혹은 pipx로 설치할 수 있다. pip로 설치하면 글로벌 네임스페이스에 여러 패키지가 설치되기 때문에 공식 문서에선 pipx로 설치하는걸 권장하고 있다.

brew install pipx # pipx 설치

pipx install pls # pls 설치
pipx upgrade pls # pls 업데이트
pipx uninstall pls # pls 삭제

 

pls에서 아이콘을 표시하기 위해 Nerd Font를 설치해야 된다(참고로 lsd도 Nerd Font를 사용한다). brew를 사용한다면 brew의 확장 버전인 cask를 이용해 원하는 폰트를 설치할 수 있다.

# (필수) cask-fonts 설치
brew tap homebrew/cask-fonts

# (선택1) Hack Nerd 폰트 (추천)
brew install --cask font-hack-nerd-font 

# (선택2) JetBrains Mono 폰트 (추천)
brew install --cask font-jetbrains-mono-nerd-font 

# (선택3) 다른 Nerd Font 설치시 케밥 케이스로 폰트 이름 입력
brew install --cask font-케밥-케이스-폰트-이름-font

 

사용 방법

---

pls에서 제공하는 명령어 플래그 목록은 pls -h를 입력하면 볼 수 있다. Importance, Sorting, Collapse 등 다양한 옵션을 지원한다. Nerd 아이콘 대신 이모지를 표시하거나 아예 안보이도록 할 수도 있다. 각 플래그에 대한 자세한 설명은 공식 문서에서도 확인할 수 있는데, GitHub Readme가 아닌 별도 페이지에서 제공한다. 가독성이 정말 좋다 👀

 

명령어 플래그(Flag) 목록

 

Importance

중요도 기준(임계값) 설정 / 기본값 0

pls -a 1 # 중요도 기준 1로 설정

 

pls는 설정한 중요도를 기준으로 파일 표시 방법을 총 5단계로 분류한다. 숨김 파일을 표시하고 싶다면 중요도 기준을 1로 설정한다. (중요도 -2 파일은 숨김 → 흐리게, 중요도 -1 파일은 흐리게 → 일반 파일, …)

 

Level (임계값)	Significance (중요도)	Appearance (표시 방식)
-2	Least important (가장 덜 중요)	Hidden by default (숨김)
-1	Lower importance (덜 중요)	Dimmed (흐리게 표시)
0	Neutral importance (일반)	Normal
+1	Higher importance (중요)	Bold
+2	Most important (가장 중요)	Underline

💡 중요도 판별 기준

• 파일 이름에 . 온점이 들어갔는지 여부
• 연결된 파일 스펙(Spec)이 있는지 여부

 

Collapse

특정 파일에 의해 자동 생성된 하위 파일(collapsed file)을 어떻게 표시할지 지정 / 기본값 0

pls -c 0 # collapse 기능 해제(기본값)
pls -c 1 # collapsed file을 부모 파일 아래쪽에 중첩 구조로 표시
pls -c 2 # collapsed file 숨기기

 

자동 생성된 하위 파일이 중첩 구조로 표시된 모습 — pls -c 1

 

Details

어떤 세부 항목을 표시할지 지정 / 기본값 none

 

💡 Git Status 항목은 Git Repo 폴더 안에서만 표시된다. 또한 시스템에 Git이 설치되어 있어야 한다.

pls -d none # 세부 항목 표시 안함 (기본값)
pls -d std # 표준 세부 항목 표시 (타입/권한/유저/그룹)
pls -d std -d mtime # 표준 세부 항목 및 수정 시간 표시
pls -d size -u decimal # 파일/폴더 사이즈를 10진수 단위로 표시
pls -d all # 모든 세부 항목 표시

Standard	Key	Meaning	Note
	inode	inode	윈도우 미지원
	links	해당 파일을 가리키는 Link 개수	윈도우 미지원
✅	type	타입 문자열 (l, d, -, p, s, c, b)
✅	perms	Permissions
✅	user	Owner user	윈도우 미지원
✅	group	Owner group	윈도우 미지원
	size	Size
	btime	Created at	macOS 전용
	ctime	Created/Changed at
	mtime	Modified at
	atime	Accessed at
	git	Git status	Git 레포지토리 안에서만 표시

 

yml 파일 설정

---

기본적으로 적용하고 싶은 pls 옵션은 .pls.yml 파일에 미리 지정할 수 있다. .pls.yml 파일을 사용자 홈 디렉토리(~)에 만들면 현재 컴퓨터에 로그인한 유저 레벨 단위에 적용되고, 특정 프로젝트 폴더에 만들면 프로젝트 단위로 적용된다.

 

❶ 아이콘 변경은 Nerd Font Cheat Sheet에서 원하는 아이콘의 Hex 값을 복사한 후 앞에 \u를 붙여준다. (e.g. f092 → \uf092)

• 터미널에 아이콘이 잘 표시되는지 확인하려면 echo "\uf092" 형태로 입력해본다.
• Material Design Icon(MDI) 코드 포인트가 업데이트 돼서 nf-md-* nf-mdi-* 클래스 이름을 가진 아이콘은 깨져서 나온다. 기본값 아이콘중 nf-mdi-git 같은 아이콘은 다른걸로 교체해야 한다.

 

❷ pls 자체적으로 Schema validation을 제공하고 있다. 이를 이용하면 .pls.yml 파일 수정 시 실수를 방지할 수 있다. VSCode를 사용한다면 YAML 부가기능을 설치하고 VSCode 설정 파일에 아래 내용을 추가한다.

{
  // VSCode - settings.json
  "yaml.schemas": {
    "https://raw.githubusercontent.com/dhruvkb/pls/main/src/pls/data/schema/pls_config.yml": [
      ".pls.yml"
    ]
  }
}

 

설정 완료 후 nerd_icons를 nerd_iconss로 잘못 입력하면 yaml-schema 오류 메시지가 뜬다

❸ xml, iml, log 확장자처럼 기본적으로 지정된 아이콘이 없는 파일은 직접 추가해야 한다.

💡 어떤 아이콘으로 지정할지 고민된다면 lsd 아이콘 매핑 코드를 참고하면 좋다.

 

❹ 심볼릭 링크(symlink), 폴더(dir), 일반 파일(file) 등은 constants 프로퍼티에서 설정할 수 있다.

symlink 아이콘/컬러 및 file 아이콘 설정 前

symlink 아이콘/컬러 및 file 아이콘 설정 后

 

Alias 설정

---

# ls를 pls 플러그인으로 바인딩 및 숨김 파일 표시 안함
alias ls="pls -a 0" 

# l을 pls 플러그인으로 바인딩 및 명시한 세부 항목 표시(std/git/size/mtime/links)
alias l="pls -d std -d git -d size -d mtime -d links" 

# la를 pls 플러그인으로 바인딩 및 모든 세부 항목 표시
alias la="pls -d all"