프로젝트 디렉토리 구조를 출력하는 npm 패키지(tree-cli)

프로젝트 관련 문서를 작성할 때면 디렉토리 구조를 명시할 때가 있다.

좋은 툴을 찾던 와중 npm에서 tree-cli라는 편리한 패키지를 찾아 공유한다.

 

 

 

설치

아래 참고 자료 링크를 클릭하거나 npm에서 tree-cli 를 검색하고 설치한다.

 

기본 커맨드

---

tree

현재 위치를 기준으로 하위 디렉토리를 출력함

출력되는 기본 깊이는 1이다.

윈도우에서는 cmd로 treee 라고 명령어를 쓰면 된다.

 

출력 깊이 설정

tree -l <n>

n만큼의 깊이를 설정해서 트리를 출력한다.

최하위 노드까지 출력하는 특별한 커맨드는 찾지 못했다. 그래서 n 값을 넉넉하게 잡아서 사용한다.

 

특정 폴더 무시

tree -l 2 --ignore "node_modules"    

위 경우는 node_modules파일을 출력대상에서 제외한다.

주의점은 출력대상에서 제외할 뿐, 검색 대상에는 포함된다는 점이다. 

따라서 깊이가 깊어질수록 속도가 약간 느려진다는 단점이 있다.

 

루트 폴더 설정

tree --base <relative path>

tree --base src -l 99  

위 경우는 검색하는 루트 경로를 ./src로 지정했다.
이러면 검색 대상에서 나머지를 제외할 수 있기 때문에 속도가 빨라진다.

다만, pakage.json 같은 프로젝트 루트까지 보여주지 못한다는 한계가 있다.

 

숨은 파일 보여주기
tree -a

이 패키지는 프로젝트 종속성말고도 우분투같은 os에서 내부 디렉토리를 볼때 유용하다. 이 때 숨은 파일을 찾으려면 위 커맨드가 유용하다.

 

그 외에도 트리를 파일로 출력하는 등의 좋은 커맨드가 많으니 필요하면 아래를 참고바란다.

트리 특수 문자를 키보드로 직접 입력하는 방법( window )
ㅂ+ 한자키

참고 자료

---

https://www.npmjs.com/package/tree-cli

tree-cli

 

 

https://fromnowwon.tistory.com/entry/npm-tree

npm tree 명령어로 프로젝트 폴더 구조 출력